com.github.jferard.fastods.odselement.config

Class ConfigItemMapNamed

java.lang.Object

com.github.jferard.fastods.odselement.config.ConfigItemMapNamed

All Implemented Interfaces:

ConfigBlock, ConfigItemCollection<ConfigItemMapEntry>, Tag, XMLConvertible

public class ConfigItemMapNamed
extends Object
implements ConfigItemCollection<ConfigItemMapEntry>

A map with elements mapped by names 3.10.4 config:config-item-map-named

Author:

Julien Férard

Constructor Summary

Constructors

Constructor and Description
ConfigItemMapNamed(String name)

Method Summary

Modifier and Type	Method and Description
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
void	clear() Clears this item.
boolean	contains(String name)
ConfigItemMapEntry	getByName(String name)
String	getName()
boolean	isEmpty()
Iterator<ConfigItemMapEntry>	iterator()
ConfigItemMapEntry	put(ConfigItemMapEntry value)
ConfigItemMapEntry	removeByName(String name)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigItemMapNamed

public ConfigItemMapNamed(String name)

Parameters:

name - the name of this item

Method Detail

getName

public String getName()

Specified by:

getName in interface ConfigBlock

Returns:

the name of this config block (19.29 config:name)

size

public int size()

Specified by:

size in interface ConfigItemCollection<ConfigItemMapEntry>

Returns:

the number of ConfigBlocks in this entry

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConfigItemCollection<ConfigItemMapEntry>

Returns:

true iff size() == 0

contains

public boolean contains(String name)

Parameters:

name - the name to look for

Returns:

true iff an element of this item is mapped to the name

getByName

public ConfigItemMapEntry getByName(String name)

Parameters:

name - the name to look for

Returns:

the element mapped to this name, null if none

put

public ConfigItemMapEntry put(ConfigItemMapEntry value)

Parameters:

value - the value to add. It's name will be the key

Returns:

the previous value with this name

removeByName

public ConfigItemMapEntry removeByName(String name)

Parameters:

name - the name to look for

Returns:

the previous value, or null if none.

iterator

public Iterator<ConfigItemMapEntry> iterator()

Specified by:

iterator in interface ConfigItemCollection<ConfigItemMapEntry>

Returns:

an iterator on the elements stored in this entry

appendXMLContent

public void appendXMLContent(XMLUtil util,
                             Appendable appendable)
                      throws IOException

Description copied from interface: XMLConvertible

Write the XML format for this object. This is used while writing the ODS file.

Specified by:

appendXMLContent in interface XMLConvertible

Parameters:

util - a helper object

appendable - the appendable to append data to

Throws:

IOException - if the style can't be added

clear

public void clear()

Clears this item.