com.exalead.papi.helper

Class MetaContainer

java.lang.Object

com.exalead.papi.helper.MetaContainer

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Meta>

public class MetaContainer
extends java.lang.Object
implements java.lang.Iterable<Meta>, java.io.Serializable

Container for meta data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<Meta>	metaList Underlying list of meta data.

Constructor Summary

Constructors

Constructor and Description
MetaContainer() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMeta(Meta meta) Adds a new meta to the current meta data container.
void	addMeta(java.lang.String name, java.lang.String value) Adds a new meta to the current meta data container.
void	addMetas(Meta[] metas) Adds a set of meta to the current meta data container.
void	addMetas(MetaContainer metaContainer) Merges a meta data container within the current meta data container.
void	deleteMeta(java.lang.String name) Delete all the Meta that match the given meta data name.
boolean	equals(java.lang.Object obj) Helper function to compare a meta data container with another object.
java.util.List<Meta>	getList() Gets a list of the current container meta data.
Meta	getMeta(java.lang.String name) Gets the first Meta object that matches the given meta data name.
java.util.Collection<Meta>	getMetaValues(java.lang.String name) Gets a collection of all the Meta objects that matches the given meta data name.
int	hashCode()
java.util.Iterator<Meta>	iterator() Gets an iterator over the current container meta data.
int	size()
java.lang.String	toString() Simple meta data container serializer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

metaList

protected java.util.ArrayList<Meta> metaList

Underlying list of meta data.

Constructor Detail

MetaContainer

public MetaContainer()

Constructor.

Method Detail

addMeta

public void addMeta(java.lang.String name,
                    java.lang.String value)

Adds a new meta to the current meta data container.

Parameters:

name - the meta name.

value - the meta value.

addMeta

public void addMeta(Meta meta)

Adds a new meta to the current meta data container.

Parameters:

meta - the meta

addMetas

public void addMetas(Meta[] metas)

Adds a set of meta to the current meta data container.

Parameters:

metas - the set of metas to add

addMetas

public void addMetas(MetaContainer metaContainer)

Merges a meta data container within the current meta data container.

Parameters:

metaContainer - the meta data container to be used.

iterator

public java.util.Iterator<Meta> iterator()

Gets an iterator over the current container meta data.

Specified by:

iterator in interface java.lang.Iterable<Meta>

Returns:

a new iterator on the current container meta data

getList

public java.util.List<Meta> getList()

Gets a list of the current container meta data.

Returns:

a mutable list of the current container meta data

getMeta

public Meta getMeta(java.lang.String name)

Gets the first Meta object that matches the given meta data name.

Parameters:

name - the meta data name to lookup for.

Returns:

the first mutable Meta object matching the meta data name (or null if no meta is found.

getMetaValues

public java.util.Collection<Meta> getMetaValues(java.lang.String name)

Gets a collection of all the Meta objects that matches the given meta data name.

Parameters:

name - the meta data name for which to perform a lookup.

Returns:

a unmodifiable list of Meta objects matching the meta data name.

deleteMeta

public void deleteMeta(java.lang.String name)

Delete all the Meta that match the given meta data name.

Parameters:

name - the meta data name to delete.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Helper function to compare a meta data container with another object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object with which the current meta data container should be compared.

Returns:

true if the compared object is also a meta data container with the same content.

toString

public java.lang.String toString()

Simple meta data container serializer.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the meta data container.

size

public int size()

Returns:

The number of Metas in this container