Centralize the sorting logic for various IBM products based on IBM Storage Systems WWPN Determination. More...

Inheritance diagram for IBMDescription:

Collaboration diagram for IBMDescription:

Public Member Functions
	IBMDescription (String wwn)
	create an instance with brief set to false. More...

	IBMDescription (boolean brief, String wwn)
	create an instance with the given WWN. More...

String	toString ()
	return a description or alias for this WWN More...

Public Member Functions inherited from WWNDesc.WWNDescTarget
	WWNDescTarget (String wwn)
	create an instance with brief set to false. More...

	WWNDescTarget (boolean brief, String wwn)
	create an instance with the given WWN. More...

Public Member Functions inherited from WWNDesc
	WWNDesc (String wwn)
	create an instance with brief set to false. More...

	WWNDesc (boolean brief, String wwn)
	create an instance with the given WWN. More...

	WWNDesc (boolean brief, String wwn, DevRole role)
	create an instance with the given WWN. More...

String	descPort ()
	describe the WWPN's unique port label/index More...

String	toString ()
	describe the WWN: produce a short (shorter if this.brief = true) description suitable for use as an alias for this WWN More...

Static Public Member Functions
static WWNDesc	getDesc (boolean strong, boolean brief, String wwn)
	If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN. More...

static WWNDesc	getDesc (boolean strong, boolean brief, String wwn, int role)
	If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN. More...

Static Public Member Functions inherited from WWNDesc.WWNDescTarget
static boolean	isA (int role)
	convenience function to use bit-masks to check for membership in this role More...

Additional Inherited Members
Protected Attributes inherited from WWNDesc
boolean	brief
	whether a more brief output should be offered in toString() (ie the difference between "VMax-HK192601234-12gB" and "VMax-1234-12gB") . More...

DevRole	role = DevRole.TARGET
	role of the device: Target, Switch, Initiator

BigInteger	wwn
	the WWN that the instance tried to describe

Detailed Description

Centralize the sorting logic for various IBM products based on IBM Storage Systems WWPN Determination.

See also: http://aussiestorageblog.files.wordpress.com/2013/01/ibm-storage-systems-wwpn-determination-version-6-6.pdf

Definition at line 15 of file IBMDescription.java.

Constructor & Destructor Documentation

IBMDescription ( String wwn )

inline

create an instance with brief set to false.

This is a convenience function to support the older constructor model

Exceptions

java.lang.NullPointerException if the given wwn is null

Parameters

wwn	the WWN to evaluate and describe

Definition at line 18 of file IBMDescription.java.

IBMDescription	(	boolean	brief,
		String	wwn
	)

inline

create an instance with the given WWN.

Values given to the constructor are simply copied to internal variables for later use

Exceptions

java.lang.NullPointerException if the given wwn is null

Parameters

brief	whether an abbreviated description is requested
wwn	the WWN to evaluate and describe

Definition at line 23 of file IBMDescription.java.

Member Function Documentation

static WWNDesc getDesc	(	boolean	strong,
		boolean	brief,
		String	wwn
	)

inlinestatic

If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN.

Returns: new instance of this class, or null if the given wwn does not match this class

Parameters

strong	is ignored: this class is a strong representation, not a weak one based on empirical matching, hence can always be used with confidence
brief	is ignored: this class has only one representation of the WWN description or alias
wwn	the WWN (WWPN or WWNN, but typically WWPN) to match

Definition at line 36 of file IBMDescription.java.

References DevRole.max.

Referenced by WWNDescription.getWWNDescriptor().

static WWNDesc getDesc	(	boolean	strong,
		boolean	brief,
		String	wwn,
		int	role
	)

inlinestatic

If this class matches or describes the given WWN, returns a new instance of this class loaded with the given WWN.

Returns: new instance of this class, or null if the given wwn does not match this class

Parameters

strong	is ignored: this class is a strong representation, not a weak one based on empirical matching, hence can always be used with confidence
brief	is ignored: this class has only one representation of the WWN description or alias
wwn	the WWN (WWPN or WWNN, but typically WWPN) to match
role	Role (Initiator/Switch/Target) to check for

Definition at line 44 of file IBMDescription.java.

References WWNDesc.WWNDescTarget.isA().

Here is the call graph for this function:

String toString ( )

inline

return a description or alias for this WWN

Returns: generated alias or nickname for the WWN

Definition at line 69 of file IBMDescription.java.

The documentation for this class was generated from the following file:

java/IBMDescription.java

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation