com.github.jferard.fastods.odselement.config

Class ConfigItemMapEntrySequence

java.lang.Object

com.github.jferard.fastods.odselement.config.ConfigItemMapEntrySequence

All Implemented Interfaces:

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

public class ConfigItemMapEntrySequence
extends Object
implements ConfigItemMapEntry

A sequence of ConfigBlocks. See 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.
static ConfigItemMapEntrySequence	createSequence()
static ConfigItemMapEntrySequence	createSequence(String name)
String	getName()
boolean	isEmpty()
Iterator<ConfigBlock>	iterator()
ConfigBlock	put(ConfigBlock block) Put a block in this entry.
void	remove(int i) Remove the block at a given index.
String	set(int i, String value) Set a value for an item at a given index
int	size()

Methods inherited from class java.lang.Object

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

Method Detail

createSequence

public static ConfigItemMapEntrySequence createSequence()

Returns:

a new sequence

createSequence

public static ConfigItemMapEntrySequence createSequence(String name)

Parameters:

name - the name of the sequence

Returns:

a new named sequence

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

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(int i)

Remove the block at a given index.

Parameters:

i - the index.

Throws:

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

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

set

public String set(int i,
                  String value)

Set a value for an item at a given index

Parameters:

i - the index

value - the new value

Returns:

the previous value

Throws:

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

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