Package org.apache.camel.catalog

Class EndpointValidationResult

java.lang.Object

org.apache.camel.catalog.EndpointValidationResult

All Implemented Interfaces:

Serializable

public class EndpointValidationResult
extends Object
implements Serializable

Details result of validating endpoint uri.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EndpointValidationResult()
EndpointValidationResult(String uri)

Method Summary

Modifier and Type	Method	Description
void	addDefaultValue(String name, String value)
void	addDeprecated(String name)
void	addIncapable(String uri)
void	addInvalidArray(String name, String value)
void	addInvalidBoolean(String name, String value)
void	addInvalidDuration(String name, String value)
void	addInvalidEnum(String name, String value)
void	addInvalidEnumChoices(String name, String[] choices)
void	addInvalidEnumSuggestions(String name, String[] suggestions)
void	addInvalidInteger(String name, String value)
void	addInvalidMap(String name, String value)
void	addInvalidNumber(String name, String value)
void	addInvalidReference(String name, String value)
void	addLenient(String name)
void	addNotConsumerOnly(String name)
void	addNotProducerOnly(String name)
void	addRequired(String name)
void	addSyntaxError(String syntaxError)
void	addUnknown(String name)
void	addUnknownComponent(String name)
void	addUnknownSuggestions(String name, String[] suggestions)
Map<String,String>	getDefaultValues()
Set<String>	getDeprecated()
List<String>	getEnumChoices(String optionName)
String	getIncapable()
Map<String,String>	getInvalidArray()
Map<String,String>	getInvalidBoolean()
Map<String,String>	getInvalidDuration()
Map<String,String>	getInvalidEnum()
Map<String,String[]>	getInvalidEnumChoices()
Map<String,String>	getInvalidInteger()
Map<String,String>	getInvalidMap()
Map<String,String>	getInvalidNumber()
Map<String,String>	getInvalidReference()
Set<String>	getLenient()
Set<String>	getNotConsumerOnly()
Set<String>	getNotProducerOnly()
int	getNumberOfErrors()
int	getNumberOfWarnings()
Set<String>	getRequired()
String	getSyntaxError()
Set<String>	getUnknown()
String	getUnknownComponent()
Map<String,String[]>	getUnknownSuggestions()
String	getUri()
boolean	hasErrors()
boolean	hasWarnings()
boolean	isSuccess()
String	summaryErrorMessage(boolean includeHeader)	A human readable summary of the validation errors.
String	summaryErrorMessage(boolean includeHeader, boolean ignoreDeprecated, boolean includeWarnings)	A human readable summary of the validation errors.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndpointValidationResult

public EndpointValidationResult()

EndpointValidationResult

public EndpointValidationResult(String uri)

Method Detail

getUri

public String getUri()

isSuccess

public boolean isSuccess()

addLenient

public void addLenient(String name)

addNotConsumerOnly

public void addNotConsumerOnly(String name)

addNotProducerOnly

public void addNotProducerOnly(String name)

getNotConsumerOnly

public Set<String> getNotConsumerOnly()

getNotProducerOnly

public Set<String> getNotProducerOnly()

getLenient

public Set<String> getLenient()

summaryErrorMessage

public String summaryErrorMessage(boolean includeHeader)

A human readable summary of the validation errors.

Parameters:

includeHeader - whether to include a header

Returns:

the summary, or null if no validation errors

summaryErrorMessage

public String summaryErrorMessage(boolean includeHeader,
                                  boolean ignoreDeprecated,
                                  boolean includeWarnings)

A human readable summary of the validation errors.

Parameters:

includeHeader - whether to include a header

ignoreDeprecated - whether to ignore deprecated options in use as an error or not

includeWarnings - whether to include warnings as an error or not

Returns:

the summary, or null if no validation errors

hasErrors

public boolean hasErrors()

getNumberOfErrors

public int getNumberOfErrors()

hasWarnings

public boolean hasWarnings()

getNumberOfWarnings

public int getNumberOfWarnings()

addSyntaxError

public void addSyntaxError(String syntaxError)

addIncapable

public void addIncapable(String uri)

addUnknownComponent

public void addUnknownComponent(String name)

addUnknown

public void addUnknown(String name)

addUnknownSuggestions

public void addUnknownSuggestions(String name,
                                  String[] suggestions)

addRequired

public void addRequired(String name)

addDeprecated

public void addDeprecated(String name)

addInvalidEnum

public void addInvalidEnum(String name,
                           String value)

addInvalidEnumChoices

public void addInvalidEnumChoices(String name,
                                  String[] choices)

addInvalidEnumSuggestions

public void addInvalidEnumSuggestions(String name,
                                      String[] suggestions)

addInvalidReference

public void addInvalidReference(String name,
                                String value)

addInvalidMap

public void addInvalidMap(String name,
                          String value)

addInvalidArray

public void addInvalidArray(String name,
                            String value)

addInvalidBoolean

public void addInvalidBoolean(String name,
                              String value)

addInvalidInteger

public void addInvalidInteger(String name,
                              String value)

addInvalidNumber

public void addInvalidNumber(String name,
                             String value)

addInvalidDuration

public void addInvalidDuration(String name,
                               String value)

addDefaultValue

public void addDefaultValue(String name,
                            String value)

getSyntaxError

public String getSyntaxError()

getIncapable

public String getIncapable()

getUnknown

public Set<String> getUnknown()

getUnknownSuggestions

public Map<String,String[]> getUnknownSuggestions()

getUnknownComponent

public String getUnknownComponent()

getRequired

public Set<String> getRequired()

getDeprecated

public Set<String> getDeprecated()

getInvalidEnum

public Map<String,String> getInvalidEnum()

getInvalidEnumChoices

public Map<String,String[]> getInvalidEnumChoices()

getEnumChoices

public List<String> getEnumChoices(String optionName)

getInvalidReference

public Map<String,String> getInvalidReference()

getInvalidMap

public Map<String,String> getInvalidMap()

getInvalidArray

public Map<String,String> getInvalidArray()

getInvalidBoolean

public Map<String,String> getInvalidBoolean()

getInvalidInteger

public Map<String,String> getInvalidInteger()

getInvalidNumber

public Map<String,String> getInvalidNumber()

getInvalidDuration

public Map<String,String> getInvalidDuration()

getDefaultValues

public Map<String,String> getDefaultValues()