Package biz.gabrys.maven.plugin.util.parameter.sanitizer

Class AbstractSimpleSanitizer

java.lang.Object

biz.gabrys.maven.plugin.util.parameter.sanitizer.AbstractSimpleSanitizer

All Implemented Interfaces:

ValueSanitizer

Direct Known Subclasses:

LazySimpleSanitizer, SimpleSanitizer

public abstract class AbstractSimpleSanitizer
extends Object
implements ValueSanitizer

Helps in implementing sanitizers which specify that the parameter value is valid based on a simple condition.

Since:

1.3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	valid	Information whether parameter current value is valid.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSimpleSanitizer(boolean valid)	Constructs a new instance and sets information on whether parameter current value is valid.

Method Summary

Modifier and Type	Method	Description
boolean	isValid(Object value)	Returns a condition value specified during construction of this object.
Object	sanitize(Object value)	Sanitizes a parameter invalid value to valid form.
protected abstract Object	sanitize2(Object value)	Sanitizes a parameter invalid value to valid form.

Methods inherited from class java.lang.Object

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

Field Detail

valid

protected final boolean valid

Information whether parameter current value is valid.

Since:

1.3.0

Constructor Detail

AbstractSimpleSanitizer

protected AbstractSimpleSanitizer(boolean valid)

Constructs a new instance and sets information on whether parameter current value is valid.

Parameters:

valid - true whether parameter current value is valid, otherwise false.

Since:

1.3.0

Method Detail

isValid

public boolean isValid(Object value)

Returns a condition value specified during construction of this object.

Specified by:

isValid in interface ValueSanitizer

Parameters:

value - the parameter value (ignored).

Returns:

true whether the parameter value is valid, otherwise false.

Since:

1.3.0

See Also:

AbstractSimpleSanitizer(boolean)

sanitize

public Object sanitize(Object value)

Sanitizes a parameter invalid value to valid form. Should be not be executed if isValid(Object) returns true.

Specified by:

sanitize in interface ValueSanitizer

Parameters:

value - the parameter invalid value.

Returns:

the valid value.

Throws:

UnsupportedOperationException - if the condition is equal to true.

Since:

1.3.0

sanitize2

protected abstract Object sanitize2(Object value)

Sanitizes a parameter invalid value to valid form. Executed only whether the condition is equal to false.

Parameters:

value - the parameter invalid value.

Returns:

the valid value.

Since:

1.3.0