EntityMap (Apache Commons Flatfile (Sandbox) 1.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.flatfile.EntitySupport
- - org.apache.commons.flatfile.EntityCollectionSupport
  - - org.apache.commons.flatfile.EntityMap

All Implemented Interfaces:

Serializable, Cloneable, Entity, EntityCollection, NamedEntityCollection
```
public class EntityMap
extends EntityCollectionSupport
implements NamedEntityCollection
```
Basic implementation of NamedEntityCollection.

Version:

$Revision: 1766123 $ $Date: 2016-10-21 15:40:45 -0500 (Fri, 21 Oct 2016) $

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

EntityMap()

Constructors
Constructor and Description
`EntityMap()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(String name, Entity child)` Add a child.
`EntityMap`	`clone()` Clone oneself.
`Entity`	`getChild(String name)` Get the specified child.
`Map<String,Entity>`	`getChildMap()` Get a map of the children.
`String[]`	`getChildNames()` Get the child entities' names.
`Collection<Entity>`	`getChildren()` Get the children.
`boolean`	`hasChild(String name)` Learn whether this NamedEntityCollection has a child of the specified name.

Methods inherited from class org.apache.commons.flatfile.EntityCollectionSupport
getDelim, getValue, isDelimAfter, isSuppressEmptyChildren, length, readFrom, setDelim, setDelimAfter, setSuppressEmptyChildren, setValue, setValue, shouldSuppress, writeTo

Methods inherited from class org.apache.commons.flatfile.EntitySupport
fill, getValue

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.flatfile.Entity
fill, getValue, getValue, length, readFrom, setValue, setValue, writeTo

- Constructor Detail
  - EntityMap
```
public EntityMap()
```
- Method Detail
  - add
```
public void add(String name,
       Entity child)
```
    Add a child.
    
    Parameters:
    name - if null filler element
    child - non-null child Entity
  - getChildMap
```
public Map<String,Entity> getChildMap()
```
    Get a map of the children.
    
    Returns:
    Map
  - getChildNames
```
public String[] getChildNames()
```
    Get the child entities' names.
    
    Specified by:
    
    getChildNames in interface NamedEntityCollection
    
    Returns:
    String[]
  - getChild
```
public Entity getChild(String name)
```
    Get the specified child.
    
    Specified by:
    
    getChild in interface NamedEntityCollection
    
    Parameters:
    name - to find
    
    Returns:
    Entity
  - hasChild
```
public boolean hasChild(String name)
```
    Learn whether this NamedEntityCollection has a child of the specified name.
    
    Specified by:
    
    hasChild in interface NamedEntityCollection
    
    Parameters:
    name - to find
    
    Returns:
    boolean
  - getChildren
```
public Collection<Entity> getChildren()
```
    Get the children.
    
    Specified by:
    
    getChildren in interface EntityCollection
    
    Returns:
    Collection.
  - clone
```
public EntityMap clone()
```
    Clone oneself.
    
    Specified by:
    
    clone in interface Entity
    
    Overrides:
    
    clone in class EntityCollectionSupport
    
    Returns:
    a deep (or otherwise "safe") copy of this Entity.

Class EntityMap

Constructor Summary

Method Summary

Methods inherited from class org.apache.commons.flatfile.EntityCollectionSupport

Methods inherited from class org.apache.commons.flatfile.EntitySupport

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.commons.flatfile.Entity

Constructor Detail

EntityMap

Method Detail

add

getChildMap

getChildNames

getChild

hasChild

getChildren

clone