de.gerdiproject.json.datacite

Class Description

java.lang.Object

de.gerdiproject.json.datacite.Description

All Implemented Interfaces:

ICleanable

public class Description
extends Object
implements ICleanable

Additional information that does not fit in any of the other categories. May be used for technical information. NOTE: The DataCite schema allows br-tags here, which are not supported by Elastic Search and should be replaced with \n! Source: https://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf

Author:

Mathis Neumann, Robin Weiss

Constructor Summary

Constructors

Constructor and Description
Description(@NonNull String value, DescriptionType type)
Description(@NonNull String value, DescriptionType type, String lang)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	clean() Cleans the description text, removing HTML and unescaping special characters.
boolean	equals(Object o)
String	getLang() Retrieves the IETF language tag of the description text.
DescriptionType	getType() Retrieves the type that outlines what the description entails.
@NonNull String	getValue() Retrieves the free descriptive text.
int	hashCode()
void	setLang(String lang) Sets the IETF language tag of the description text.
void	setValue(@NonNull String value) Sets the free descriptive text.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description(@NonNull
                   @NonNull String value,
                   DescriptionType type)

Description

public Description(@NonNull
                   @NonNull String value,
                   DescriptionType type,
                   String lang)

Method Detail

clean

public boolean clean()

Cleans the description text, removing HTML and unescaping special characters.

Specified by:

clean in interface ICleanable

Returns:

true if the clean up was successful and the object is now valid

getValue

@NonNull
public @NonNull String getValue()

Retrieves the free descriptive text.

Returns:

the free descriptive text

getType

public DescriptionType getType()

Retrieves the type that outlines what the description entails.

Returns:

the type that outlines what the description entails

getLang

public String getLang()

Retrieves the IETF language tag of the description text.
e.g. de, en-US

Returns:

the IETF language tag of the description text

setValue

public void setValue(@NonNull
                     @NonNull String value)

Sets the free descriptive text.

Parameters:

value - free descriptive text

setLang

public void setLang(String lang)

Sets the IETF language tag of the description text.
e.g. de, en-US

Parameters:

lang - the IETF language tag of the description text

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object