Class MockParameter

Method Details

• getDeclaringExtension

  public Extension getDeclaringExtension()

  Specified by:

  getDeclaringExtension in interface Extension.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.Parameter

  Returns definition for this extension parameter. May return null for "invalid" parameters.

  Specified by:

  getDefinition in interface Extension.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(String id)

  Description copied from interface: Extension.Parameter

  Returns sub-parameter with given ID or null if no sub-parameters exist. If more than one sub-parameters with given ID found, the method should throw an IllegalArgumentException.

  Specified by:

  getSubParameter in interface Extension.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 Collection<Extension.Parameter> getSubParameters()

  Description copied from interface: Extension.Parameter

  Returns collection of all sub-parameters defined in this parameter.

  Specified by:

  getSubParameters in interface Extension.Parameter

  Returns:

  collection of Extension.Parameter objects

  See Also:

  • Extension.Parameter.getSubParameters()

• getSubParameters

  public Collection<Extension.Parameter> getSubParameters(String id)

  Specified by:

  getSubParameters in interface Extension.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:

  getSuperParameter in interface Extension.Parameter

  Returns:

  parameter, of which this one is child or null if 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 String rawValue()

  Specified by:

  rawValue in interface Extension.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(String raw, Object typed)

  Parameters:

  raw - raw parameter value

  typed - typed parameter value

  Returns:

  this instance

• valueAsBoolean

  public Boolean valueAsBoolean()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.BOOLEAN, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsBoolean in interface Extension.Parameter

  Returns:

  value as Boolean object

  See Also:

  • Extension.Parameter.valueAsBoolean()

• valueAsDate

  public Date valueAsDate()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.DATE, ParameterType.TIME or ParameterType.DATE_TIME, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsDate in interface Extension.Parameter

  Returns:

  value as Date object

  See Also:

  • Extension.Parameter.valueAsDate()

• valueAsExtension

  public Extension valueAsExtension()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.EXTENSION_ID, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsExtension in interface Extension.Parameter

  Returns:

  value as Extension object

  See Also:

  • Extension.Parameter.valueAsExtension()

• valueAsExtensionPoint

  public ExtensionPoint valueAsExtensionPoint()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.EXTENSION_POINT_ID, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsExtensionPoint in interface Extension.Parameter

  Returns:

  value as ExtensionPoint object

  See Also:

  • Extension.Parameter.valueAsExtensionPoint()

• valueAsNumber

  public Number valueAsNumber()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.NUMBER, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsNumber in interface Extension.Parameter

  Returns:

  value as Number object

  See Also:

  • Extension.Parameter.valueAsNumber()

• valueAsPluginDescriptor

  public PluginDescriptor valueAsPluginDescriptor()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.PLUGIN_ID, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsPluginDescriptor in interface Extension.Parameter

  Returns:

  value as PluginDescriptor object

  See Also:

  • Extension.Parameter.valueAsPluginDescriptor()

• valueAsString

  public String valueAsString()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.STRING, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsString in interface Extension.Parameter

  Returns:

  value as String object

  See Also:

  • Extension.Parameter.valueAsString()

• valueAsUrl

  public URL valueAsUrl()

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.RESOURCE, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsUrl in interface Extension.Parameter

  Returns:

  value as absolute or relative URL as specified in manifest

  See Also:

  • Extension.Parameter.valueAsUrl()

• valueAsUrl

  public URL valueAsUrl(PathResolver pathResolver)

  Description copied from interface: Extension.Parameter

  Returns "typed" value of parameter. If this parameter is invalid or is not of type ParameterType.RESOURCE, this method should throw an UnsupportedOperationException.

  Specified by:

  valueAsUrl in interface Extension.Parameter

  Parameters:

  pathResolver - path resolver to make URL absolute

  Returns:

  value as absolute URL

  See Also:

  • Extension.Parameter.valueAsUrl(org.java.plugin.PathResolver)