com.io7m.smfj.core

Class SMFFormatDescription

java.lang.Object

com.io7m.smfj.core.SMFFormatDescription

All Implemented Interfaces:

SMFFormatDescriptionType

@Generated(value={"Immutables.generator","SMFFormatDescriptionType"})
public final class SMFFormatDescription
extends Object
implements SMFFormatDescriptionType

A description of a format.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SMFFormatDescription.Builder	builder() Creates a builder for SMFFormatDescription.
static SMFFormatDescription	copyOf(SMFFormatDescriptionType instance) Creates an immutable copy of a SMFFormatDescriptionType value.
String	description()
boolean	equals(Object another) This instance is equal to all instances of SMFFormatDescription that have equal attribute values.
int	hashCode() Computes a hash code from attributes: description, suffix, mimeType, name, randomAccess.
String	mimeType()
String	name()
boolean	randomAccess()
String	suffix()
String	toString() Prints the immutable value SMFFormatDescription with attribute values.
SMFFormatDescription	withDescription(String value) Copy the current immutable object by setting a value for the description attribute.
SMFFormatDescription	withMimeType(String value) Copy the current immutable object by setting a value for the mimeType attribute.
SMFFormatDescription	withName(String value) Copy the current immutable object by setting a value for the name attribute.
SMFFormatDescription	withRandomAccess(boolean value) Copy the current immutable object by setting a value for the randomAccess attribute.
SMFFormatDescription	withSuffix(String value) Copy the current immutable object by setting a value for the suffix attribute.

Methods inherited from class java.lang.Object

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

Method Detail

description

public String description()

Specified by:

description in interface SMFFormatDescriptionType

Returns:

A human-readable description of the format

suffix

public String suffix()

Specified by:

suffix in interface SMFFormatDescriptionType

Returns:

The filename suffix used for the format

mimeType

public String mimeType()

Specified by:

mimeType in interface SMFFormatDescriptionType

Returns:

The mime type for the format

name

public String name()

Specified by:

name in interface SMFFormatDescriptionType

Returns:

The unique name for the format

randomAccess

public boolean randomAccess()

Specified by:

randomAccess in interface SMFFormatDescriptionType

Returns:

true iff the format supports random access

withDescription

public final SMFFormatDescription withDescription(String value)

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

Parameters:

value - A new value for description

Returns:

A modified copy of the this object

withSuffix

public final SMFFormatDescription withSuffix(String value)

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

Parameters:

value - A new value for suffix

Returns:

A modified copy of the this object

withMimeType

public final SMFFormatDescription withMimeType(String value)

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

Parameters:

value - A new value for mimeType

Returns:

A modified copy of the this object

withName

public final SMFFormatDescription withName(String value)

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

Parameters:

value - A new value for name

Returns:

A modified copy of the this object

withRandomAccess

public final SMFFormatDescription withRandomAccess(boolean value)

Copy the current immutable object by setting a value for the randomAccess attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for randomAccess

Returns:

A modified copy of the this object

equals

public boolean equals(Object another)

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

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: description, suffix, mimeType, name, randomAccess.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value SMFFormatDescription with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static SMFFormatDescription copyOf(SMFFormatDescriptionType instance)

Creates an immutable copy of a SMFFormatDescriptionType 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 SMFFormatDescription instance

builder

public static SMFFormatDescription.Builder builder()

Creates a builder for SMFFormatDescription.

Returns:

A new SMFFormatDescription builder