com.github.jferard.fastods.odselement.config

Interface ConfigItemMapEntry

All Superinterfaces:

ConfigBlock, ConfigItemCollection<ConfigBlock>, Tag, XMLConvertible

All Known Implementing Classes:

ConfigItemMapEntrySequence, ConfigItemMapEntrySet, ConfigItemMapEntrySingleton

public interface ConfigItemMapEntry
extends ConfigItemCollection<ConfigBlock>

A ConfigItemMapEntry represents an entry in the settings. It can be a sequence, a set or a singleton.

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.
ConfigBlock	put(ConfigBlock block) Put a block in this entry.

Methods inherited from interface com.github.jferard.fastods.odselement.config.ConfigItemCollection

isEmpty, iterator, size

Methods inherited from interface com.github.jferard.fastods.odselement.config.ConfigBlock

getName

Methods inherited from interface com.github.jferard.fastods.XMLConvertible

appendXMLContent

Method Detail

add

boolean add(ConfigBlock block)

Add a block to this entry.

Parameters:

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

Returns:

true if the block was added

Throws:

UnsupportedOperationException - if the entry is a singleton

put

ConfigBlock put(ConfigBlock block)

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

Parameters:

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

Returns:

the previous block or null.

Throws:

UnsupportedOperationException - if the entry is a singleton or a list

add

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

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

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

Throws:

UnsupportedOperationException - if the entry is a singleton