wwndesc  1.0-76
WWNDesc Class Reference

WWNDesc is the basic generic class from which each vendor-specific pattern is built upon; similar to an abstract parent but populated methods. More...

Inheritance diagram for WWNDesc:
Collaboration diagram for WWNDesc:

Data Structures

class  WWNDescInitiator
 simple pass-thru class to define internal value for a Initiator in an idempotent way More...
 
class  WWNDescSwitch
 simple pass-thru class to define internal value for a Switch in an idempotent way More...
 
class  WWNDescTarget
 simple pass-thru class to define internal value for a Target in an idempotent way More...
 

Public Member Functions

 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...
 

Protected Attributes

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

WWNDesc is the basic generic class from which each vendor-specific pattern is built upon; similar to an abstract parent but populated methods.

Definition at line 19 of file WWNDesc.java.

Constructor & Destructor Documentation

WWNDesc ( 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.NullPointerExceptionif the given wwn is null
Parameters
wwnthe WWN to evaluate and describe

Definition at line 33 of file WWNDesc.java.

References WWNDesc.wwn.

WWNDesc ( 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.NullPointerExceptionif the given wwn is null
Parameters
briefwhether an abbreviated description is requested
wwnthe WWN to evaluate and describe

Definition at line 45 of file WWNDesc.java.

References WWNDesc.brief, DevRole.TARGET, and WWNDesc.wwn.

WWNDesc ( boolean  brief,
String  wwn,
DevRole  role 
)
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.NullPointerExceptionif the given wwn is null
Parameters
briefwhether an abbreviated description is requested
wwnthe WWN to evaluate and describe
rolethe device role to assign

Definition at line 58 of file WWNDesc.java.

References WWNDesc.brief, and WWNDesc.role.

Member Function Documentation

String descPort ( )
inline

describe the WWPN's unique port label/index

Returns
the unique name for the port WWPN

Definition at line 81 of file WWNDesc.java.

Referenced by WWNDescription.main().

String toString ( )
inline

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

Returns
the alias for the WWN constructed from the WWN bit fields

Definition at line 71 of file WWNDesc.java.

Referenced by WWNDescription.main().

Field Documentation

boolean brief
protected

whether a more brief output should be offered in toString() (ie the difference between "VMax-HK192601234-12gB" and "VMax-1234-12gB") .

. the class may choose to ignore this value

Definition at line 22 of file WWNDesc.java.

Referenced by PureStorageDescription.toString(), EMCSymmetrixDescription.toString(), EMCVPLEXDescription.toString(), EMCVMAXDescription.toString(), NetAppDescription.toString(), SymbiosDescription.toString(), IBMSVCDescription.toString(), HDSVSPDescription.toString(), CiscoSwitchDescription.toString(), HDSModularDescription.toString(), and WWNDesc.WWNDesc().


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