Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.oodt.commons.option
Class CmdLineOption

java.lang.Object
  extended by org.apache.oodt.commons.option.CmdLineOption
All Implemented Interfaces:
java.lang.Comparable<CmdLineOption>, SpringSetIdInjectionType
public class CmdLineOption
extends java.lang.Object
implements java.lang.Comparable<CmdLineOption>, SpringSetIdInjectionType

Version:
$Revision$

Describe your class here

Author:
bfoster

Constructor Summary
CmdLineOption()
           
CmdLineOption(java.lang.String shortOption, java.lang.String longOption, java.lang.String description, boolean hasArgs)
           
 
Method Summary
 int compareTo(CmdLineOption cmdLineOption)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getDescription()
           
 CmdLineOptionHandler getHandler()
           
 java.lang.String getId()
          Get a unique String id that represents this objects instance
 java.lang.String getLongOption()
           
 java.lang.String getOptionArgName()
           
 java.util.List<RequiredOption> getRequiredOptions()
           
 java.lang.String getShortOption()
           
 java.lang.Class<?> getType()
           
 java.util.List<CmdLineOptionValidator> getValidators()
           
 boolean hasArgs()
           
 boolean isPerformAndQuit()
           
 boolean isRequired()
           
 void setDescription(java.lang.String description)
           
 void setHandler(CmdLineOptionHandler handler)
           
 void setHasArgs(boolean hasArgs)
           
 void setId(java.lang.String id)
          Set a unique id that represents this objects instance
 void setLongOption(java.lang.String longOption)
           
 void setOptionArgName(java.lang.String optionArgName)
           
 void setPerformAndQuit(boolean performAndQuit)
           
 void setRequired(boolean required)
           
 void setRequiredOptions(java.util.List<RequiredOption> requiredOptions)
           
 void setShortOption(java.lang.String shortOption)
           
 void setType(java.lang.Class<?> type)
           
 void setValidators(java.util.List<CmdLineOptionValidator> validators)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CmdLineOption

public CmdLineOption()

CmdLineOption

public CmdLineOption(java.lang.String shortOption,
                     java.lang.String longOption,
                     java.lang.String description,
                     boolean hasArgs)
Method Detail

getType

public java.lang.Class<?> getType()

setType

public void setType(java.lang.Class<?> type)

getId

public java.lang.String getId()
Description copied from interface: SpringSetIdInjectionType
Get a unique String id that represents this objects instance

Specified by:
getId in interface SpringSetIdInjectionType
Returns:
Unique String id

setId

public void setId(java.lang.String id)
Description copied from interface: SpringSetIdInjectionType
Set a unique id that represents this objects instance

Specified by:
setId in interface SpringSetIdInjectionType
Parameters:
id - Unique String id

setHandler

public void setHandler(CmdLineOptionHandler handler)

getHandler

public CmdLineOptionHandler getHandler()

getValidators

public java.util.List<CmdLineOptionValidator> getValidators()

setValidators

public void setValidators(java.util.List<CmdLineOptionValidator> validators)

getShortOption

public java.lang.String getShortOption()

setShortOption

public void setShortOption(java.lang.String shortOption)

getLongOption

public java.lang.String getLongOption()

setLongOption

public void setLongOption(java.lang.String longOption)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

hasArgs

public boolean hasArgs()

setHasArgs

public void setHasArgs(boolean hasArgs)

setOptionArgName

public void setOptionArgName(java.lang.String optionArgName)

getOptionArgName

public java.lang.String getOptionArgName()

setRequired

public void setRequired(boolean required)

isRequired

public boolean isRequired()

getRequiredOptions

public java.util.List<RequiredOption> getRequiredOptions()

setRequiredOptions

public void setRequiredOptions(java.util.List<RequiredOption> requiredOptions)

isPerformAndQuit

public boolean isPerformAndQuit()

setPerformAndQuit

public void setPerformAndQuit(boolean performAndQuit)

compareTo

public int compareTo(CmdLineOption cmdLineOption)
Specified by:
compareTo in interface java.lang.Comparable<CmdLineOption>

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 1999-2011 Apache OODT. All Rights Reserved.