Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.axis2.description
Class ParameterIncludeImpl

    java.lang.Object
      org.apache.axis2.description.ParameterIncludeImpl

All Implemented Interfaces:
  Externalizable, Serializable, SafeSerializable, ParameterInclude

    public class ParameterIncludeImpl

extends Object
implements ParameterInclude, Externalizable, SafeSerializable

Class ParameterIncludeImpl

See Also:
  Serialized Form

Field Summary
`protected Map<String,Parameter>` | `parameters` Field parmeters

Constructor Summary
`ParameterIncludeImpl()` Constructor ParameterIncludeImpl.

Method Summary
`void` | `addParameter(Parameter param)` Method addParameter
`void` | `deserializeParameters(org.apache.axiom.om.OMElement parameters)` Since at runtime it parameters may be modified to get the original state this method can be used
`Parameter` | `getParameter(String name)` Method getParameter.
`ArrayList<Parameter>` | `getParameters()` Gets all the parameters in a given description.
`boolean` | `isParameterLocked(String parameterName)` Checks whether the parameter is locked at any level.
`void` | `readExternal(ObjectInput inObject)` Restore the contents of the object that was previously saved.
`void` | `removeParameter(Parameter param)`
`void` | `writeExternal(ObjectOutput o)` Save the contents of this object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### parameters

    protected Map<String,Parameter> parameters

  Field parmeters

Constructor Detail

### ParameterIncludeImpl

    public ParameterIncludeImpl()

  Constructor ParameterIncludeImpl.

Method Detail

### addParameter

    public void addParameter(Parameter param)

  Method addParameter

  Specified by:
    `addParameter` in interface `ParameterInclude`
  Parameters:
    `param` -

### removeParameter

    public void removeParameter(Parameter param)
                         throws AxisFault

  Specified by:
    `removeParameter` in interface `ParameterInclude`
  Throws:
    `AxisFault`

### deserializeParameters

    public void deserializeParameters(org.apache.axiom.om.OMElement parameters)
                               throws AxisFault

  Since at runtime it parameters may be modified to get the original state this method can be used

  Specified by:
    `deserializeParameters` in interface `ParameterInclude`
  Parameters:
    `parameters` - `OMElement`
  Throws:
    `AxisFault`

### getParameter

    public Parameter getParameter(String name)

  Method getParameter.

  Specified by:
    `getParameter` in interface `ParameterInclude`
  Parameters:
    `name` -
  Returns:
    Returns parameter.

### getParameters

    public ArrayList<Parameter> getParameters()

  Description copied from interface: `ParameterInclude`
  Gets all the parameters in a given description.

  Specified by:
    `getParameters` in interface `ParameterInclude`
  Returns:
    Returns ArrayList.

### isParameterLocked

    public boolean isParameterLocked(String parameterName)

  Description copied from interface: `ParameterInclude`
  Checks whether the parameter is locked at any level.

  Specified by:
    `isParameterLocked` in interface `ParameterInclude`

### writeExternal

    public void writeExternal(ObjectOutput o)
                       throws IOException

  Save the contents of this object.

  NOTE: Transient fields and static fields are not saved. Also, objects that represent "static" data are not saved, except for enough information to be able to find matching objects when the message context is re-constituted.

  Specified by:
    `writeExternal` in interface `Externalizable`
  Parameters:
    `out` - The stream to write the object contents to
  Throws:
    `IOException`

### readExternal

    public void readExternal(ObjectInput inObject)
                      throws IOException,
                             ClassNotFoundException

  Restore the contents of the object that was previously saved.

  NOTE: The field data must read back in the same order and type as it was written. Some data will need to be validated when resurrected.

  Specified by:
    `readExternal` in interface `Externalizable`
  Parameters:
    `in` - The stream to read the object contents from
  Throws:
    `IOException`
    `ClassNotFoundException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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