Classes
class	IrreductibleException
Public Member Functions
List< C >	getComponent ()
Class< C >	getType ()
Object	getIndicator ()
boolean	isEmpty ()
Multiplicity	getMultiplicity ()
Engine	getEngine ()
boolean	isActive ()
boolean	isReductible ()
C	reduceComponent () throws IrreductibleException
boolean	equals (Object obj)
int	hashCode ()

Detailed Description

A displayed component.

The implementation of this interface are immutable.

Author:: kma

Parameters:

<C>	The type of the component

Member Function Documentation

boolean metadone.client.display.Component< C >.equals ( Object obj )

Components are equal if they have the same type, indicator, engine and component elements.

Parameters:

obj	The other object

Returns:: true if they are equal

List<C> metadone.client.display.Component< C >.getComponent ( )

Gets the component as a list.

Returns:: The component list (unmodifiable)

Engine metadone.client.display.Component< C >.getEngine ( )

Gets the engine that built this component.

Returns:: The engine

Object metadone.client.display.Component< C >.getIndicator ( )

Gets the indicator for this component.

The indicator may be set by the engine to add some value to the components that may be interpreted by the parent.

Returns:

Multiplicity metadone.client.display.Component< C >.getMultiplicity ( )

Gets the multiplicity of this component.

Returns:: The multiplicity

Class<C> metadone.client.display.Component< C >.getType ( )

Gets the type of the component.

Returns:: The type

int metadone.client.display.Component< C >.hashCode ( )

Computed using

 return Objects.hashCode(
   getEngine(),
   getIndicator(),
   getType(),
   Objects.hashCodeIter(iterator()));
 
 
Returns:
 The hashcode

boolean metadone.client.display.Component< C >.isActive ( )

Indicates whether the component is active.

A component is active if its engine is active.

Returns:: Boolean indicating whether this component is active

boolean metadone.client.display.Component< C >.isEmpty ( )

Indicates whether the given component is empty.

Returns:: true iff the component is empty

boolean metadone.client.display.Component< C >.isReductible ( )

Indicates whether this component is reductible.

Returns:: true iff this component can be reduced

C metadone.client.display.Component< C >.reduceComponent ( ) throws IrreductibleException

Reduces this component into a single component

Returns:: The reduced component

Exceptions:

IrreductibleException when the component couldn't be reduced

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

metadone_bundle_client/src/metadone/client/display/Component.java

Classes

Public Member Functions

Detailed Description

Member Function Documentation