TPTP 4.5.0 Platform Project
Public API Specification

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

java.lang.Object
  extended by org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl
      extended by org.eclipse.tptp.logging.events.cbe.impl.DependencySituationImpl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, DependencySituation, SituationType

public class DependencySituationImpl
extends SituationTypeImpl
implements DependencySituation

Interface representing a DependencySituation.

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 DependencySituation deals with the situations that components produce to say that they cannot find some component or feature they need. This category includes messages about not finding the version of the component that was expected. Messages that say a resource was not found or that an application or subsystem that was unavailable also fall into this category. Existing messages include words like "could not find", and "no such component", for example:

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 getDependencyDisposition()
           Returns the value of the 'Dependency Disposition' attribute.
 void init()
          Resets the object's properties to their initial (e.g. null) state.
 void setDependencyDisposition(java.lang.String newDependencyDisposition)
          Sets the value of the ' Dependency 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

getDependencyDisposition

public java.lang.String getDependencyDisposition()
Description copied from interface: DependencySituation

Returns the value of the 'Dependency Disposition' attribute.

Specified by:
getDependencyDisposition in interface DependencySituation
Returns:
the value of the 'Dependency Disposition' attribute.
See Also:
DependencySituation.setDependencyDisposition(String)

setDependencyDisposition

public void setDependencyDisposition(java.lang.String newDependencyDisposition)
Description copied from interface: DependencySituation
Sets the value of the ' Dependency Disposition' attribute.

This property specifies the dependency 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:

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:
setDependencyDisposition in interface DependencySituation
Parameters:
newDependencyDisposition - the new value of the 'Dependency Disposition' attribute.
See Also:
DependencySituation.getDependencyDisposition()

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 DependencySituation
Specified by:
init in interface SituationType
Overrides:
init in class SituationTypeImpl

TPTP 4.5.0 Platform Project
Public API Specification