dk.heick.properties.collections

Class ActivationValidator

java.lang.Object

dk.heick.properties.collections.ActivationValidator

All Implemented Interfaces:

Serializable

public class ActivationValidator
extends Object
implements Serializable

ActivationValidator where you can cross validate properties, ensure that some properties is welldefined if others is also defined.

The definition of "Well-Defined" is that the value is NOT null the Property is valid.
This is the rule EVEN if "null" is allowed for the Property.


Example:

 public interface MyProperties {
                public final static Property<Integer> PORT_NUMBER = new Property<Integer>("port.number",new IntegerPropertyType(80));
                public final static Property<Integer> A_SSL_CONFIG = new Property<Integer>("ssl.keystore",new StringPropertyType(),true); //null allowed.
 }
  
 public class MyPropertiesDemo extends PropertyStaticCollection implements MyProperties {
      public MyPropertiesDemo(FilePropertyIO io)  {
          super(io);
          
                }

      public void postValidation() throws PropertyException {
        ActivationValidator activator = new ActivationValidator();
          activator.given(MyProperties.PORT_NUMBER.getTypedValue()==443,A_SSL_CONFIG);
      }
      
        }
 

Since:

1.2

Author:

Frederik Heick

See Also:

Property.isDefined(), Property.isValid(), Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActivationValidator() Constuctor.

Method Summary

Modifier and Type	Method and Description
boolean	isDefinedAndValid(Property<?> property) Determines if a Property is defined and valid.
void	validate(boolean given, Property<?>... thanMustBeDefined) Validates a when a certain condition is true, all provided properties must be defined.
void	validate(Property<?> givenPropertyDefined, Object shouldEquals, Property<?>... thanMustBeDefined) Validates that a Property typed value is equal a value; if so ; than all the properties in the array must be weel defined.
void	validate(Property<?> givenPropertyDefined, Property<?>... thanMustBeDefined) Validates that if the Property givenPropertyDefined is not null AND is valid, all the other Properties thanMustBeDefined must be not null and well defined.
void	validateMustBeDefined(Property<?>... thanMustBeDefined) Validates an array of Property's that they all are weel defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivationValidator

public ActivationValidator()

Constuctor.

Method Detail

validate

public final void validate(Property<?> givenPropertyDefined,
                           Property<?>... thanMustBeDefined)
                    throws PropertyException

Validates that if the Property givenPropertyDefined is not null AND is valid, all the other Properties thanMustBeDefined must be not null and well defined.
By WELL-DEFINED, we means that the Property is valid and it returns and non-null value.

Parameters:

givenPropertyDefined -

thanMustBeDefined -

Throws:

PropertyException

validate

public final void validate(boolean given,
                           Property<?>... thanMustBeDefined)
                    throws PropertyException

Validates a when a certain condition is true, all provided properties must be defined.

Parameters:

given - the paramter that must be true before all the properties provided must be defined.

thanMustBeDefined - the array of properties that must be well defined.

Throws:

PropertyException - if one if the provided properties is not welldefined is the given is true.

validate

public final void validate(Property<?> givenPropertyDefined,
                           Object shouldEquals,
                           Property<?>... thanMustBeDefined)
                    throws PropertyException

Validates that a Property typed value is equal a value; if so ; than all the properties in the array must be weel defined.

Parameters:

givenPropertyDefined - if a given properties is not null and well defined, and equals with the parameter shouldEquals.

shouldEquals - the value which the Property toType() must be equal.

thanMustBeDefined - the propeties which must be well defined if above condition is true.

Throws:

PropertyException - if one if the provided properties is not welldefined if above condition is true.

validateMustBeDefined

public final void validateMustBeDefined(Property<?>... thanMustBeDefined)
                                 throws PropertyException

Validates an array of Property's that they all are weel defined.

Parameters:

thanMustBeDefined - the array of Property's to validate to be weel defined.

Throws:

PropertyException - if one if the provided properties is not welldefined

isDefinedAndValid

public final boolean isDefinedAndValid(Property<?> property)
                                throws NullPointerException

Determines if a Property is defined and valid.

Parameters:

property - the property.

Returns:

true if the string value is not null and the property is validated successfully, otherwise false.

Throws:

NullPointerException - if property is null.

See Also:

Property.isDefined(), Property.isValid()