com.helger.pd.businesscard.generic

Class PDName

java.lang.Object

com.helger.pd.businesscard.generic.PDName

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<PDName>, com.helger.json.IHasJson, Serializable

@NotThreadSafe
public class PDName
extends Object
implements com.helger.json.IHasJson, Serializable, com.helger.commons.lang.ICloneable<PDName>

Generic name.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDName()
PDName(String sName)
PDName(String sName, String sLanguageCode)

Method Summary

Modifier and Type	Method and Description
void	cloneTo(PDName ret) This method clones all values from this to the passed object.
boolean	equals(Object o)
com.helger.json.IJsonObject	getAsJson()
com.helger.xml.microdom.IMicroElement	getAsMicroXML(String sNamespaceURI, String sElementName)
PDName	getClone()
String	getLanguageCode()
String	getName()
int	hashCode()
boolean	hasNoLanguageCode()
static boolean	isValidLanguageCode(String s)
static PDName	of(com.helger.json.IJsonObject aJson)
PDName	setLanguageCode(String sLanguageCode) Set the language code to use.
PDName	setName(String sName) Set the name itself.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PDName

public PDName()

PDName

public PDName(@Nonnull @Nonempty
              String sName)

PDName

public PDName(@Nonnull @Nonempty
              String sName,
              @Nullable
              String sLanguageCode)

Method Detail

isValidLanguageCode

public static boolean isValidLanguageCode(@Nullable
                                          String s)

getName

@Nonnull
 @Nonempty
public final String getName()

Returns:

The name. May neither be null nor empty.

setName

@Nonnull
public final PDName setName(@Nonnull @Nonempty
                                      String sName)

Set the name itself.

Parameters:

sName - The name to use. May neither be null nor empty.

Returns:

this for chaining

getLanguageCode

@Nullable
public final String getLanguageCode()

Returns:

The language code. May be null.

hasNoLanguageCode

public final boolean hasNoLanguageCode()

setLanguageCode

@Nonnull
public final PDName setLanguageCode(@Nullable
                                              String sLanguageCode)

Set the language code to use.

Parameters:

sLanguageCode - The language code to use. May be null. If non-null it must be syntactically a valid lanaguage code.

Returns:

this for chaining

See Also:

isValidLanguageCode(String)

cloneTo

public void cloneTo(@Nonnull
                    PDName ret)

This method clones all values from this to the passed object. All data in the parameter object is overwritten!

Parameters:

ret - The target object to clone to. May not be null.

getClone

@Nonnull
 @ReturnsMutableCopy
public PDName getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<PDName>

getAsMicroXML

@Nonnull
public com.helger.xml.microdom.IMicroElement getAsMicroXML(@Nullable
                                                                     String sNamespaceURI,
                                                                     @Nonnull @Nonempty
                                                                     String sElementName)

getAsJson

@Nonnull
public com.helger.json.IJsonObject getAsJson()

Specified by:

getAsJson in interface com.helger.json.IHasJson

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

of

@Nullable
public static PDName of(@Nullable
                                   com.helger.json.IJsonObject aJson)