Package com.helger.html.meta

Class MetaElement

java.lang.Object

com.helger.html.meta.MetaElement

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<MetaElement>, com.helger.commons.name.IHasName, IMetaElement, IMetaElementDeclaration, IMutableMetaElement, Serializable

@NotThreadSafe
public class MetaElement
extends Object
implements IMutableMetaElement, com.helger.commons.lang.ICloneable<MetaElement>

Represents a single HTML meta element.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetaElement(EMetaElementType eType, String sName, String sScheme, Locale aContentLocale, String sContent)
	MetaElement(IMetaElement aOther)

Method Summary

Modifier and Type	Method	Description
com.helger.xml.microdom.IMicroNode	convertToNode(IHCConversionSettingsToNode aConversionSettings)	Convert this meta element to an IMicroNode
static MetaElement	createMeta(String sName, String sValue)
static MetaElement	createMetaCharset(Charset aCharset)
static MetaElement	createMetaHttpEquiv(String sName, String sValue)
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsOrderedSet<Locale>	getAllLocales()
com.helger.commons.collection.impl.ICommonsList<IMetaElementValue>	getAsMetaElementValueList()	Get the contents of this meta tag as a self contained list of meta tag values.
MetaElement	getClone()
Iterable<Map.Entry<Locale,String>>	getContent()
String	getContentLanguageIndependent()
com.helger.commons.collection.impl.ICommonsOrderedMap<Locale,String>	getContentMap()
String	getName()
protected String	getNamespaceURI(IHCConversionSettingsToNode aConversionSettings)
static Locale	getRealContentLocale(Locale aContentLocale)
String	getScheme()	Get the optional meta element scheme.
EMetaElementType	getType()
int	hashCode()
boolean	isLanguageIndependent()	Check if the meta tag is language independent.
com.helger.commons.state.EChange	removeContent(Locale aContentLocale)	Remove the value of the given locale.
com.helger.commons.state.EChange	setContent(Locale aContentLocale, String sContent)	Set the value of the meta element in the given locale.
com.helger.commons.state.EChange	setName(String sName)	Set the name of the meta element.
com.helger.commons.state.EChange	setScheme(String sScheme)
com.helger.commons.state.EChange	setType(EMetaElementType eType)	Set the type of the meta element.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.html.meta.IMetaElementDeclaration

isHttpEquiv

Methods inherited from interface com.helger.html.meta.IMutableMetaElement

removeContent, setContent

Constructor Detail

MetaElement

public MetaElement(@Nonnull
                   IMetaElement aOther)

MetaElement

protected MetaElement(@Nonnull
                      EMetaElementType eType,
                      @Nonnull
                      String sName,
                      @Nullable
                      String sScheme,
                      @Nullable
                      Locale aContentLocale,
                      @Nullable
                      String sContent)

Method Detail

getType

@Nonnull
public EMetaElementType getType()

Specified by:

getType in interface IMetaElementDeclaration

Returns:

The meta element type. Never null.

setType

@Nonnull
public final com.helger.commons.state.EChange setType(@Nonnull
                                                      EMetaElementType eType)

Description copied from interface: IMutableMetaElement

Set the type of the meta element.

Specified by:

setType in interface IMutableMetaElement

Parameters:

eType - The type to use. May not be null.

Returns:

EChange

getName

@Nonnull
public String getName()

Specified by:

getName in interface com.helger.commons.name.IHasName

setName

@Nonnull
public final com.helger.commons.state.EChange setName(@Nonnull
                                                      String sName)

Description copied from interface: IMutableMetaElement

Set the name of the meta element. May usually neither be null nor empty, except for EMetaElementType.CHARSET where the name does not matter.

Specified by:

setName in interface IMutableMetaElement

Parameters:

sName - The name to use. May not be null.

Returns:

EChange.

getScheme

@Nullable
public String getScheme()

Description copied from interface: IMetaElementDeclaration

Get the optional meta element scheme.

Specified by:

getScheme in interface IMetaElementDeclaration

Returns:

the optional meta element scheme - can be null

setScheme

@Nonnull
public com.helger.commons.state.EChange setScheme(@Nullable
                                                  String sScheme)

isLanguageIndependent

public boolean isLanguageIndependent()

Description copied from interface: IMetaElement

Check if the meta tag is language independent.

Specified by:

isLanguageIndependent in interface IMetaElement

Returns:

true if the meta tag is language independent, false if it is not

getAllLocales

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedSet<Locale> getAllLocales()

Specified by:

getAllLocales in interface IMetaElement

Returns:

A set with all locales a value is present

getContentLanguageIndependent

@Nullable
public String getContentLanguageIndependent()

Specified by:

getContentLanguageIndependent in interface IMetaElement

Returns:

The content which was specified locale independent.

getContentMap

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedMap<Locale,String> getContentMap()

Specified by:

getContentMap in interface IMetaElement

Returns:

A non-null map from language to value.

getContent

@Nonnull
@ReturnsMutableCopy
public Iterable<Map.Entry<Locale,String>> getContent()

Specified by:

getContent in interface IMetaElement

Returns:

A non-null map from language to value.

getRealContentLocale

@Nonnull
public static Locale getRealContentLocale(@Nullable
                                          Locale aContentLocale)

setContent

@Nonnull
public com.helger.commons.state.EChange setContent(@Nullable
                                                   Locale aContentLocale,
                                                   @Nullable
                                                   String sContent)

Description copied from interface: IMutableMetaElement

Set the value of the meta element in the given locale.

Specified by:

setContent in interface IMutableMetaElement

Parameters:

aContentLocale - The locale to set. May be null.

sContent - The value to be set. If the content is null the value is removed.

Returns:

EChange

removeContent

@Nonnull
public com.helger.commons.state.EChange removeContent(@Nullable
                                                      Locale aContentLocale)

Description copied from interface: IMutableMetaElement

Remove the value of the given locale.

Specified by:

removeContent in interface IMutableMetaElement

Parameters:

aContentLocale - The locale to be removed. May not be null.

Returns:

EChange

getAsMetaElementValueList

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IMetaElementValue> getAsMetaElementValueList()

Description copied from interface: IMetaElement

Get the contents of this meta tag as a self contained list of meta tag values.

Specified by:

getAsMetaElementValueList in interface IMetaElement

Returns:

A non-null modifiable list of meta tags.

getNamespaceURI

@Nonnull
@Nonempty
@OverrideOnDemand
protected String getNamespaceURI(@Nonnull
                                 IHCConversionSettingsToNode aConversionSettings)

convertToNode

@Nullable
public com.helger.xml.microdom.IMicroNode convertToNode(@Nonnull
                                                        IHCConversionSettingsToNode aConversionSettings)

Description copied from interface: IMetaElement

Convert this meta element to an IMicroNode

Specified by:

convertToNode in interface IMetaElement

Parameters:

aConversionSettings - The conversion settings to be used. May not be null.

Returns:

null if this meta element contains no content.

getClone

@Nonnull
@ReturnsMutableCopy
public MetaElement getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<MetaElement>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

createMeta

@Nonnull
public static MetaElement createMeta(@Nonnull
                                     String sName,
                                     @Nonnull
                                     String sValue)

createMetaHttpEquiv

@Nonnull
public static MetaElement createMetaHttpEquiv(@Nonnull
                                              String sName,
                                              @Nonnull
                                              String sValue)

createMetaCharset

@Nonnull
public static MetaElement createMetaCharset(@Nonnull
                                            Charset aCharset)