com.plumtree.openfoundation.platform
Class XPOSFamily

java.lang.Object
  extended bycom.plumtree.openfoundation.platform.XPOSFamily

public class XPOSFamily
extends java.lang.Object

Enumerated ordinal type for OS family.

Author:
DanielF

Field Summary
 int m_id
          ID to identify a XPOSFamily object.
 java.lang.String m_name
          String value for XPOSFamily object.
static XPOSFamily OLDMAC
          Predefined XPOSFamily object for Macintosh System 9.
static XPOSFamily[] platformList
          XPOSFamily object array for predefined static values.
static XPOSFamily UNIX
          Predefined XPOSFamily object for Unix-based OS.
static XPOSFamily WINDOWS
          Predefined XPOSFamily object for Windows-based OS.
 
Method Summary
 boolean equals(XPOSFamily osFamily)
          Compare if two XPOSFamily instances are same using their IDs.
 java.lang.String GetName()
          Return the string value of current XPOSFamily instance.
static XPOSFamily GetOSFamily()
          Get XPOSFamily object of current OS by invoking static methods from XPOperatingSystem.
static XPOSFamily GetOSFamily(int id)
          Gets OS family by ID.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

m_id

public int m_id
ID to identify a XPOSFamily object.


m_name

public java.lang.String m_name
String value for XPOSFamily object.


WINDOWS

public static final XPOSFamily WINDOWS
Predefined XPOSFamily object for Windows-based OS.


UNIX

public static final XPOSFamily UNIX
Predefined XPOSFamily object for Unix-based OS.


OLDMAC

public static final XPOSFamily OLDMAC
Predefined XPOSFamily object for Macintosh System 9.


platformList

public static XPOSFamily[] platformList
XPOSFamily object array for predefined static values.

Method Detail

GetOSFamily

public static XPOSFamily GetOSFamily(int id)
Gets OS family by ID.

Parameters:
id - ID for expected XPOSFamily.
Returns:
an instance of XPOSFamily corresponding to the supplied ID.

GetName

public java.lang.String GetName()
Return the string value of current XPOSFamily instance.

Returns:
the name of the platform

equals

public boolean equals(XPOSFamily osFamily)
Compare if two XPOSFamily instances are same using their IDs.

Parameters:
osFamily - XPOSFamily object used to compared with current instance.
Returns:
true if these two instances have same ID, false if otherwise.

toString

public java.lang.String toString()

GetOSFamily

public static XPOSFamily GetOSFamily()
Get XPOSFamily object of current OS by invoking static methods from XPOperatingSystem.

Returns:
XPOSFamily of current OS.


Copyright 2002, 2003, 2004 Plumtree Software Inc. All Rights Reserved.