EntityArray (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.EntityArray

All Implemented Interfaces:

Serializable, Cloneable, Entity, EntityCollection, IndexedEntityCollection
```
public class EntityArray
extends EntityCollectionSupport
implements IndexedEntityCollection
```
Entity collection with the following approach: a size (number of children) and a prototypical child are assigned. The prototype child is cloned size times, and these clones become the indexed child entities.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`EntityArray()` Create a new EntityArray.
`EntityArray(Entity prototype)` Create a new EntityArray with the specified prototype.
`EntityArray(Entity prototype, int size)` Create a new IndexedEntityCollection.
`EntityArray(int size)` Create a new IndexedEntityCollection.

Method Summary

Methods
Modifier and Type	Method and Description
`EntityArray`	`clone()` Clone this EntityArray.
`Entity`	`getChild(int index)` Get the child at the specified index.
`Collection<Entity>`	`getChildren()` Get the children.
`int`	`getMaximumSize()` Get the int maximumSize.
`int`	`getMinimumSize()` Get the int minimumSize.
`Entity`	`getPrototype()` Get the prototype.
`boolean`	`isResizable()` Get the boolean resizable.
`boolean`	`isSizable()` Learn whether the size of this object can be set.
`void`	`setMaximumSize(int maximumSize)` Set the int maximumSize.
`void`	`setMinimumSize(int minimumSize)` Set the int minimumSize.
`void`	`setPrototype(Entity prototype)` Set the prototype.
`void`	`setResizable(boolean resizable)` Set the boolean resizable.
`void`	`setSize(int size)` Set new size of this object.
`int`	`size()` Get the size (# of child elements) of this IndexedEntityCollection.

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
  - EntityArray
```
public EntityArray()
```
    Create a new EntityArray.
  - EntityArray
```
public EntityArray(int size)
```
    Create a new IndexedEntityCollection.
    
    Parameters:
    size - number of occurrences of the prototypical Entity
  - EntityArray
```
public EntityArray(Entity prototype)
```
    Create a new EntityArray with the specified prototype.
    
    Parameters:
    prototype - Entity
  - EntityArray
```
public EntityArray(Entity prototype,
           int size)
```
    Create a new IndexedEntityCollection.
    
    Parameters:
    prototype - Entity
    size - number of occurrences
- Method Detail
  - getChild
```
public Entity getChild(int index)
```
    Get the child at the specified index.
    
    Specified by:
    
    getChild in interface IndexedEntityCollection
    
    Parameters:
    index - int
    
    Returns:
    Entity
  - getChildren
```
public Collection<Entity> getChildren()
```
    Get the children.
    
    Specified by:
    
    getChildren in interface EntityCollection
    
    Returns:
    Collection.
  - getPrototype
```
public Entity getPrototype()
```
    Get the prototype.
    
    Returns:
    Entity.
  - setPrototype
```
public void setPrototype(Entity prototype)
```
    Set the prototype.
    
    Parameters:
    prototype - The Entity prototype to set.
  - setSize
```
public void setSize(int size)
```
    Set new size of this object.
    
    Specified by:
    
    setSize in interface IndexedEntityCollection
    
    Parameters:
    size - to set
    
    Throws:
    
    IllegalArgumentException - if size is not valid.
  - size
```
public int size()
```
    Get the size (# of child elements) of this IndexedEntityCollection.
    
    Specified by:
    
    size in interface IndexedEntityCollection
    
    Returns:
    int
  - isSizable
```
public boolean isSizable()
```
    Learn whether the size of this object can be set.
    
    Specified by:
    
    isSizable in interface IndexedEntityCollection
    
    Returns:
    boolean
  - clone
```
public EntityArray clone()
```
    Clone this EntityArray.
    
    Specified by:
    
    clone in interface Entity
    
    Overrides:
    
    clone in class EntityCollectionSupport
    
    Returns:
    new EntityArray
  - getMaximumSize
```
public int getMaximumSize()
```
    Get the int maximumSize.
    
    Returns:
    int
  - setMaximumSize
```
public void setMaximumSize(int maximumSize)
```
    Set the int maximumSize.
    
    Parameters:
    maximumSize - int
  - getMinimumSize
```
public int getMinimumSize()
```
    Get the int minimumSize.
    
    Returns:
    int
  - setMinimumSize
```
public void setMinimumSize(int minimumSize)
```
    Set the int minimumSize.
    
    Parameters:
    minimumSize - int
  - isResizable
```
public boolean isResizable()
```
    Get the boolean resizable.
    
    Returns:
    boolean
  - setResizable
```
public void setResizable(boolean resizable)
```
    Set the boolean resizable.
    
    Parameters:
    resizable - boolean

Class EntityArray

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

EntityArray

EntityArray

EntityArray

EntityArray

Method Detail

getChild

getChildren

getPrototype

setPrototype

setSize

size

isSizable

clone

getMaximumSize

setMaximumSize

getMinimumSize

setMinimumSize

isResizable

setResizable