au.gov.aao.drama
Class DramaStatus

java.lang.Object
  au.gov.aao.drama.DramaStatus

public class DramaStatus
extends Object

The DramaStatus class is used to access DRAMA status codes.

Note that the messgen utility can generate status codes as java. See the -j and -J options.

Version:

@(#) $Id: ACMM:DramaJava/DramaStatus.java,v 3.52 17-Sep-2009 14:08:21+10 tjf $

Author:

Tony Farrell

See Also:

DramaTask

Field Summary

static int	OK
static String	RCSID The RCS (ACMM) ID.

Constructor Summary

DramaStatus(int code)
Construct a DramaStatus value from an integer value

Method Summary

boolean	equals(DramaStatus s) Tests a status code for equality with another status code Remember that == will only test for a reference to the same object, you must use this member function to test if two objects contain the same code.
boolean	equals(int s) Tests a status code for equality with an integer value.
int	toInt() Convert a status code to an integer value
String	toString() Convert a status code to a string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RCSID

public static final String RCSID

The RCS (ACMM) ID. This field returns the source code archive ID of this class's source file.

The returned string corresponds to the version string seen above (in the class description comments), but will contain the version details of the compiled class file's actual source file.

(ACMM is the source code archive system used by the AAO. If the string returned by RCSID does not contain the string ACMM, then it is likely the source code has been archived again outside the AAO).

See Also:

Constant Field Values

OK

public static final int OK

See Also:

Constant Field Values

Constructor Detail

DramaStatus

public DramaStatus(int code)

Construct a DramaStatus value from an integer value

Parameters:

code - The interger value to construct the code from.

Method Detail

toString

public String toString()

Convert a status code to a string.

Overrides:

toString in class Object

Returns:

The string translation of the status code.

toInt

public int toInt()

Convert a status code to an integer value

Returns:

The stauts code as an integer

equals

public boolean equals(DramaStatus s)

Tests a status code for equality with another status code Remember that == will only test for a reference to the same object, you must use this member function to test if two objects contain the same code.

Parameters:

s - The status code to complare the object with

Returns:

True if the two codes refer to the same object

equals

public boolean equals(int s)

Tests a status code for equality with an integer value.

Parameters:

s - The status code to complare the object with

Returns:

True if the two codes refer to the same object