Module io.jenetics.jpx

Package io.jenetics.jpx

Class Copyright

java.lang.Object

io.jenetics.jpx.Copyright

All Implemented Interfaces:

Serializable

public final class Copyright
extends Object
implements Serializable

Information about the copyright holder and any license governing use of this file. By linking to an appropriate license, you may place your data into the public domain or grant additional usage rights.

Since:

1.0

Version:

1.2

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAuthor()	Return the copyright holder.
Optional<URI>	getLicense()	Return the link to external file containing license text.
Optional<Year>	getYear()	Return the year of copyright.
int	hashCode()
static Copyright	of(String author)	Create a new Copyright object with the given data.
static Copyright	of(String author, int year)	Create a new Copyright object with the given data.
static Copyright	of(String author, int year, String license)	Create a new Copyright object with the given data.
static Copyright	of(String author, int year, URI license)	Create a new Copyright object with the given data.
static Copyright	of(String author, URI license)	Create a new Copyright object with the given data.
static Copyright	of(String author, Year year)	Create a new Copyright object with the given data.
static Copyright	of(String author, Year year, URI license)	Create a new Copyright object with the given data.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getAuthor

public String getAuthor()

Return the copyright holder.

Returns:

the copyright holder

getYear

public Optional<Year> getYear()

Return the year of copyright.

Returns:

the year of copyright

getLicense

public Optional<URI> getLicense()

Return the link to external file containing license text.

Returns:

link to external file containing license text

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static Copyright of(String author,
 Year year,
 URI license)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

year - year of copyright.

license - link to external file containing license text.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

of

public static Copyright of(String author,
 int year,
 URI license)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

year - year of copyright.

license - link to external file containing license text.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

DateTimeException - if the given year is invalid

of

public static Copyright of(String author,
 int year,
 String license)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

year - year of copyright.

license - link to external file containing license text.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

IllegalArgumentException - if the given license is not a valid URI object

DateTimeException - if the given year is invalid

of

public static Copyright of(String author,
 Year year)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

year - year of copyright.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

of

public static Copyright of(String author,
 int year)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

year - year of copyright.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

DateTimeException - if the given year is invalid

of

public static Copyright of(String author,
 URI license)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

license - link to external file containing license text.

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null

of

public static Copyright of(String author)

Create a new Copyright object with the given data.

Parameters:

author - copyright holder (TopoSoft, Inc.)

Returns:

a new Copyright object with the given data

Throws:

NullPointerException - if the author is null