Package org.opencms.ade.containerpage.shared

Class CmsFormatterConfigCollection

java.lang.Object

org.opencms.ade.containerpage.shared.CmsFormatterConfigCollection

All Implemented Interfaces:

com.google.gwt.user.client.rpc.IsSerializable, Iterable<CmsFormatterConfig>

public class CmsFormatterConfigCollection
extends Object
implements Iterable<CmsFormatterConfig>, com.google.gwt.user.client.rpc.IsSerializable

Bean which holds a list of formatter configurations (client-side) which can be retrieved by key or id.

Constructor Summary

Constructors

Constructor	Description
CmsFormatterConfigCollection()

Method Summary

Modifier and Type	Method	Description
void	add(CmsFormatterConfig config)	Adds another formatter configuration.
CmsFormatterConfig	get(String keyOrId)	Gets the formatter configuration for the given key or id.
CmsFormatterConfig	getFirstFormatter()	Gets the first formatter configuration bean.
Iterator<CmsFormatterConfig>	iterator()	Gets an iterator over the formatter beans.
int	size()	Returns the number of formatters.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CmsFormatterConfigCollection

public CmsFormatterConfigCollection()

Method Details

add

public void add(CmsFormatterConfig config)

Adds another formatter configuration.

Parameters:

config - the formatter configuration bean

get

public CmsFormatterConfig get(String keyOrId)

Gets the formatter configuration for the given key or id.

Parameters:

keyOrId - the formatter key or id

Returns:

the first formatter configuration with that key or id, or null if none were found

getFirstFormatter

public CmsFormatterConfig getFirstFormatter()

Gets the first formatter configuration bean.

Returns:

the first formatter configuration bean

iterator

public Iterator<CmsFormatterConfig> iterator()

Gets an iterator over the formatter beans.

Specified by:

iterator in interface Iterable<CmsFormatterConfig>

See Also:

• Iterable.iterator()

size

public int size()

Returns the number of formatters.

Returns:

the number of formatters

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()