org.odftoolkit.simple.common.field
Class AbstractVariableContainer

java.lang.Object
  extended by org.odftoolkit.simple.common.field.AbstractVariableContainer
All Implemented Interfaces:
VariableContainer

public abstract class AbstractVariableContainer
extends Object
implements VariableContainer

AbstractVariableContainer is an abstract implementation of the VariableContainer interface, with a default implementation for every method defined in VariableContainer , except getVariableContainerElement(). A subclass must implement the abstract method getVariableContainerElement().

Since:
0.5

Constructor Summary
AbstractVariableContainer()
           
 
Method Summary
 VariableField declareVariable(String name, VariableField.VariableType type)
          Declare a new variable field to this container.
 VariableField getVariableFieldByName(String name)
          Return the declared variable by name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.odftoolkit.simple.common.field.VariableContainer
getVariableContainerElement
 

Constructor Detail

AbstractVariableContainer

public AbstractVariableContainer()
Method Detail

declareVariable

public VariableField declareVariable(String name,
                                     VariableField.VariableType type)
Description copied from interface: VariableContainer
Declare a new variable field to this container.

Specified by:
declareVariable in interface VariableContainer
Parameters:
name - the unique name of this variable field.
type - the type of this variable field.
Returns:
declared variable field.

getVariableFieldByName

public VariableField getVariableFieldByName(String name)
Description copied from interface: VariableContainer
Return the declared variable by name.

Specified by:
getVariableFieldByName in interface VariableContainer
Parameters:
name - the unique name of this variable field.
Returns:
the declared variable.


Copyright © 2010-2011 The Apache Software Foundation. All Rights Reserved.