Enum IntervalList.IntervalType

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      COALESCENT
      Denotes an interval after which a coalescent event is observed (i.e.
      MIGRATION
      Denotes an interval at the end of which a migration event occurs.
      NOTHING
      Denotes an interval at the end of which nothing is observed (i.e.
      SAMPLE
      Denotes an interval at the end of which a new sample addition is observed (i.e.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String toString()  
      static IntervalList.IntervalType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static IntervalList.IntervalType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • SAMPLE

        public static final IntervalList.IntervalType SAMPLE
        Denotes an interval at the end of which a new sample addition is observed (i.e. the number of lineages is larger in the next interval).
      • COALESCENT

        public static final IntervalList.IntervalType COALESCENT
        Denotes an interval after which a coalescent event is observed (i.e. the number of lineages is smaller in the next interval)
      • MIGRATION

        public static final IntervalList.IntervalType MIGRATION
        Denotes an interval at the end of which a migration event occurs. This means that the colour of one lineage changes.
      • NOTHING

        public static final IntervalList.IntervalType NOTHING
        Denotes an interval at the end of which nothing is observed (i.e. the number of lineages is the same in the next interval).
    • Method Detail

      • values

        public static IntervalList.IntervalType[] 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 (IntervalList.IntervalType c : IntervalList.IntervalType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static IntervalList.IntervalType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null