public interface Bundler
Modifier and Type | Method and Description |
---|---|
java.io.File |
execute(java.util.Map<java.lang.String,? super java.lang.Object> params,
java.io.File outputParentDir)
Creates a bundle from existing content.
|
java.util.Collection<BundlerParamInfo<?>> |
getBundleParameters()
The parameters that this bundler uses to generate it's bundle.
|
java.lang.String |
getBundleType() |
java.lang.String |
getDescription() |
java.lang.String |
getID() |
java.lang.String |
getName() |
boolean |
validate(java.util.Map<java.lang.String,? super java.lang.Object> params)
Determines if this bundler will execute with the given parameters.
|
java.lang.String getName()
java.lang.String getDescription()
java.lang.String getID()
java.lang.String getBundleType()
java.util.Collection<BundlerParamInfo<?>> getBundleParameters()
boolean validate(java.util.Map<java.lang.String,? super java.lang.Object> params) throws UnsupportedPlatformException, ConfigException
params
- The parameters to be validate. Validation may modify
the map, so if you are going to be using the same map
across multiple bundlers you should pass in a deep copy.UnsupportedPlatformException
- If the bundler cannot run on this
platform (i.e. creating mac apps on windows)ConfigException
- If the configuration params are incorrect. The
exception may contain advice on how to modify the params map
to make it valid.java.io.File execute(java.util.Map<java.lang.String,? super java.lang.Object> params, java.io.File outputParentDir)
validate(java.util.Map)
date} returns true with the
parameters map, then you can expect a valid output. However if an exception
was thrown out of validate or it returned false then you should not
expect sensible results from this call. It may or may not return a value,
and it may or may not throw an exception. But any output should not
be considered valid or sane.params
- The parameters as specified by getBundleParameters.
Keyed by the id from the ParamInfo. Execution may
modify the map, so if you are going to be using the
same map across multiple bundlers you should pass
in a deep copy.outputParentDir
- The parent dir that the returned bundle will be placed in.java.lang.IllegalArgumentException
- for any of the following
reasons: