public static interface Extension.Parameter extends PluginElement<Extension.Parameter>
Modifier and Type | Method and Description |
---|---|
Extension |
getDeclaringExtension() |
ExtensionPoint.ParameterDefinition |
getDefinition()
Returns definition for this extension parameter.
|
Extension.Parameter |
getSubParameter(String id)
Returns sub-parameter with given ID or
null if no
sub-parameters exist. |
Collection<Extension.Parameter> |
getSubParameters()
Returns collection of all sub-parameters defined in this parameter.
|
Collection<Extension.Parameter> |
getSubParameters(String id) |
Extension.Parameter |
getSuperParameter() |
String |
rawValue() |
Boolean |
valueAsBoolean()
Returns "typed" value of parameter.
|
Date |
valueAsDate()
Returns "typed" value of parameter.
|
Extension |
valueAsExtension()
Returns "typed" value of parameter.
|
ExtensionPoint |
valueAsExtensionPoint()
Returns "typed" value of parameter.
|
Number |
valueAsNumber()
Returns "typed" value of parameter.
|
PluginDescriptor |
valueAsPluginDescriptor()
Returns "typed" value of parameter.
|
String |
valueAsString()
Returns "typed" value of parameter.
|
URL |
valueAsUrl()
Returns "typed" value of parameter.
|
URL |
valueAsUrl(PathResolver pathResolver)
Returns "typed" value of parameter.
|
getDeclaringPluginDescriptor, getDeclaringPluginFragment
getDocsPath, getDocumentation
String rawValue()
Collection<Extension.Parameter> getSubParameters()
Extension.Parameter
objectsExtension.Parameter getSubParameter(String id)
null
if no
sub-parameters exist. If more than one sub-parameters with given ID
found, the method should throw an IllegalArgumentException
.id
- ID of sub-parameter to look forCollection<Extension.Parameter> getSubParameters(String id)
id
- ID of sub-parameter to look forExtension getDeclaringExtension()
ExtensionPoint.ParameterDefinition getDefinition()
null
for "invalid" parameters.null
, if this parameter
is "invalid"Extension.Parameter getSuperParameter()
null
if
this is top level parameterString valueAsString()
ParameterType.STRING
, this method
should throw an UnsupportedOperationException
.Boolean valueAsBoolean()
ParameterType.BOOLEAN
, this method
should throw an UnsupportedOperationException
.Number valueAsNumber()
ParameterType.NUMBER
, this method
should throw an UnsupportedOperationException
.Date valueAsDate()
ParameterType.DATE
, ParameterType.TIME
or ParameterType.DATE_TIME
, this method should throw an
UnsupportedOperationException
.PluginDescriptor valueAsPluginDescriptor()
ParameterType.PLUGIN_ID
, this
method should throw an UnsupportedOperationException
.ExtensionPoint valueAsExtensionPoint()
ParameterType.EXTENSION_POINT_ID
,
this method should throw an UnsupportedOperationException
.Extension valueAsExtension()
ParameterType.EXTENSION_ID
, this
method should throw an UnsupportedOperationException
.URL valueAsUrl()
ParameterType.RESOURCE
, this
method should throw an UnsupportedOperationException
.URL valueAsUrl(PathResolver pathResolver)
ParameterType.RESOURCE
, this
method should throw an UnsupportedOperationException
.pathResolver
- path resolver to make URL absoluteCopyright © 2015. All rights reserved.