public class

ParameterException

extends MacroException
java.lang.Object
   ↳ java.lang.Throwable
     ↳ java.lang.Exception
       ↳ com.atlassian.renderer.v2.macro.MacroException
         ↳ com.atlassian.confluence.macro.params.ParameterException

Class Overview

Thrown when there is a problem while processing a parameter.

Summary

Public Constructors
ParameterException(String message)
ParameterException(String message, Throwable cause)
ParameterException(Throwable cause, String name, String value, Set<String> acceptableValues)
Constructor that captures failure information so more useful feedback can be provided to the user.
Public Methods
Set<String> getAcceptableValues()
Returns acceptable values of this parameter.
String getName()
Returns the name of the parameter that caused the problem.
String getValue()
Returns the (invalid) value of the parameter that caused the problem.
void setAcceptableValues(Set<String> acceptableValues)
Sets acceptable values of this parameter.
void setName(String name)
Sets the name of the parameter that caused the problem.
void setValue(String value)
Sets the (invalid) value of the parameter that caused the problem.
[Expand]
Inherited Methods
From class java.lang.Throwable
From class java.lang.Object

Public Constructors

public ParameterException (String message)

public ParameterException (String message, Throwable cause)

public ParameterException (Throwable cause, String name, String value, Set<String> acceptableValues)

Constructor that captures failure information so more useful feedback can be provided to the user.

Parameters
cause the underlying cause, if any
name the name of the parameter with the error
value the (invalid) value that caused the problem
acceptableValues acceptable values for the parameter

Public Methods

public Set<String> getAcceptableValues ()

Returns acceptable values of this parameter.

Returns
  • acceptableValues acceptable values of this parameter

public String getName ()

Returns the name of the parameter that caused the problem.

Returns
  • the name of the parameter that caused the problem

public String getValue ()

Returns the (invalid) value of the parameter that caused the problem.

Returns
  • value the (invalid) value of the parameter that caused the problem

public void setAcceptableValues (Set<String> acceptableValues)

Sets acceptable values of this parameter.

Parameters
acceptableValues acceptable values of this parameter

public void setName (String name)

Sets the name of the parameter that caused the problem.

Parameters
name the name of the parameter that caused the problem

public void setValue (String value)

Sets the (invalid) value of the parameter that caused the problem.

Parameters
value the (invalid) value of the parameter that caused the problem