com.ibm.etools.logging.util
Class Detail

java.lang.Object
  |
  +--com.ibm.etools.logging.util.Detail

Deprecated. As of May 25, 2004, the level of detail is the same for all serialized Common Base Events.

public final class Detail
extends java.lang.Object

Licensed Material - Property of IBM (C) Copyright IBM Corp. 2003, 2005 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Static constants and convenience APIs representing five levels of detail for serializing data.

The higher the level of detail, the more verbose and higher quantity of serialized data. CHANGE HISTORY Date Programmer Defect Description -------- ----------------- ------- -------------------------------- 05/26/03 paules@ca.ibm.com 245729 Initial creation.


Field Summary
static int ALL
          Deprecated. Constant value intended for representing all serialized data.
static int HIGH
          Deprecated. Constant value intended for representing a high detail/quantity of serialized data.
static int LOW
          Deprecated. Constant value intended for representing a low detail/quantity of serialized data.
static int MEDIUM
          Deprecated. Constant value intended for representing the medium detail/quantity of serialized data.
static int NONE
          Deprecated. Constant value intended for blocking all serialized data.
 
Constructor Summary
Detail()
          Deprecated.  
 
Method Summary
static java.lang.String[] getDETAIL_NAMES()
          Deprecated. Use the getDetailNames() API.
static int getDetail(java.lang.String detailName)
          Deprecated. Returns the integer detail value for the parameter detail String.
static java.lang.String getDetailName(int detailNumber)
          Deprecated. Returns the String representation for the parameter level of detail.
static java.lang.String[] getDetailNames()
          Deprecated. Returns the array of the String representations of the five levels of detail.
static boolean isValidDetail(int checkDetailNumber)
          Deprecated. Checks if the parameter check detail is one of the five valid levels of detail.
static boolean isValidDetail(java.lang.String checkDetailName)
          Deprecated. Checks if the case-insensitive parameter check detail name is one of the five valid levels of detail names.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NONE

public static final int NONE
Deprecated. 
Constant value intended for blocking all serialized data.

See Also:
Constant Field Values

LOW

public static final int LOW
Deprecated. 
Constant value intended for representing a low detail/quantity of serialized data.

See Also:
Constant Field Values

MEDIUM

public static final int MEDIUM
Deprecated. 
Constant value intended for representing the medium detail/quantity of serialized data.

See Also:
Constant Field Values

HIGH

public static final int HIGH
Deprecated. 
Constant value intended for representing a high detail/quantity of serialized data.

See Also:
Constant Field Values

ALL

public static final int ALL
Deprecated. 
Constant value intended for representing all serialized data.

See Also:
Constant Field Values
Constructor Detail

Detail

public Detail()
Deprecated. 
Method Detail

isValidDetail

public static boolean isValidDetail(int checkDetailNumber)
Deprecated. 
Checks if the parameter check detail is one of the five valid levels of detail.

Parameters:
checkDetailNumber - a potential detail to be checked for validity.
Returns:
true if the parameter check detail is one of the five valid levels of detail, otherwise false.

isValidDetail

public static boolean isValidDetail(java.lang.String checkDetailName)
Deprecated. 
Checks if the case-insensitive parameter check detail name is one of the five valid levels of detail names.

Returns:
true if the parameter check detail name is one of the five valid levels of detail, otherwise false.

getDetail

public static int getDetail(java.lang.String detailName)
Deprecated. 
Returns the integer detail value for the parameter detail String.

The parameter detail String could be either the case-insensitive English name (i.e. "LOW") or the detail number as a String (i.e. "1").

Parameters:
detailName - a potential detail String to be checked for its integer value.
Returns:
the integer detail value for the parameter detail String, or -1 if invalid.

getDetailName

public static java.lang.String getDetailName(int detailNumber)
Deprecated. 
Returns the String representation for the parameter level of detail.

Parameters:
detailNumber - a potential level of detail to be checked for its String representation.
Returns:
the String representation for the parameter level of detail, or null if invalid.

getDetailNames

public static java.lang.String[] getDetailNames()
Deprecated. 
Returns the array of the String representations of the five levels of detail.

Returns:
the array of the String representations of the five levels of detail.

getDETAIL_NAMES

public static java.lang.String[] getDETAIL_NAMES()
Deprecated. Use the getDetailNames() API.

Returns the array of the String representations of the five levels of detail.

Returns:
the array of the String representations of the five levels of detail.