Package org.cytoscape.equations

Class ArgDescriptor

java.lang.Object

org.cytoscape.equations.ArgDescriptor

public final class ArgDescriptor
extends Object

A class describing a function argument.

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>

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't be extended by users. This means that we may add methods for minor version updates. Methods will only be removed for major version updates.

Constructor Summary

Constructors

Constructor	Description
ArgDescriptor(ArgType argType, String argName, String description)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsMultipleArgs()	Returns true if this ArgDescriptor accepts multiple arguments, otherwise false.
String	getArgName()	Returns the name of the argument.
ArgType	getArgType()
Class[]	getCompatibleTypes()	Returns the types that are compatible with this argument.
String	getDescription()	Returns the description of the argument.
boolean	isCompatibleList(Class listElementType)	Returns true if "listType", which must be some type of List is a type compatible with this argument descriptor.
boolean	isCompatibleWith(Class type)	Tests to see if the specified class is compatible with this ArgType.
boolean	isOptional()	Returns whether the ArgType is optional.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArgDescriptor

public ArgDescriptor(ArgType argType,
                     String argName,
                     String description)

Parameters:

argType - The type of the argument.

argName - The name of the argument.

description - The description of the argument.

Method Detail

getArgType

public ArgType getArgType()

Returns:

The type of the argument.

getArgName

public String getArgName()

Returns the name of the argument.

Returns:

The name of the argument.

getDescription

public String getDescription()

Returns the description of the argument.

Returns:

The description of the argument.

isOptional

public boolean isOptional()

Returns whether the ArgType is optional.

Returns:

whether the ArgType is optional.

isCompatibleWith

public boolean isCompatibleWith(Class type)

Tests to see if the specified class is compatible with this ArgType.

Parameters:

type - the Class to test against this ArgType.

Returns:

true if the specified class is compatible with this ArgType.

isCompatibleList

public boolean isCompatibleList(Class listElementType)

Returns true if "listType", which must be some type of List is a type compatible with this argument descriptor.

Parameters:

listType - A type that is a subclass of List.

Returns:

true if "listType", which must be some type of List is a type compatible with this argument descriptor.

getCompatibleTypes

public Class[] getCompatibleTypes()

Returns the types that are compatible with this argument.

Returns:

the types that are compatible with this argument.

acceptsMultipleArgs

public boolean acceptsMultipleArgs()

Returns true if this ArgDescriptor accepts multiple arguments, otherwise false.

Returns:

true if this ArgDescriptor accepts multiple arguments, otherwise false.