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

## org.eclipse.hyades.logging.events
Class ReportSituationImpl

    java.lang.Object
      |
      +--org.eclipse.hyades.logging.events.SituationTypeImpl
            |
            +--org.eclipse.hyades.logging.events.ReportSituationImpl

All Implemented Interfaces:
  java.lang.Cloneable, IReportSituation, ISituationType, java.io.Serializable

public class ReportSituationImpl
extends SituationTypeImpl
implements IReportSituation, java.io.Serializable, java.lang.Cloneable

The ReportSituation deals with the situations reported from the component, such as heartbeat or performance information. Data such as current CPU utilization, current memory heap size, etc. would fall into this category. Existing messages include words like utilization value is, buffer size is, and number of threads is, for example: `IEE890I WTO Buffers in console backup storage = 1024`

Since:
  1.0.1
Version:
  1.0.1
Author:
  Richard K. Duggan, Paul E. Slauenwhite
See Also:
  `IReportSituation`, `ISituationType`, Serialized Form

Field Summary
`protected java.lang.String` | `reportCategory`

Fields inherited from class org.eclipse.hyades.logging.events.SituationTypeImpl
`reasoningScope`

Constructor Summary
`protected` | `ReportSituationImpl()` No-argument protected constructor for ReportSituationImpl.

Method Summary
`java.lang.Object` | `clone()` Return a clone (copy by value) 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` | `getReportCategory()` Returns the reportCategory.
`void` | `init()` Resets the object's properties to their initial (e.g.
`void` | `setReportCategory(java.lang.String reportCategory)` Sets the reportCategory.

Methods inherited from class org.eclipse.hyades.logging.events.SituationTypeImpl
`getReasoningScope, setReasoningScope`

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

Methods inherited from interface org.eclipse.hyades.logging.events.ISituationType
`getReasoningScope, setReasoningScope`

Field Detail

### reportCategory

    protected java.lang.String reportCategory

Constructor Detail

### ReportSituationImpl

    protected ReportSituationImpl()

  No-argument protected constructor for ReportSituationImpl.

Method Detail

### getReportCategory

    public java.lang.String getReportCategory()

  Returns the reportCategory. This property specifies the category of the reported situation. The reportCategory is a string with the following set of values: PERFORMANCE SECURITY HEARTBEAT STATUS TRACE 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:
    `getReportCategory` in interface `IReportSituation`
  Returns:
    String The returned reportCategory.
  Since:
    1.0.1

### setReportCategory

    public void setReportCategory(java.lang.String reportCategory)

  Sets the reportCategory. This property specifies the category of the reported situation. The reportCategory is a string with the following set of values: PERFORMANCE SECURITY HEARTBEAT STATUS TRACE 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:
    `setReportCategory` in interface `IReportSituation`
  Parameters:
    `reportCategory` - The reportCategory to be set.
  Since:
    1.0.1

### 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`, false otherwise.
  See Also:
    `Object.equals(java.lang.Object)`

### clone

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

  Return a clone (copy by value) 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 clone of this object.
    `java.lang.CloneNotSupportedException`

### init

    public void init()

  Resets the object's properties to their initial (e.g. null) state.

  Specified by:
    `init` in interface `ISituationType`
  Overrides:
    `init` in class `SituationTypeImpl`
  See Also:
    `ISituationType.init()`

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