Enum Class ArgType

java.lang.Object
java.lang.Enum<ArgType>
org.cytoscape.equations.ArgType
All Implemented Interfaces:
Serializable, Comparable<ArgType>, java.lang.constant.Constable

public enum ArgType extends Enum<ArgType>
An enum specifying a function argument type.

Cytoscape Backwards Compatibility (Enum): This class is an enum therefore can't be extended by users. This means that we may add methods or enum values for minor version updates. Methods or enum values will only be removed for major version updates.

Module: equations-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>equations-api</artifactId>
</dependency>
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Any scalar argument.
    One or more lists with arbitrary member element types and/or one or more scalars.
    An argument that can be converted to a boolean.
    An non-empty sequence of arguments that consist of lists of booleans and scalars that can be converted to a boolean.
    An argument that can be converted to a floating point value.
    An non-empty sequence of arguments that consist of lists of floating point numbers and scalars that can be converted to a floating point number.
    An argument that can be converted to an integer.
    An non-empty sequence of arguments that consist of lists of integers and scalars that can be converted to an integer.
    Zero or more lists with arbitrary member element types and/or zero or more scalars.
    An optional boolean argument.
    Zero or more arguments that consist of lists of booleans and scalars that can be converted to a boolean.
    An optional floating point argument.
    Zero or more arguments that consist of lists of floating point numbers and scalars that can be converted to a floating point number.
    An optional integer argument.
    Zero or more arguments that consist of lists of integers and scalars that can be converted to an integer.
    An optional boolean argument.
    An optional floating point number argument.
    An optional integer argument.
    An optional string argument.
    An optional string argument.
    Zero or more arguments that consist of lists of strings and scalars that can be converted to a string.
    A list with arbitrary member element types.
    A single boolean argument.
    A single floating point number argument.
    A singke integer argument.
    A single string argument.
    An argument that can be converted to a string.
    An non-empty sequence of arguments that consist of lists of strings and scalars that can be converted to a string.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Returns true if this type accepts multiple args.
    Returns an array of compatible Class types.
    boolean
    Returns true if this type is optional.
    static ArgType
    Returns the enum constant of this class with the specified name.
    static ArgType[]
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

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

    • INT

      public static final ArgType INT
      An argument that can be converted to an integer.
    • FLOAT

      public static final ArgType FLOAT
      An argument that can be converted to a floating point value.
    • STRING

      public static final ArgType STRING
      An argument that can be converted to a string.
    • BOOL

      public static final ArgType BOOL
      An argument that can be converted to a boolean.
    • ANY

      public static final ArgType ANY
      Any scalar argument.
    • INTS

      public static final ArgType INTS
      An non-empty sequence of arguments that consist of lists of integers and scalars that can be converted to an integer.
    • FLOATS

      public static final ArgType FLOATS
      An non-empty sequence of arguments that consist of lists of floating point numbers and scalars that can be converted to a floating point number.
    • STRINGS

      public static final ArgType STRINGS
      An non-empty sequence of arguments that consist of lists of strings and scalars that can be converted to a string.
    • BOOLS

      public static final ArgType BOOLS
      An non-empty sequence of arguments that consist of lists of booleans and scalars that can be converted to a boolean.
    • STRICT_INT

      public static final ArgType STRICT_INT
      A singke integer argument.
    • STRICT_FLOAT

      public static final ArgType STRICT_FLOAT
      A single floating point number argument.
    • STRICT_STRING

      public static final ArgType STRICT_STRING
      A single string argument.
    • STRICT_BOOL

      public static final ArgType STRICT_BOOL
      A single boolean argument.
    • OPT_INT

      public static final ArgType OPT_INT
      An optional integer argument.
    • OPT_FLOAT

      public static final ArgType OPT_FLOAT
      An optional floating point argument.
    • OPT_STRING

      public static final ArgType OPT_STRING
      An optional string argument.
    • OPT_BOOL

      public static final ArgType OPT_BOOL
      An optional boolean argument.
    • OPT_INTS

      public static final ArgType OPT_INTS
      Zero or more arguments that consist of lists of integers and scalars that can be converted to an integer.
    • OPT_FLOATS

      public static final ArgType OPT_FLOATS
      Zero or more arguments that consist of lists of floating point numbers and scalars that can be converted to a floating point number.
    • OPT_STRINGS

      public static final ArgType OPT_STRINGS
      Zero or more arguments that consist of lists of strings and scalars that can be converted to a string.
    • OPT_BOOLS

      public static final ArgType OPT_BOOLS
      Zero or more arguments that consist of lists of booleans and scalars that can be converted to a boolean.
    • OPT_STRICT_INT

      public static final ArgType OPT_STRICT_INT
      An optional integer argument.
    • OPT_STRICT_FLOAT

      public static final ArgType OPT_STRICT_FLOAT
      An optional floating point number argument.
    • OPT_STRICT_STRING

      public static final ArgType OPT_STRICT_STRING
      An optional string argument.
    • OPT_STRICT_BOOL

      public static final ArgType OPT_STRICT_BOOL
      An optional boolean argument.
    • ANY_LIST

      public static final ArgType ANY_LIST
      One or more lists with arbitrary member element types and/or one or more scalars.
    • STRICT_ANY_LIST

      public static final ArgType STRICT_ANY_LIST
      A list with arbitrary member element types.
    • OPT_ANY_LIST

      public static final ArgType OPT_ANY_LIST
      Zero or more lists with arbitrary member element types and/or zero or more scalars.
  • Method Details

    • values

      public static ArgType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ArgType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null
    • isOptional

      public boolean isOptional()
      Returns true if this type is optional.
      Returns:
      true if this type is optional.
    • acceptsMultipleArgs

      public boolean acceptsMultipleArgs()
      Returns true if this type accepts multiple args.
      Returns:
      true if this type accepts multiple args.
    • getCompatibleTypes

      public Class[] getCompatibleTypes()
      Returns an array of compatible Class types.
      Returns:
      an array of compatible Class types.