|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.java.plugin.extension.AnnotatedParameter
public class AnnotatedParameter
Constructor Summary | |
---|---|
AnnotatedParameter(Extension extension,
PluginDescriptor plugin,
PluginFragment fragment,
java.lang.String id,
java.lang.String value,
java.lang.Class<?> type)
|
Method Summary | |
---|---|
Extension |
getDeclaringExtension()
|
PluginDescriptor |
getDeclaringPluginDescriptor()
Returns plug-in descriptor, this element belongs to. |
PluginFragment |
getDeclaringPluginFragment()
Returns descriptor of plug-in fragment that contributes this element. |
ExtensionPoint.ParameterDefinition |
getDefinition()
Returns definition for this extension parameter. |
java.lang.String |
getDocsPath()
|
Documentation<Extension.Parameter> |
getDocumentation()
|
java.lang.String |
getId()
|
Extension.Parameter |
getSubParameter(java.lang.String id)
Returns sub-parameter with given ID or null if no
sub-parameters exist. |
java.util.Collection<Extension.Parameter> |
getSubParameters()
Returns collection of all sub-parameters defined in this parameter. |
java.util.Collection<Extension.Parameter> |
getSubParameters(java.lang.String id)
|
Extension.Parameter |
getSuperParameter()
|
java.lang.String |
rawValue()
|
java.lang.String |
toString()
|
java.lang.Boolean |
valueAsBoolean()
Returns "typed" value of parameter. |
java.util.Date |
valueAsDate()
Returns "typed" value of parameter. |
Extension |
valueAsExtension()
Returns "typed" value of parameter. |
ExtensionPoint |
valueAsExtensionPoint()
Returns "typed" value of parameter. |
java.lang.Number |
valueAsNumber()
Returns "typed" value of parameter. |
PluginDescriptor |
valueAsPluginDescriptor()
Returns "typed" value of parameter. |
java.lang.String |
valueAsString()
Returns "typed" value of parameter. |
java.net.URL |
valueAsUrl()
Returns "typed" value of parameter. |
java.net.URL |
valueAsUrl(PathResolver pathResolver)
Returns "typed" value of parameter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public AnnotatedParameter(Extension extension, PluginDescriptor plugin, PluginFragment fragment, java.lang.String id, java.lang.String value, java.lang.Class<?> type)
Method Detail |
---|
public Extension getDeclaringExtension()
getDeclaringExtension
in interface Extension.Parameter
Extension.Parameter.getDeclaringExtension()
public PluginDescriptor getDeclaringPluginDescriptor()
PluginElement
null
.
getDeclaringPluginDescriptor
in interface PluginElement<Extension.Parameter>
PluginElement.getDeclaringPluginDescriptor()
public PluginFragment getDeclaringPluginFragment()
PluginElement
null
, if element is contributed by
plug-in directly.
getDeclaringPluginFragment
in interface PluginElement<Extension.Parameter>
PluginElement.getDeclaringPluginFragment()
public ExtensionPoint.ParameterDefinition getDefinition()
Extension.Parameter
null
for "invalid" parameters.
getDefinition
in interface Extension.Parameter
null
, if this parameter
is "invalid"Extension.Parameter.getDefinition()
public Extension.Parameter getSuperParameter()
getSuperParameter
in interface Extension.Parameter
null
if
this is top level parameterExtension.Parameter.getSuperParameter()
public java.util.Collection<Extension.Parameter> getSubParameters()
Extension.Parameter
getSubParameters
in interface Extension.Parameter
Extension.Parameter
objectsExtension.Parameter.getSubParameters()
public Extension.Parameter getSubParameter(java.lang.String id)
Extension.Parameter
null
if no
sub-parameters exist. If more than one sub-parameters with given ID
found, the method should throw an IllegalArgumentException
.
getSubParameter
in interface Extension.Parameter
id
- ID of sub-parameter to look for
Extension.Parameter.getSubParameter(
java.lang.String)
public java.util.Collection<Extension.Parameter> getSubParameters(java.lang.String id)
getSubParameters
in interface Extension.Parameter
id
- ID of sub-parameter to look for
Extension.Parameter.getSubParameters(
java.lang.String)
public java.lang.String rawValue()
rawValue
in interface Extension.Parameter
Extension.Parameter.rawValue()
public java.lang.Boolean valueAsBoolean()
Extension.Parameter
ParameterType.BOOLEAN
, this method
should throw an UnsupportedOperationException
.
valueAsBoolean
in interface Extension.Parameter
Extension.Parameter.valueAsBoolean()
public java.util.Date valueAsDate()
Extension.Parameter
ParameterType.DATE
, ParameterType.TIME
or ParameterType.DATE_TIME
, this method should throw an
UnsupportedOperationException
.
valueAsDate
in interface Extension.Parameter
Extension.Parameter.valueAsDate()
public java.lang.Number valueAsNumber()
Extension.Parameter
ParameterType.NUMBER
, this method
should throw an UnsupportedOperationException
.
valueAsNumber
in interface Extension.Parameter
Extension.Parameter.valueAsNumber()
public java.lang.String valueAsString()
Extension.Parameter
ParameterType.STRING
, this method
should throw an UnsupportedOperationException
.
valueAsString
in interface Extension.Parameter
Extension.Parameter.valueAsString()
public Extension valueAsExtension()
Extension.Parameter
ParameterType.EXTENSION_ID
, this
method should throw an UnsupportedOperationException
.
valueAsExtension
in interface Extension.Parameter
Extension.Parameter.valueAsExtension()
public ExtensionPoint valueAsExtensionPoint()
Extension.Parameter
ParameterType.EXTENSION_POINT_ID
,
this method should throw an UnsupportedOperationException
.
valueAsExtensionPoint
in interface Extension.Parameter
Extension.Parameter.valueAsExtensionPoint()
public PluginDescriptor valueAsPluginDescriptor()
Extension.Parameter
ParameterType.PLUGIN_ID
, this
method should throw an UnsupportedOperationException
.
valueAsPluginDescriptor
in interface Extension.Parameter
Extension.Parameter.valueAsPluginDescriptor()
public java.net.URL valueAsUrl()
Extension.Parameter
ParameterType.RESOURCE
, this
method should throw an UnsupportedOperationException
.
valueAsUrl
in interface Extension.Parameter
Extension.Parameter.valueAsUrl()
public java.net.URL valueAsUrl(PathResolver pathResolver)
Extension.Parameter
ParameterType.RESOURCE
, this
method should throw an UnsupportedOperationException
.
valueAsUrl
in interface Extension.Parameter
pathResolver
- path resolver to make URL absolute
Extension.Parameter.valueAsUrl(
org.java.plugin.PathResolver)
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public java.lang.String getId()
getId
in interface Identity
public java.lang.String getDocsPath()
getDocsPath
in interface Documentable<Extension.Parameter>
public Documentation<Extension.Parameter> getDocumentation()
getDocumentation
in interface Documentable<Extension.Parameter>
null
if there is no documentation provided
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |