Package org.biojava.nbio.structure.secstruc

Enum SecStrucType

  • All Implemented Interfaces:
    Serializable, Comparable<SecStrucType>
    public enum SecStrucType
extends Enum<SecStrucType>
    This enum contains all of the secondary structure types found in the DSSP output. It also contains some methods to operate with the SS types.

    When compared, the types are sorted in the declaration order of the enum, which is the DSSP preference of type assignment.

    Author:
    Andreas Prlic, Aleix Lafita

    • Method Detail

      • values

        public static SecStrucType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (SecStrucType c : SecStrucType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SecStrucType valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • fromCharacter

        public static SecStrucType fromCharacter​(Character stype)
        Converts a Character representing a Secondary Structure type into the corresponding enum object.
        Parameters:
        stype - the character representing the SS type
        Returns:
        SecStrucType or null if the character is invalid

      • isHelixType

        public boolean isHelixType()
        Helix type can be 3-10 helix, pi-helix or alpha-helix.
        Returns:
        true if the type is any of the helix types, false otherwise

      • isBetaStrand

        public boolean isBetaStrand()
        A Beta-Strand is an extended set of sequential Bridges that, together with other Beta-Strands, is part of a Beta-Sheet.
        Returns:
        true if the type is a Beta-Strand