de.gerdiproject.json.datacite

Class Title

java.lang.Object

de.gerdiproject.json.datacite.Title

All Implemented Interfaces:

ICleanable

public class Title
extends Object
implements ICleanable

A name or title by which a resource is known. 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
Title(@NonNull String value)
Title(@NonNull String value, TitleType type, String lang)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	clean() Cleans the object, making it compatible with the ElasticSearch index.
boolean	equals(Object o)
String	getLang() Retrieves the IETF language tag describing the language of the title text.
TitleType	getType() Retrieves the type of Title.
@NonNull String	getValue() Retrieves the free text title or name.
int	hashCode()
void	setLang(String lang) Sets the IETF language tag describing the language of the title text.
void	setType(TitleType type) Sets the type of Title.
void	setValue(@NonNull String value) Sets the free text title or name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Title

public Title(@NonNull
             @NonNull String value)

Title

public Title(@NonNull
             @NonNull String value,
             TitleType type,
             String lang)

Method Detail

clean

public boolean clean()

Description copied from interface: ICleanable

Cleans the object, making it compatible with the ElasticSearch index.

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 text title or name.
e.g. Crops, Catch Value in the Atlantic Ocean

Returns:

the free text title or name

getType

public TitleType getType()

Retrieves the type of Title.

Returns:

the type of Title

getLang

public String getLang()

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

Returns:

the IETF language tag describing the language of the title text

setValue

public void setValue(@NonNull
                     @NonNull String value)

Sets the free text title or name.
e.g. Crops, Catch Value in the Atlantic Ocean

Parameters:

value - a free text title or name

setType

public void setType(TitleType type)

Sets the type of Title.

Parameters:

type - the type of Title

setLang

public void setLang(String lang)

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

Parameters:

lang - the IETF language tag describing the language of the title 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