Package pl.poznan.put.pdb.analysis

Class ImmutableDefaultResidueCollection

java.lang.Object

pl.poznan.put.pdb.analysis.DefaultResidueCollection

pl.poznan.put.pdb.analysis.ImmutableDefaultResidueCollection

All Implemented Interfaces:

Serializable, ResidueCollection

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
public final class ImmutableDefaultResidueCollection
extends DefaultResidueCollection

Immutable implementation of DefaultResidueCollection.

Use the builder to create immutable instances: ImmutableDefaultResidueCollection.builder(). Use the static factory method to create immutable instances: ImmutableDefaultResidueCollection.of().

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ImmutableDefaultResidueCollection.Builder	builder()	Creates a builder for ImmutableDefaultResidueCollection.
static ImmutableDefaultResidueCollection	copyOf(DefaultResidueCollection instance)	Creates an immutable copy of a DefaultResidueCollection value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableDefaultResidueCollection that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: residues.
static ImmutableDefaultResidueCollection	of(Iterable<? extends PdbResidue> residues)	Construct a new immutable DefaultResidueCollection instance.
static ImmutableDefaultResidueCollection	of(List<PdbResidue> residues)	Construct a new immutable DefaultResidueCollection instance.
List<PdbResidue>	residues()
String	toString()	Prints the immutable value DefaultResidueCollection with attribute values.
ImmutableDefaultResidueCollection	withResidues(Iterable<? extends PdbResidue> elements)	Copy the current immutable object with elements that replace the content of residues.
ImmutableDefaultResidueCollection	withResidues(PdbResidue... elements)	Copy the current immutable object with elements that replace the content of residues.

Methods inherited from class java.lang.Object

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

Methods inherited from interface pl.poznan.put.pdb.analysis.ResidueCollection

filteredAtoms, findBondLengthViolations, findResidue, hasResidue, indexOf, namedResidueIdentifiers, residueIdentifiers, sequence, toCif, toPdb, withoutAlternateLocations

Method Detail

residues

public List<PdbResidue> residues()

Specified by:

residues in interface ResidueCollection

Specified by:

residues in class DefaultResidueCollection

Returns:

The value of the residues attribute

withResidues

public final ImmutableDefaultResidueCollection withResidues(PdbResidue... elements)

Copy the current immutable object with elements that replace the content of residues.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withResidues

public final ImmutableDefaultResidueCollection withResidues(Iterable<? extends PdbResidue> elements)

Copy the current immutable object with elements that replace the content of residues. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of residues elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
                      Object another)

This instance is equal to all instances of ImmutableDefaultResidueCollection 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: residues.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value DefaultResidueCollection with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

of

public static ImmutableDefaultResidueCollection of(List<PdbResidue> residues)

Construct a new immutable DefaultResidueCollection instance.

Parameters:

residues - The value for the residues attribute

Returns:

An immutable DefaultResidueCollection instance

of

public static ImmutableDefaultResidueCollection of(Iterable<? extends PdbResidue> residues)

Construct a new immutable DefaultResidueCollection instance.

Parameters:

residues - The value for the residues attribute

Returns:

An immutable DefaultResidueCollection instance

copyOf

public static ImmutableDefaultResidueCollection copyOf(DefaultResidueCollection instance)

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

builder

public static ImmutableDefaultResidueCollection.Builder builder()

Creates a builder for ImmutableDefaultResidueCollection.

 ImmutableDefaultResidueCollection.builder()
    .addResidues|addAllResidues(pl.poznan.put.pdb.analysis.PdbResidue) // residues elements
    .build();
 

Returns:

A new ImmutableDefaultResidueCollection builder