com.github.jferard.fastods.odselement.config

Class ConfigItemMapEntrySet

java.lang.Object

com.github.jferard.fastods.odselement.config.ConfigItemMapEntrySet

All Implemented Interfaces:

ConfigBlock, ConfigItemCollection<ConfigBlock>, ConfigItemMapEntry, Tag, XMLConvertible

public class ConfigItemMapEntrySet
extends Object
implements ConfigItemMapEntry

A hashtable of ConfigBlocks. 3.10.5 config:config-item-map-entry

Author:

Julien Férard

Method Summary

Modifier and Type	Method and Description
boolean	add(ConfigBlock block) Add a block to this entry.
boolean	add(String name, String type, String value) Add an ConfigItem to this entry.
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
boolean	contains(String name)
static ConfigItemMapEntrySet	createSet()
static ConfigItemMapEntrySet	createSet(String name)
ConfigBlock	getByName(String name)
String	getName()
boolean	isEmpty()
Iterator<ConfigBlock>	iterator()
ConfigBlock	put(ConfigBlock block) Put a block in this entry.
void	remove(Object o)
String	set(String name, String value) Set a value for an item with a given name
int	size()

Methods inherited from class java.lang.Object

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

Method Detail

createSet

public static ConfigItemMapEntrySet createSet()

Returns:

a new ConfigItemMapEntrySet

createSet

public static ConfigItemMapEntrySet createSet(String name)

Parameters:

name - the name of the hashtable

Returns:

a new ConfigItemMapEntrySet

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<ConfigBlock>

Returns:

the number of ConfigBlocks in this entry

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ConfigItemCollection<ConfigBlock>

Returns:

true iff size() == 0

contains

public boolean contains(String name)

Parameters:

name - the name to look for

Returns:

true if a block with that name exists in the set

add

public boolean add(ConfigBlock block)

Description copied from interface: ConfigItemMapEntry

Add a block to this entry.

Specified by:

add in interface ConfigItemMapEntry

Parameters:

block - the block to add to this entry. May throw

Returns:

true if the block was added

put

public ConfigBlock put(ConfigBlock block)

Description copied from interface: ConfigItemMapEntry

Put a block in this entry. Replace existing block with the same name.

Specified by:

put in interface ConfigItemMapEntry

Parameters:

block - the block to add to this entry. May throw

Returns:

the previous block or null.

remove

public void remove(Object o)

Parameters:

o - the block to remove

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

iterator

public Iterator<ConfigBlock> iterator()

Specified by:

iterator in interface ConfigItemCollection<ConfigBlock>

Returns:

an iterator on the elements stored in this entry

getByName

public ConfigBlock getByName(String name)

Parameters:

name - the name of the config block

Returns:

the config block matching the name, or null

set

public String set(String name,
                  String value)

Set a value for an item with a given name

Parameters:

name - the name of the item

value - the new value

Returns:

the previous value, or null if the block of that name doesn't exist or is not a ConfigItem.

add

public boolean add(String name,
                   String type,
                   String value)

Description copied from interface: ConfigItemMapEntry

Add an ConfigItem to this entry. Shortcut for add(new ConfigItem(name, type, value)).

Specified by:

add in interface ConfigItemMapEntry

Parameters:

name - the name of the item

type - the type of the item

value - the value of the item

Returns:

true if the block was added