Package com.helger.html.meta

Class MetaElementList

java.lang.Object

com.helger.html.meta.MetaElementList

All Implemented Interfaces:

com.helger.commons.collection.impl.ICommonsIterable<IMetaElement>, com.helger.commons.lang.ICloneable<MetaElementList>, IMetaElementList, Iterable<IMetaElement>

@ThreadSafe
public class MetaElementList
extends Object
implements com.helger.commons.lang.ICloneable<MetaElementList>, IMetaElementList

This class manages a list of meta elements.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
MetaElementList()
MetaElementList(MetaElementList aOther)
MetaElementList(Iterable<? extends IMetaElement> aMetaElementList)

Method Summary

Modifier and Type	Method	Description
MetaElementList	addMetaElement(IMetaElement aMetaElement)
MetaElementList	addMetaElements(MetaElementList aMetaElementList)
MetaElementList	addMetaElements(Iterable<? extends IMetaElement> aMetaElementList)
boolean	containsMetaElementWithName(String sName)	Check if a meta element with the given name exists.
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	getAllMetaElementNames()
com.helger.commons.collection.impl.ICommonsList<IMetaElement>	getAllMetaElements()
void	getAllMetaElements(Collection<? super IMetaElement> aTarget)	Add all contained meta elements to the passed container.
MetaElementList	getClone()
int	getMetaElementCount()
IMetaElement	getMetaElementOfName(String sName)	Find the meta element with the given name.
int	hashCode()
boolean	hasMetaElements()
Iterator<IMetaElement>	iterator()
com.helger.commons.state.EChange	removeAllMetaElements()
com.helger.commons.state.EChange	removeMetaElement(String sMetaElementName)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.impl.ICommonsIterable

containsAny, containsNone, containsOnly, findAll, findAllInstanceOf, findAllMapped, findAllMapped, findAllMapped, findFirst, findFirst, findFirstIndex, findFirstMapped, findFirstMapped, findLastIndex, forEachBreakable, forEachByIndex, forEachThrowing, getCount, getCount

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MetaElementList

public MetaElementList()

MetaElementList

public MetaElementList(@Nonnull
                       MetaElementList aOther)

MetaElementList

public MetaElementList(@Nonnull
                       Iterable<? extends IMetaElement> aMetaElementList)

Method Detail

addMetaElement

@Nonnull
public MetaElementList addMetaElement(@Nonnull
                                      IMetaElement aMetaElement)

addMetaElements

@Nonnull
public MetaElementList addMetaElements(@Nonnull
                                       Iterable<? extends IMetaElement> aMetaElementList)

addMetaElements

@Nonnull
public MetaElementList addMetaElements(@Nonnull
                                       MetaElementList aMetaElementList)

removeMetaElement

@Nonnull
public com.helger.commons.state.EChange removeMetaElement(@Nullable
                                                          String sMetaElementName)

removeAllMetaElements

@Nonnull
public com.helger.commons.state.EChange removeAllMetaElements()

getAllMetaElementNames

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsOrderedSet<String> getAllMetaElementNames()

Specified by:

getAllMetaElementNames in interface IMetaElementList

Returns:

A set with used meta element names. Never null.

getAllMetaElements

public void getAllMetaElements(@Nonnull
                               Collection<? super IMetaElement> aTarget)

Description copied from interface: IMetaElementList

Add all contained meta elements to the passed container.

Specified by:

getAllMetaElements in interface IMetaElementList

Parameters:

aTarget - The target container to be filled. May not be null.

getAllMetaElements

@Nonnull
@ReturnsMutableCopy
public com.helger.commons.collection.impl.ICommonsList<IMetaElement> getAllMetaElements()

Specified by:

getAllMetaElements in interface IMetaElementList

Returns:

A list with all contained meta elements. Never null.

getMetaElementOfName

@Nullable
public IMetaElement getMetaElementOfName(@Nullable
                                         String sName)

Description copied from interface: IMetaElementList

Find the meta element with the given name.

Specified by:

getMetaElementOfName in interface IMetaElementList

Parameters:

sName - The name to search. May be null or empty.

Returns:

null if no such meta element exists.

containsMetaElementWithName

public boolean containsMetaElementWithName(@Nullable
                                           String sName)

Description copied from interface: IMetaElementList

Check if a meta element with the given name exists.

Specified by:

containsMetaElementWithName in interface IMetaElementList

Parameters:

sName - The name to check. May be null or empty.

Returns:

true if a meta element with the passed name exists.

getMetaElementCount

@Nonnegative
public int getMetaElementCount()

Specified by:

getMetaElementCount in interface IMetaElementList

Returns:

The number of contained meta elements. Always ≥ 0.

hasMetaElements

public boolean hasMetaElements()

Specified by:

hasMetaElements in interface IMetaElementList

Returns:

true if at least one meta element is contained, false otherwise.

iterator

@Nonnull
public Iterator<IMetaElement> iterator()

Specified by:

iterator in interface Iterable<IMetaElement>

getClone

@Nonnull
@ReturnsMutableCopy
public MetaElementList getClone()

Specified by:

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

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