Package com.io7m.smfj.core

Class SMFSchemaName

java.lang.Object

com.io7m.smfj.core.SMFSchemaName

All Implemented Interfaces:

SMFSchemaNameType, java.lang.Comparable<SMFSchemaNameType>

public final class SMFSchemaName
extends java.lang.Object
implements SMFSchemaNameType

A schema name.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SMFSchemaName.Builder	Builds instances of type SMFSchemaName.

Method Summary

Modifier and Type	Method	Description
static SMFSchemaName.Builder	builder()	Creates a builder for SMFSchemaName.
static SMFSchemaName	copyOf(SMFSchemaNameType instance)	Creates an immutable copy of a SMFSchemaNameType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of SMFSchemaName that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: value.
static SMFSchemaName	of(java.lang.String value)	Construct a new immutable SMFSchemaName instance.
java.lang.String	toString()	Prints the immutable value SMFSchemaName with attribute values.
java.lang.String	value()
SMFSchemaName	withValue(java.lang.String value)	Copy the current immutable object by setting a value for the value attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.io7m.smfj.core.SMFSchemaNameType

checkPreconditions, compareTo

Method Detail

value

public java.lang.String value()

Specified by:

value in interface SMFSchemaNameType

Returns:

The actual name value

withValue

public final SMFSchemaName withValue(java.lang.String value)

Copy the current immutable object by setting a value for the value attribute. An equals check used to prevent copying of the same value by returning this.

Parameters:

value - A new value for value

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of SMFSchemaName that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: value.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value SMFSchemaName with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static SMFSchemaName of(java.lang.String value)

Construct a new immutable SMFSchemaName instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable SMFSchemaName instance

copyOf

public static SMFSchemaName copyOf(SMFSchemaNameType instance)

Creates an immutable copy of a SMFSchemaNameType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable SMFSchemaName instance

builder

public static SMFSchemaName.Builder builder()

Creates a builder for SMFSchemaName.

 SMFSchemaName.builder()
    .setValue(String) // required value
    .build();
 

Returns:

A new SMFSchemaName builder