Cytoscape 2.8.0 API

org.cytoscape.equations
Class ArgDescriptor

java.lang.Object
  extended by org.cytoscape.equations.ArgDescriptor

public class ArgDescriptor
extends Object

A class describing a function argument.


Constructor Summary
ArgDescriptor(ArgType argType, String argName, String description)
           
 
Method Summary
 boolean acceptsMultipleArgs()
           
 String getArgName()
           
 ArgType getArgType()
           
 Class[] getCompatibleTypes()
           
 String getDescription()
           
 boolean isCompatibleWith(Class type)
           
 boolean isOptional()
           
 
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)
Method Detail

getArgType

public ArgType getArgType()

getArgName

public String getArgName()

getDescription

public String getDescription()

isOptional

public boolean isOptional()

isCompatibleWith

public boolean isCompatibleWith(Class type)

getCompatibleTypes

public Class[] getCompatibleTypes()
Returns:
the types that are compatible with this argument

acceptsMultipleArgs

public boolean acceptsMultipleArgs()

Cytoscape 2.8.0 API

Copyright 2010 Cytoscape Consortium. All rights reserved.