edu::wpi::hri::gen::ebml::EBMLList Class Reference

Inheritance diagram for edu::wpi::hri::gen::ebml::EBMLList:

[legend]

List of all members.

Public Member Functions
	EBMLList (Logger logger, XMLInterface xml, String id)
	EBMLList (Logger logger, XMLInterface xml, Element root)
List< Behavior >	getAllBehaviors ()
List< ReferenceBehavior >	getReferences ()
void	removeReference (ReferenceBehavior ref)
int	size ()
Static Public Member Functions
static EBMLList	parseEBML (Logger logger, XMLInterface xml, String ebml)
Private Attributes
final List< ReferenceBehavior >	references

---

Detailed Description

The EBMLList holds behaviors which can be regular behaviors, or references. The behavior list object maintains the standard BML behaviors, while this object holds the references and other information which is not in standard BML. Although anyone can make an EBMLList object, it is only recommended that they be created when references are required.

Author:

Aaron Holroyd (aholroyd (at) wpi (dot) edu)

Definition at line 59 of file EBMLList.java.

---

Constructor & Destructor Documentation

edu::wpi::hri::gen::ebml::EBMLList::EBMLList	(	Logger	logger,
		XMLInterface	xml,
		Element	root
	)			[inline]

Create an EBMLList from an XML tree. The xml interface is used to parse and transform ebml to bml or to behaviors.

Parameters:

	logger	the logger to log to.
	xml	the xml interface to parse and write with.
	root	the root element which is an ebml element.

Definition at line 74 of file EBMLList.java.

edu::wpi::hri::gen::ebml::EBMLList::EBMLList	(	Logger	logger,
		XMLInterface	xml,
		String	id
	)			[inline]

Create an empty EBMLList which can have references and standard behaviors added to.

Parameters:

	logger	the logger to log to.
	xml	the xml interface to transform this to bml to
	id	the id of the main ebml tag

Definition at line 104 of file EBMLList.java.

---

Member Function Documentation

List<Behavior> edu::wpi::hri::gen::ebml::EBMLList::getAllBehaviors

(

)

[inline]

Definition at line 130 of file EBMLList.java.

List<ReferenceBehavior> edu::wpi::hri::gen::ebml::EBMLList::getReferences

(

)

[inline]

Get the list of all of the references in this ebml list.

Returns:

The list of references.

Definition at line 114 of file EBMLList.java.

static EBMLList edu::wpi::hri::gen::ebml::EBMLList::parseEBML	(	Logger	logger,
		XMLInterface	xml,
		String	ebml
	)			[inline, static]

This method will take the given string and parse it as EBML. The returned list will contain all of the valid behaviors which were found as a result of the parse. If any one of the behaviors does not find a required attribute, that behavior will throw an IllegalArgumentException.

Parameters:

	logger	The logger to sent output to.
	xml	The interface to use to convert the bml to a list.
	bml	The String of bml to parse.

Returns:

The parsed list of behaviors.

Exceptions:

IllegalArgumentException

If a behavior is not able to be parsed.

Definition at line 157 of file EBMLList.java.

void edu::wpi::hri::gen::ebml::EBMLList::removeReference

(

ReferenceBehavior

ref

)

[inline]

Remove the given reference from this list.

Parameters:

ref

the reference to remove.

Definition at line 124 of file EBMLList.java.

int edu::wpi::hri::gen::ebml::EBMLList::size

(

)

[inline]

Definition at line 137 of file EBMLList.java.

---

Member Data Documentation

final List<ReferenceBehavior> edu::wpi::hri::gen::ebml::EBMLList::references [private]

Definition at line 61 of file EBMLList.java.

---

The documentation for this class was generated from the following file:

• engagement_generation/src/edu/wpi/hri/gen/ebml/EBMLList.java