|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.suggestion.EPPSuggestionAddress
public class EPPSuggestionAddress
Represents a client address specified in an
EPPSuggestionCoordinates
object of an
EPPSuggestionGeo
. An address consists of a name and a type,
where type is either EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
. The default type is
EPPSuggestionAddress.IPV6
.
Field 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 | |
---|---|
EPPSuggestionAddress()
Default constructor for EPPSuggestionAddress . |
|
EPPSuggestionAddress(java.lang.String aName)
Constructor for EPPSuggestionAddress that the takes the
string name of the IP address with the type set to IPV4 . |
|
EPPSuggestionAddress(java.lang.String aName,
short aType)
Constructor for EPPSuggestionAddress that the takes the
string name of the IP address along with the type of the IP address using
either the constant EPPSuggestionAddress.IPV4 or
EPPSuggestionAddress.IPV6 . |
Method Summary | |
---|---|
java.lang.Object |
clone()
clone an EPPCodecComponent . |
void |
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
|
java.lang.String |
getName()
Gets the addresss name in the format specified by getType . |
short |
getType()
Gets the type of the address name, which should be either the EPPSuggestionAddress.IPV4 or the
EPPSuggestionAddress.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 |
setType(short aType)
Sets the type of the address name to either the EPPSuggestionAddress.IPV4 or the
EPPSuggestionAddress.IPV6 constant. |
java.lang.String |
toLogString()
Address as string for log purpose. |
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 EPPSuggestionAddress()
EPPSuggestionAddress
. The name
attribute defaults to null
and must be set using
setName
before invoking encode
. The type
defaults to IPV4.
public EPPSuggestionAddress(java.lang.String aName)
EPPSuggestionAddress
that the takes the
string name of the IP address with the type set to IPV4
.
aName
- IP address name.public EPPSuggestionAddress(java.lang.String aName, short aType)
EPPSuggestionAddress
that the takes the
string name of the IP address along with the type of the IP address using
either the constant EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
.
aName
- IP address name.aType
- EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
constant.Method Detail |
---|
public 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 EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
, and the address name should
conform to the format of the type.
aName
- address nameaType
- address type ((EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
)public short getType()
EPPSuggestionAddress.IPV4
or the
EPPSuggestionAddress.IPV6
constant.
EPPSuggestionAddress.IPV4
or
EPPSuggestionAddress.IPV6
)public void setType(short aType)
EPPSuggestionAddress.IPV4
or the
EPPSuggestionAddress.IPV6
constant.
aType
- IPV4
or IPV6
public java.lang.String toLogString()
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPCodecComponent
EPPCommand
is
created and is used to append the attribute nodes of
EPPCommand
.
encode
in interface EPPCodecComponent
aDocument
- DOM document used as a factory of DOM objects.
EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPCodecComponent
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values. EPPCommand
is
passed into decode
of EPPCommand to be decoded and
used to set the instance attributes.
decode
in interface EPPCodecComponent
aElement
- root DOM element associated with instance
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
equals
in class java.lang.Object
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
EPPCodecComponent
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPCodecComponent
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 |