org.springframework.xd.dirt.server.options

Class ResourcePatternScanningOptionHandler

java.lang.Object

org.kohsuke.args4j.spi.OptionHandler<java.lang.String>

org.springframework.xd.dirt.server.options.ResourcePatternScanningOptionHandler

Direct Known Subclasses:

ResourcePatternScanningOptionHandlers.DistributedAnalyticsOptionHandler, ResourcePatternScanningOptionHandlers.HadoopDistroOptionHandler, ResourcePatternScanningOptionHandlers.SingleNodeAnalyticsOptionHandler, ResourcePatternScanningOptionHandlers.SingleNodeDataTransportOptionHandler

public abstract class ResourcePatternScanningOptionHandler
extends org.kohsuke.args4j.spi.OptionHandler<java.lang.String>

An OptionHandler that scans a resource pattern for existing resources (using a single '*' wildcard) and allows all String values s that would fit if that single wildcard was replaced by s.

Given that an option handler has to appear as an annotation parameter, expected usage is to sublcass this class, provide the canonical 3 arg constructor to OptionHandler and pass the resource pattern as the 4th argument.

Author:

Eric Bottard

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<java.lang.String>	possibleValues

Fields inherited from class org.kohsuke.args4j.spi.OptionHandler

option, owner, setter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResourcePatternScanningOptionHandler(org.kohsuke.args4j.CmdLineParser parser, org.kohsuke.args4j.OptionDef option, org.kohsuke.args4j.spi.Setter<java.lang.String> setter, java.lang.String glob)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	exclude(java.lang.String... excludes)
java.lang.String	getDefaultMetaVariable()
protected void	include(java.lang.String... includes)
int	parseArguments(org.kohsuke.args4j.spi.Parameters params)
protected boolean	shouldConsider(org.springframework.core.io.Resource r) Whether the matched Spring resource should even be considered for inclusion in the result set.

Methods inherited from class org.kohsuke.args4j.spi.OptionHandler

getMetaVariable, getNameAndMeta

Methods inherited from class java.lang.Object

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

Field Detail

possibleValues

protected final java.util.Set<java.lang.String> possibleValues

Constructor Detail

ResourcePatternScanningOptionHandler

protected ResourcePatternScanningOptionHandler(org.kohsuke.args4j.CmdLineParser parser,
                                    org.kohsuke.args4j.OptionDef option,
                                    org.kohsuke.args4j.spi.Setter<java.lang.String> setter,
                                    java.lang.String glob)
                                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

parseArguments

public int parseArguments(org.kohsuke.args4j.spi.Parameters params)
                   throws org.kohsuke.args4j.CmdLineException

Specified by:

parseArguments in class org.kohsuke.args4j.spi.OptionHandler<java.lang.String>

Throws:

org.kohsuke.args4j.CmdLineException

getDefaultMetaVariable

public java.lang.String getDefaultMetaVariable()

Specified by:

getDefaultMetaVariable in class org.kohsuke.args4j.spi.OptionHandler<java.lang.String>

shouldConsider

protected boolean shouldConsider(org.springframework.core.io.Resource r)

Whether the matched Spring resource should even be considered for inclusion in the result set. Default implementation just returns true.

exclude

protected void exclude(java.lang.String... excludes)

include

protected void include(java.lang.String... includes)