Package org.java.plugin.tools.mocks
Class MockParameter
- java.lang.Object
-
- org.java.plugin.tools.mocks.MockIdentity
-
- org.java.plugin.tools.mocks.MockPluginElement<Extension.Parameter>
-
- org.java.plugin.tools.mocks.MockParameter
-
- All Implemented Interfaces:
Documentable<Extension.Parameter>,Extension.Parameter,Identity,PluginElement<Extension.Parameter>
public class MockParameter extends MockPluginElement<Extension.Parameter> implements Extension.Parameter
- Version:
- $Id$
-
-
Constructor Summary
Constructors Constructor Description MockParameter()No-arguments constructor.MockParameter(java.lang.String id, java.lang.String aRawValue, java.lang.Object aTypedValue)MockParameter(java.lang.String id, java.lang.String aRawValue, java.lang.Object aTypedValue, Extension aDeclaringExtension)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MockParameteraddParameter(Extension.Parameter parameter)ExtensiongetDeclaringExtension()ExtensionPoint.ParameterDefinitiongetDefinition()Returns definition for this extension parameter.Extension.ParametergetSubParameter(java.lang.String id)Returns sub-parameter with given ID ornullif 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.ParametergetSuperParameter()java.lang.StringrawValue()MockParametersetDeclaringExtension(Extension value)MockParametersetDefinition(ExtensionPoint.ParameterDefinition value)MockParametersetSuperParameter(Extension.Parameter value)MockParametersetValue(java.lang.String raw, java.lang.Object typed)java.lang.BooleanvalueAsBoolean()Returns "typed" value of parameter.java.util.DatevalueAsDate()Returns "typed" value of parameter.ExtensionvalueAsExtension()Returns "typed" value of parameter.ExtensionPointvalueAsExtensionPoint()Returns "typed" value of parameter.java.lang.NumbervalueAsNumber()Returns "typed" value of parameter.PluginDescriptorvalueAsPluginDescriptor()Returns "typed" value of parameter.java.lang.StringvalueAsString()Returns "typed" value of parameter.java.net.URLvalueAsUrl()Returns "typed" value of parameter.java.net.URLvalueAsUrl(PathResolver pathResolver)Returns "typed" value of parameter.-
Methods inherited from class org.java.plugin.tools.mocks.MockPluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment, getDocsPath, getDocumentation, setDeclaringPluginDescriptor, setDeclaringPluginFragment, setDocsPath, setDocumentation
-
Methods inherited from class org.java.plugin.tools.mocks.MockIdentity
getId, setId
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.java.plugin.registry.Documentable
getDocsPath, getDocumentation
-
Methods inherited from interface org.java.plugin.registry.PluginElement
getDeclaringPluginDescriptor, getDeclaringPluginFragment
-
-
-
-
Constructor Detail
-
MockParameter
public MockParameter()
No-arguments constructor.
-
MockParameter
public MockParameter(java.lang.String id, java.lang.String aRawValue, java.lang.Object aTypedValue)- Parameters:
id- parameter IDaRawValue- raw parameter valueaTypedValue- typed parameter value
-
MockParameter
public MockParameter(java.lang.String id, java.lang.String aRawValue, java.lang.Object aTypedValue, Extension aDeclaringExtension)- Parameters:
id- parameter IDaRawValue- raw parameter valueaTypedValue- typed parameter valueaDeclaringExtension- declaring extension
-
-
Method Detail
-
getDeclaringExtension
public Extension getDeclaringExtension()
- Specified by:
getDeclaringExtensionin interfaceExtension.Parameter- Returns:
- extension this parameter belongs to
- See Also:
Extension.Parameter.getDeclaringExtension()
-
setDeclaringExtension
public MockParameter setDeclaringExtension(Extension value)
- Parameters:
value- the declaring extension to set- Returns:
- this instance
-
getDefinition
public ExtensionPoint.ParameterDefinition getDefinition()
Description copied from interface:Extension.ParameterReturns definition for this extension parameter. May returnnullfor "invalid" parameters.- Specified by:
getDefinitionin interfaceExtension.Parameter- Returns:
- parameter definition or
null, if this parameter is "invalid" - See Also:
Extension.Parameter.getDefinition()
-
setDefinition
public MockParameter setDefinition(ExtensionPoint.ParameterDefinition value)
- Parameters:
value- the parameter definition to set- Returns:
- this instance
-
getSubParameter
public Extension.Parameter getSubParameter(java.lang.String id)
Description copied from interface:Extension.ParameterReturns sub-parameter with given ID ornullif no sub-parameters exist. If more than one sub-parameters with given ID found, the method should throw anIllegalArgumentException.- Specified by:
getSubParameterin interfaceExtension.Parameter- Parameters:
id- ID of sub-parameter to look for- Returns:
- sub-parameter with given ID
- See Also:
Extension.Parameter.getSubParameter( java.lang.String)
-
getSubParameters
public java.util.Collection<Extension.Parameter> getSubParameters()
Description copied from interface:Extension.ParameterReturns collection of all sub-parameters defined in this parameter.- Specified by:
getSubParametersin interfaceExtension.Parameter- Returns:
- collection of
Extension.Parameterobjects - See Also:
Extension.Parameter.getSubParameters()
-
getSubParameters
public java.util.Collection<Extension.Parameter> getSubParameters(java.lang.String id)
- Specified by:
getSubParametersin interfaceExtension.Parameter- Parameters:
id- ID of sub-parameter to look for- Returns:
- collection of all sub-parameters with given ID
- See Also:
Extension.Parameter.getSubParameters( java.lang.String)
-
addParameter
public MockParameter addParameter(Extension.Parameter parameter)
- Parameters:
parameter- sub-parameter to add- Returns:
- this instance
-
getSuperParameter
public Extension.Parameter getSuperParameter()
- Specified by:
getSuperParameterin interfaceExtension.Parameter- Returns:
- parameter, of which this one is child or
nullif this is top level parameter - See Also:
Extension.Parameter.getSuperParameter()
-
setSuperParameter
public MockParameter setSuperParameter(Extension.Parameter value)
- Parameters:
value- the super parameter to set- Returns:
- this instance
-
rawValue
public java.lang.String rawValue()
- Specified by:
rawValuein interfaceExtension.Parameter- Returns:
- parameter value as it is specified in manifest, if no value provided there, this method should return empty string
- See Also:
Extension.Parameter.rawValue()
-
setValue
public MockParameter setValue(java.lang.String raw, java.lang.Object typed)
- Parameters:
raw- raw parameter valuetyped- typed parameter value- Returns:
- this instance
-
valueAsBoolean
public java.lang.Boolean valueAsBoolean()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.BOOLEAN, this method should throw anUnsupportedOperationException.- Specified by:
valueAsBooleanin interfaceExtension.Parameter- Returns:
- value as Boolean object
- See Also:
Extension.Parameter.valueAsBoolean()
-
valueAsDate
public java.util.Date valueAsDate()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.DATE,ParameterType.TIMEorParameterType.DATE_TIME, this method should throw anUnsupportedOperationException.- Specified by:
valueAsDatein interfaceExtension.Parameter- Returns:
- value as Date object
- See Also:
Extension.Parameter.valueAsDate()
-
valueAsExtension
public Extension valueAsExtension()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.EXTENSION_ID, this method should throw anUnsupportedOperationException.- Specified by:
valueAsExtensionin interfaceExtension.Parameter- Returns:
- value as Extension object
- See Also:
Extension.Parameter.valueAsExtension()
-
valueAsExtensionPoint
public ExtensionPoint valueAsExtensionPoint()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.EXTENSION_POINT_ID, this method should throw anUnsupportedOperationException.- Specified by:
valueAsExtensionPointin interfaceExtension.Parameter- Returns:
- value as ExtensionPoint object
- See Also:
Extension.Parameter.valueAsExtensionPoint()
-
valueAsNumber
public java.lang.Number valueAsNumber()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.NUMBER, this method should throw anUnsupportedOperationException.- Specified by:
valueAsNumberin interfaceExtension.Parameter- Returns:
- value as Number object
- See Also:
Extension.Parameter.valueAsNumber()
-
valueAsPluginDescriptor
public PluginDescriptor valueAsPluginDescriptor()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.PLUGIN_ID, this method should throw anUnsupportedOperationException.- Specified by:
valueAsPluginDescriptorin interfaceExtension.Parameter- Returns:
- value as PluginDescriptor object
- See Also:
Extension.Parameter.valueAsPluginDescriptor()
-
valueAsString
public java.lang.String valueAsString()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.STRING, this method should throw anUnsupportedOperationException.- Specified by:
valueAsStringin interfaceExtension.Parameter- Returns:
- value as String object
- See Also:
Extension.Parameter.valueAsString()
-
valueAsUrl
public java.net.URL valueAsUrl()
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.RESOURCE, this method should throw anUnsupportedOperationException.- Specified by:
valueAsUrlin interfaceExtension.Parameter- Returns:
- value as absolute or relative URL as specified in manifest
- See Also:
Extension.Parameter.valueAsUrl()
-
valueAsUrl
public java.net.URL valueAsUrl(PathResolver pathResolver)
Description copied from interface:Extension.ParameterReturns "typed" value of parameter. If this parameter is invalid or is not of typeParameterType.RESOURCE, this method should throw anUnsupportedOperationException.- Specified by:
valueAsUrlin interfaceExtension.Parameter- Parameters:
pathResolver- path resolver to make URL absolute- Returns:
- value as absolute URL
- See Also:
Extension.Parameter.valueAsUrl( org.java.plugin.PathResolver)
-
-