at.ac.tuwien.infosys.sm4all.copal.api.event.xml
Class CurrentActionUnmarshaller

java.lang.Object
  extended by at.ac.tuwien.infosys.sm4all.copal.api.event.xml.CurrentActionUnmarshaller
All Implemented Interfaces:
Marshaller<CurrentAction>, Unmarshaller<CurrentAction>

public class CurrentActionUnmarshaller
extends java.lang.Object
implements Unmarshaller<CurrentAction>

Unmarshals and marshals a CurrentAction from/into an Element.

Author:
sanjin

Nested Class Summary
static class CurrentActionUnmarshaller.Builder
          Builder of CurrentActionUnmarshaller.
 
Field Summary
static java.lang.String ACTION_ELEMENT
          The local name of child Elements used in the ListUnmarshaller.Builder that is returned by the getListBuilder().
static java.lang.String NAME_ATTRIBUTE
          The name of attribute that holds marshaled name.
static java.lang.String PROCESSOR_ELEMENT
          The local name of child Element that holds marshaled name of ContextProcessor that processed marshaled CurrentAction.
static java.lang.String PROCESSOR_NAME_ATTRIBUTE
          The name of attribute that holds marshaled name of ContextProcessor that processed marshaled CurrentAction.
static java.lang.String PROCESSORS_ELEMENT
          The local name of child Element that holds marshaled names of ContextProcessors that processed marshaled CurrentAction .
static java.lang.String REQUIRED_ATTRIBUTE
          The name of attribute that holds marshaled requirement.
 
Constructor Summary
CurrentActionUnmarshaller(org.w3c.dom.Element element)
          Creates instance of CurrentAction Unmarshaller which uses specified Element for unmarshalling and/or marshalling.
 
Method Summary
 org.w3c.dom.Element getElement()
          Returns the Element used for unmarshalling and marshalling.
static ListUnmarshaller.Builder<CurrentAction> getListBuilder()
          Creates instance of ListUnmarshaller.Builder for CurrentActions.
 void marshal(CurrentAction action)
          Marshals specified CurrentAction into the Element.
 void remove()
          Removes any marshaled CurrentAction from the Element.
 CurrentAction unmarshal()
          Unmarshals a CurrentAction from the Element.
 java.lang.String unmarshalName()
          Unmarshals name of CurrentAction from the Element.
 java.lang.String[] unmarshalProcessedBy()
          Unmarshals names of ContextProcessors that processed marshaled CurrentAction.
 boolean unmarshalRequirement()
          Unmarshals requirement of CurrentAction from the Element .
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ACTION_ELEMENT

public static final java.lang.String ACTION_ELEMENT
The local name of child Elements used in the ListUnmarshaller.Builder that is returned by the getListBuilder().

See Also:
Constant Field Values

NAME_ATTRIBUTE

public static final java.lang.String NAME_ATTRIBUTE
The name of attribute that holds marshaled name.

See Also:
Constant Field Values

REQUIRED_ATTRIBUTE

public static final java.lang.String REQUIRED_ATTRIBUTE
The name of attribute that holds marshaled requirement.

See Also:
Constant Field Values

PROCESSORS_ELEMENT

public static final java.lang.String PROCESSORS_ELEMENT
The local name of child Element that holds marshaled names of ContextProcessors that processed marshaled CurrentAction .

See Also:
Constant Field Values

PROCESSOR_ELEMENT

public static final java.lang.String PROCESSOR_ELEMENT
The local name of child Element that holds marshaled name of ContextProcessor that processed marshaled CurrentAction.

See Also:
Constant Field Values

PROCESSOR_NAME_ATTRIBUTE

public static final java.lang.String PROCESSOR_NAME_ATTRIBUTE
The name of attribute that holds marshaled name of ContextProcessor that processed marshaled CurrentAction.

See Also:
Constant Field Values
Constructor Detail

CurrentActionUnmarshaller

public CurrentActionUnmarshaller(org.w3c.dom.Element element)
Creates instance of CurrentAction Unmarshaller which uses specified Element for unmarshalling and/or marshalling.

Parameters:
element - the Element used for unmarshalling and marshalling.
Throws:
java.lang.NullPointerException - if specified Element is null.
Method Detail

getElement

public org.w3c.dom.Element getElement()
Returns the Element used for unmarshalling and marshalling.

Returns:
the Element used for unmarshalling and marshalling.

unmarshal

public CurrentAction unmarshal()
                        throws FailedUnmarshallingException
Unmarshals a CurrentAction from the Element.

Specified by:
unmarshal in interface Unmarshaller<CurrentAction>
Returns:
the unmarshaled CurrentAction.
Throws:
FailedUnmarshallingException - if unmarshalling was unsuccessful.

unmarshalName

public java.lang.String unmarshalName()
                               throws FailedUnmarshallingException
Unmarshals name of CurrentAction from the Element.

Returns:
the name of marshaled CurrentAction.
Throws:
FailedUnmarshallingException - if unmarshalling was unsuccessful.

unmarshalRequirement

public boolean unmarshalRequirement()
                             throws FailedUnmarshallingException
Unmarshals requirement of CurrentAction from the Element .

Returns:
the requirement of marshaled CurrentAction.
Throws:
FailedUnmarshallingException - if unmarshalling was unsuccessful.

unmarshalProcessedBy

public java.lang.String[] unmarshalProcessedBy()
                                        throws FailedUnmarshallingException
Unmarshals names of ContextProcessors that processed marshaled CurrentAction.

Returns:
the names of ContextProcessors that processed marshaled CurrentAction.
Throws:
FailedUnmarshallingException - if unmarshalling was unsuccessful.

marshal

public void marshal(CurrentAction action)
Marshals specified CurrentAction into the Element.

Specified by:
marshal in interface Marshaller<CurrentAction>
Parameters:
action - the CurrentAction.
Throws:
java.lang.NullPointerException - if specified CurrentAction is null.

remove

public void remove()
Removes any marshaled CurrentAction from the Element.

Specified by:
remove in interface Marshaller<CurrentAction>

getListBuilder

public static ListUnmarshaller.Builder<CurrentAction> getListBuilder()
Creates instance of ListUnmarshaller.Builder for CurrentActions. The returned ListUnmarshaller.Builder does not have the parent Element set and caller should set it before building the ListUnmarshaller for CurrentActions. The name for child Elements is set to ACTION_ELEMENT.

Returns:
the ListUnmarshaller.Builder for CurrentActions.


Copyright © 2010 Distributed Systems Group, Vienna University of Technology. All Rights Reserved.