Package pl.poznan.put.pdb.analysis

Class ImmutablePdbChain

java.lang.Object
pl.poznan.put.pdb.analysis.PdbChain
pl.poznan.put.pdb.analysis.ImmutablePdbChain
All Implemented Interfaces:
Serializable, Comparable<PdbChain>, ResidueCollection, SingleTypedResidueCollection
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable public final class ImmutablePdbChain extends PdbChain
Immutable implementation of PdbChain.

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

See Also:

  • Method Details

    • identifier

      public String identifier()
      Specified by:
      identifier in class PdbChain
      Returns:
      The chain identifier.

    • residues

      public List<PdbResidue> residues()
      Specified by:
      residues in interface ResidueCollection
      Specified by:
      residues in class PdbChain
      Returns:
      The value of the residues attribute

    • withIdentifier

      public final ImmutablePdbChain withIdentifier(String value)
      Copy the current immutable object by setting a value for the identifier attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for identifier
      Returns:
      A modified copy of the this object

    • withResidues

      public final ImmutablePdbChain 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 ImmutablePdbChain 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 ImmutablePdbChain 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: identifier, residues.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value PdbChain with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • of

      public static ImmutablePdbChain of(String identifier, List<PdbResidue> residues)
      Construct a new immutable PdbChain instance.
      Parameters:
      identifier - The value for the identifier attribute
      residues - The value for the residues attribute
      Returns:
      An immutable PdbChain instance

    • of

      public static ImmutablePdbChain of(String identifier, Iterable<? extends PdbResidue> residues)
      Construct a new immutable PdbChain instance.
      Parameters:
      identifier - The value for the identifier attribute
      residues - The value for the residues attribute
      Returns:
      An immutable PdbChain instance

    • copyOf

      public static ImmutablePdbChain copyOf(PdbChain instance)
      Creates an immutable copy of a PdbChain 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 PdbChain instance

    • builder

      public static ImmutablePdbChain.Builder builder()
      Creates a builder for ImmutablePdbChain. 
       ImmutablePdbChain.builder()
    .identifier(String) // required identifier
    .addResidues|addAllResidues(pl.poznan.put.pdb.analysis.PdbResidue) // residues elements
    .build();
      Returns:
      A new ImmutablePdbChain builder