Package com.attribyte.parser.model

Class Author

java.lang.Object

com.attribyte.parser.model.Author

public class Author
extends Object

An immutable author.

Author:

Matt Hamer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Author.Builder	Builds immutable authors.

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	A description for the author.
final String	displayName	An author name for display.
final String	email	The author email or an empty string if none.
final String	id	The unique id or an empty string if none.
final Image	image	An image for the author.
final String	link	The author link or an empty string if none.
final String	name	The author name.

Method Summary

Modifier and Type	Method	Description
static Author.Builder	builder(Author author)	Creates a builder populated from an existing author.
static Author.Builder	builder(String name)	Creates a builder.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

id

public final String id

The unique id or an empty string if none.

name

public final String name

The author name. Never null or empty.

email

public final String email

The author email or an empty string if none.

link

public final String link

The author link or an empty string if none.

displayName

public final String displayName

An author name for display.

description

public final String description

A description for the author.

image

public final Image image

An image for the author.

Method Details

builder

public static Author.Builder builder(String name)
                              throws UnsupportedOperationException

Creates a builder.

Parameters:

name - The (required) name for the author.

Returns:

The builder.

Throws:

UnsupportedOperationException - If name is null or empty.

builder

public static Author.Builder builder(Author author)

Creates a builder populated from an existing author.

Parameters:

author - The author.

Returns:

The builder.

toString

public String toString()

Overrides:

toString in class Object