|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.host.EPPHostAddress
public class EPPHostAddress
Represents a host address specified in an EPPHostCreateCmd
or
in an EPPHostAddRemove
object of an
EPPHostUpdateCmd
. An address consists of a name and a
type, where type is either EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
. The default type is
EPPHostAddress.IPV6
.
EPPHostCreateCmd
,
EPPHostUpdateCmd
,
EPPHostAddRemove
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ATTR_IPV6
IPV6 IP address constant. |
static short |
IPV4
IPV4 IP address constant. |
static short |
IPV6
IPV6 IP address constant. |
Constructor Summary | |
---|---|
EPPHostAddress()
Default constructor for EPPHostAddress . |
|
EPPHostAddress(java.lang.String aName)
Constructor for EPPHostAddress that the takes the string
name of the IP address with the type set to IPV4 . |
|
EPPHostAddress(java.lang.String aName,
short aType)
Constructor for EPPHostAddress that the takes the string
name of the IP address along with the type of the IP address using
either the constant EPPHostAddress.IPV4 or
EPPHostAddress.IPV6 . |
|
EPPHostAddress(java.lang.String aRootNS,
java.lang.String aRootName,
java.lang.String aName)
Constructor for EPPHostAddress that the takes the string
name of an IPV4 IP address and the root tag to use. |
|
EPPHostAddress(java.lang.String aRootNS,
java.lang.String aRootName,
java.lang.String aName,
short aType)
Constructor for EPPHostAddress that the takes the string
name of an IPV4 or IPV6 IP address and the root tag to use. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPHostAddress . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPHostAddress attributes from the aElement DOM
Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPHostAddress instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPHostAddress compare. |
java.lang.String |
getName()
Gets the addresss name in the format specified by getType . |
java.lang.String |
getRootName()
Get root name such as domain. |
java.lang.String |
getRootNS()
Gets the root element XML namespace URI. |
short |
getType()
Gets the type of the address name, which should be either the EPPHostAddress.IPV4 or the
EPPHostAddress.IPV6 constant. |
void |
setName(java.lang.String aName)
Sets the address name in the format specified by setType . |
void |
setName(java.lang.String aName,
short aType)
Sets the address name and address type. |
void |
setRootName(java.lang.String aRootNS,
java.lang.String aRootName)
Set root name such as domain. |
void |
setType(short aType)
Sets the type of the address name to either the EPPHostAddress.IPV4 or the
EPPHostAddress.IPV6 constant. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short IPV4
public static final short IPV6
public static final java.lang.String ATTR_IPV6
Constructor Detail |
---|
public EPPHostAddress()
EPPHostAddress
. The name attribute
defaults to null
and must be set using
setName
before invoking encode
. The type
defaults to IPV4.
public EPPHostAddress(java.lang.String aName)
EPPHostAddress
that the takes the string
name of the IP address with the type set to IPV4
.
aName
- IP address name.public EPPHostAddress(java.lang.String aName, short aType)
EPPHostAddress
that the takes the string
name of the IP address along with the type of the IP address using
either the constant EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
.
aName
- IP address name.aType
- EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
constant.public EPPHostAddress(java.lang.String aRootNS, java.lang.String aRootName, java.lang.String aName)
EPPHostAddress
that the takes the string
name of an IPV4 IP address and the root tag to use. This constructor
is useful for other mappings like domain.
aRootNS
- Root element namespace URIaRootName
- Root tag for the elementaName
- IP address name in IPV4 format.public EPPHostAddress(java.lang.String aRootNS, java.lang.String aRootName, java.lang.String aName, short aType)
EPPHostAddress
that the takes the string
name of an IPV4 or IPV6 IP address and the root tag to use. This
constructor is useful for other mappings like domain.
aRootNS
- Root element namespace URIaRootName
- Root tag for the elementaName
- IP address name in IPV4 format.aType
- EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
constant.Method Detail |
---|
public java.lang.String getRootNS()
public java.lang.String getRootName()
public void setRootName(java.lang.String aRootNS, java.lang.String aRootName)
aRootNS
- Root element namespace URIaRootName
- Root element tag to usepublic java.lang.String getName()
getType
.
String
instance if defined;
null
otherwise.public void setName(java.lang.String aName)
setType
.
aName
- address namepublic void setName(java.lang.String aName, short aType)
aType
should be
either EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
, and the address name should
conform to the format of the type.
aName
- address nameaType
- address type ((EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
)public short getType()
EPPHostAddress.IPV4
or the
EPPHostAddress.IPV6
constant.
EPPHostAddress.IPV4
or
EPPHostAddress.IPV6
)public void setType(short aType)
EPPHostAddress.IPV4
or the
EPPHostAddress.IPV6
constant.
aType
- IPV4
or IPV6
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPHostAddress
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPHostAddress
instance.
EPPEncodeException
- Unable to encode
EPPHostAddress
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPHostAddress
attributes from the aElement DOM
Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPHostAddress
from.
EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPHostAddress
compare.
equals
in class java.lang.Object
aObject
- EPPHostAddress
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPHostAddress
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPHostAddress
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |