org.eclipse.tptp.logging.events.cbe.impl
Class FeatureSituationImpl

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl
      org.eclipse.tptp.logging.events.cbe.impl.FeatureSituationImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, FeatureSituation, SituationType

public class FeatureSituationImpl
extends SituationTypeImpl
implements FeatureSituation

Interface representing a FeatureSituation.

The following description is from the Common Base Event v1.0.1 specification entitled "Canonical Situation Data Format: The Common Base Event V1.0.1":

The FeatureSituation deals with the situations that announce that a feature of a component is now ready (or not ready) for service requests. Situations that indicate things like services being available and services or features being unavailable fall into this category. Existing situations include words like "now available", "currently available", and "transport is listening on port 123", for example:

• SRVE0171I: Transport HTTPS is listening on port 9443


• MSGS0601I: WebSphere Embedded Messaging has not been installed

See Also:

Serialized Form

Method Summary

java.lang.Object	clone() Return a cloned (copy by value) object of this object.
boolean	equals(java.lang.Object object) Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.
java.lang.String	getFeatureDisposition() Returns the value of the 'Feature Disposition' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setFeatureDisposition(java.lang.String newFeatureDisposition) Sets the value of the ' Feature Disposition' attribute.
java.lang.String	toString()
void	validate() Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Methods inherited from class org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl

getReasoningScope, setReasoningScope

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.tptp.logging.events.cbe.SituationType

getReasoningScope, setReasoningScope

Method Detail

getFeatureDisposition

public java.lang.String getFeatureDisposition()

Description copied from interface: FeatureSituation

Returns the value of the 'Feature Disposition' attribute.

Specified by:

getFeatureDisposition in interface FeatureSituation

Returns:

the value of the 'Feature Disposition' attribute.

See Also:

FeatureSituation.setFeatureDisposition(String)

setFeatureDisposition

public void setFeatureDisposition(java.lang.String newFeatureDisposition)

Description copied from interface: FeatureSituation

Sets the value of the ' Feature Disposition' attribute.

This property specifies the availability disposition of a feature of a component that caused the situation to be reported. The featureDisposition is a string with the following set of values:

• AVAILABLE
• NOT AVAILABLE

This is a required property and once it is set it must not change. The string length for this property must not exceed 64 characters.

Specified by:

setFeatureDisposition in interface FeatureSituation

Parameters:

newFeatureDisposition - the new value of the 'Feature Disposition' attribute.

See Also:

FeatureSituation.getFeatureDisposition()

toString

public java.lang.String toString()

Overrides:

toString in class SituationTypeImpl

validate

public void validate()
              throws ValidationException

Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Specified by:

validate in interface SituationType

Overrides:

validate in class SituationTypeImpl

Throws:

ValidationException - If the event instance does not conform to the Common Base Event specification.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Return a cloned (copy by value) object of this object.

This is a deep copy version, in which all the objects within this object will be copied by value.

Overrides:

clone in class SituationTypeImpl

Returns:

Object The cloned (copy by value) object of this object.

Throws:

java.lang.CloneNotSupportedException - If a instance variable of this object does not implement the Cloneable interface.

equals

public boolean equals(java.lang.Object object)

Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.

Overrides:

equals in class SituationTypeImpl

Parameters:

object - The java.lang.Object to be compared to this object.

Returns:

True, if this object is the same as the parameter object, otherwise false.

See Also:

Object.equals(java.lang.Object)

init

public void init()

Resets the object's properties to their initial (e.g. null) state. All components are initialized to either zero or null.

Specified by:

init in interface FeatureSituation

Specified by:

init in interface SituationType

Overrides:

init in class SituationTypeImpl