com.github.jferard.fastods.odselement.config

Class ConfigItemMapIndexed

java.lang.Object

com.github.jferard.fastods.odselement.config.ConfigItemMapIndexed

All Implemented Interfaces:

ConfigBlock, ConfigItemCollection<ConfigItemMapEntry>, Tag, XMLConvertible

public class ConfigItemMapIndexed
extends Object
implements ConfigItemCollection<ConfigItemMapEntry>

A Map with indexed elements: no name is required. 3.10.4 config:config-item-map-indexed

Author:

Julien Férard

Constructor Summary

Constructors

Constructor and Description
ConfigItemMapIndexed(String name)

Method Summary

Modifier and Type	Method and Description
boolean	add(ConfigItemMapEntry configItemMapEntry)
void	add(int index, ConfigItemMapEntry element)
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
boolean	contains(Object o)
ConfigItemMapEntry	get(int index)
String	getName()
boolean	isEmpty()
Iterator<ConfigItemMapEntry>	iterator()
void	remove(int index)
ConfigItemMapEntry	set(int index, ConfigItemMapEntry element)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigItemMapIndexed

public ConfigItemMapIndexed(String name)

Parameters:

name - the name of the item (= map)

Method Detail

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(Object o)

Parameters:

o - the object to find

Returns:

true iff the object is in the map

iterator

public Iterator<ConfigItemMapEntry> iterator()

Specified by:

iterator in interface ConfigItemCollection<ConfigItemMapEntry>

Returns:

an iterator on the elements stored in this entry

add

public boolean add(ConfigItemMapEntry configItemMapEntry)

Parameters:

configItemMapEntry - the entry to add

Returns:

true if the new entry was added

remove

public void remove(int index)

Parameters:

index - the index of the element to be removed

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index ≥ size())

get

public ConfigItemMapEntry get(int index)

Parameters:

index - the index of the entry to return

Returns:

the entry

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index ≥ size())

set

public ConfigItemMapEntry set(int index,
                              ConfigItemMapEntry element)

Parameters:

index - the index of the entry to set

element - the new element to set

Returns:

the previous element

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index ≥ size())

add

public void add(int index,
                ConfigItemMapEntry element)

Parameters:

index - the index of the entry to add

element - the new element to add

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index ≥ size())

getName

public String getName()

Specified by:

getName in interface ConfigBlock

Returns:

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

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