Package org.apache.tools.ant.types
Class EnumeratedAttribute
java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
- Direct Known Subclasses:
- AggregateTransformer.Format,- Arc.ArcType,- Available.FileDir,- CharSet,- Checksum.FormatElement,- Comparison,- Definer.Format,- Definer.OnError,- EchoProperties.FormatAttribute,- EchoXML.NamespacePolicy,- EjbJar.CMPVersion,- EjbJar.NamingScheme,- EmailTask.Encoding,- ExecuteOn.FileDirBoth,- FilterSet.OnMissing,- FixCRLF.AddAsisRemove,- FixCRLF.CrLf,- FixCrLfFilter.AddAsisRemove,- FixCrLfFilter.CrLf,- ForkDefinition.ForkMode,- FormatterElement.TypeAttribute,- FTP.Action,- FTP.FTPSystemType,- FTP.Granularity,- FTP.LanguageCode,- FTPTask.Action,- FTPTask.FTPSystemType,- FTPTask.Granularity,- ImageIOTask.ImageFormat,- Input.HandlerType,- IsLastModified.CompareMode,- Jar.FilesetManifestConfig,- Jar.StrictMode,- Javadoc.AccessType,- JDependTask.FormatAttribute,- Jmod.ResolutionWarningReason,- JUnitTask.ForkMode,- JUnitTask.SummaryAttribute,- Length.FileMode,- Link.CompressionLevel,- Link.Endianness,- Link.VMType,- ListenerDefinition.ListenerType,- LogLevel,- ManifestTask.Mode,- Mapper.MapperType,- ModifiedSelector.AlgorithmName,- ModifiedSelector.CacheName,- ModifiedSelector.ComparatorName,- MSVSS.CurrentModUpdated,- MSVSS.WritableFiles,- MSVSSHISTORY.BriefCodediffNofile,- NetRexxC.TraceAttr,- NetRexxC.VerboseAttr,- PathConvert.TargetOs,- PresentSelector.FilePresence,- PropertyFile.Entry.Operation,- PropertyFile.Entry.Type,- PropertyFile.Unit,- PropertySet.BuiltinPropertySetName,- Quantifier,- Recorder.ActionChoices,- Scale.ProportionsAttribute,- Scale.ProportionsAttribute,- SizeSelector.ByteUnits,- SQLExec.DelimiterType,- SQLExec.OnError,- Tar.TarCompressionMethod,- Tar.TarLongFileMode,- TimeComparison,- Tstamp.Unit,- Type.FileDir,- TypeSelector.FileType,- Untar.UntarCompressionMethod,- WaitFor.Unit,- Zip.Duplicate,- Zip.UnicodeExtraField,- Zip.WhenEmpty,- Zip.Zip64ModeAttribute
Helper class for attributes that can only take one of a fixed list
 of values.
 
See FixCRLF for an
 example.
- 
Field SummaryFields
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionfinal booleancontainsValue(String value) Is this value included in the enumeration?final intgetIndex()static EnumeratedAttributegetInstance(Class<? extends EnumeratedAttribute> clazz, String value) Factory method for instantiating EAs via API in a more developer friendly way.final StringgetValue()abstract String[]This is the only method a subclass needs to implement.final intindexOfValue(String value) get the index of a value in this enumeration.voidInvoked byIntrospectionHelper.toString()Convert the value to its string form.
- 
Field Details- 
valueThe selected value in this enumeration.
 
- 
- 
Constructor Details- 
EnumeratedAttributeprotected EnumeratedAttribute()bean constructor
 
- 
- 
Method Details- 
getValuesThis is the only method a subclass needs to implement.- Returns:
- an array holding all possible values of the enumeration.
 The order of elements must be fixed so that indexOfValue(String)always return the same index for the same value.
 
- 
getInstancepublic static EnumeratedAttribute getInstance(Class<? extends EnumeratedAttribute> clazz, String value) throws BuildException Factory method for instantiating EAs via API in a more developer friendly way.- Parameters:
- clazz- Class, extending EA, which to instantiate
- value- The value to set on that EA
- Returns:
- Configured EA
- Throws:
- BuildException- If the class could not be found or the value is not valid for the given EA-class.
- See Also:
 
- 
setValueInvoked byIntrospectionHelper.- Parameters:
- value- the- Stringvalue of the attribute
- Throws:
- BuildException- if the value is not valid for the attribute
 
- 
containsValueIs this value included in the enumeration?- Parameters:
- value- the- Stringvalue to look up
- Returns:
- true if the value is valid
 
- 
indexOfValueget the index of a value in this enumeration.- Parameters:
- value- the string value to look for.
- Returns:
- the index of the value in the array of strings or -1 if it cannot be found.
- See Also:
 
- 
getValue- Returns:
- the selected value.
 
- 
getIndexpublic final int getIndex()- Returns:
- the index of the selected value in the array.
- See Also:
 
- 
toStringConvert the value to its string form.
 
-