net.sourceforge.cruisecontrol.util
Class ValidationHelper

java.lang.Object
  extended bynet.sourceforge.cruisecontrol.util.ValidationHelper

public final class ValidationHelper
extends java.lang.Object

Reusable assertion like facility for handling configuration mistakes (e.g. unsupported/required attributes).

Author:
Jerome Lacoste

Method Summary
static void assertExists(java.io.File file, java.lang.String attributeName, java.lang.Class plugin)
           
static void assertFalse(boolean condition, java.lang.String message)
           
static void assertHasChild(java.lang.Object child, java.lang.Class childType, java.lang.String usualChildNodeName, java.lang.Class plugin)
          Handle required plugin child elements.
static void assertHasChild(java.lang.Object child, java.lang.String usualChildNodeName, java.lang.Class plugin)
          Handle required plugin child elements.
static void assertIsDependentSet(java.lang.String masterAttribute, java.lang.String masterAttributeName, java.lang.String childAttribute, java.lang.String childAttributeName, java.lang.Class plugin)
           
static void assertIsNotDirectory(java.io.File file, java.lang.String attributeName, java.lang.Class plugin)
           
static void assertIsReadable(java.io.File file, java.lang.String attributeName, java.lang.Class plugin)
           
static void assertIsSet(java.lang.Object attribute, java.lang.String attributeName, java.lang.Class plugin)
          Handle required plugin attributes.
static void assertIsSet(java.lang.Object attribute, java.lang.String attributeName, java.lang.String pluginName)
          Handle required plugin attributes.
static void assertNotEmpty(java.lang.String attribute, java.lang.String attributeName, java.lang.Class plugin)
          Handle required plugin attributes.
static void assertTrue(boolean condition, java.lang.String message)
           
static void fail(java.lang.String message)
           
static void fail(java.lang.String message, java.lang.Exception e)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

assertIsSet

public static void assertIsSet(java.lang.Object attribute,
                               java.lang.String attributeName,
                               java.lang.Class plugin)
                        throws CruiseControlException
Handle required plugin attributes.

Throws:
CruiseControlException

assertIsSet

public static void assertIsSet(java.lang.Object attribute,
                               java.lang.String attributeName,
                               java.lang.String pluginName)
                        throws CruiseControlException
Handle required plugin attributes.

Throws:
CruiseControlException

assertIsDependentSet

public static void assertIsDependentSet(java.lang.String masterAttribute,
                                        java.lang.String masterAttributeName,
                                        java.lang.String childAttribute,
                                        java.lang.String childAttributeName,
                                        java.lang.Class plugin)
                                 throws CruiseControlException
Parameters:
masterAttribute -
childAttribute -
plugin -
Throws:
CruiseControlException

assertNotEmpty

public static void assertNotEmpty(java.lang.String attribute,
                                  java.lang.String attributeName,
                                  java.lang.Class plugin)
                           throws CruiseControlException
Handle required plugin attributes.

Throws:
CruiseControlException - if empty (null OK)

assertHasChild

public static void assertHasChild(java.lang.Object child,
                                  java.lang.Class childType,
                                  java.lang.String usualChildNodeName,
                                  java.lang.Class plugin)
                           throws CruiseControlException
Handle required plugin child elements.

Throws:
CruiseControlException

assertHasChild

public static void assertHasChild(java.lang.Object child,
                                  java.lang.String usualChildNodeName,
                                  java.lang.Class plugin)
                           throws CruiseControlException
Handle required plugin child elements.

Throws:
CruiseControlException

assertTrue

public static void assertTrue(boolean condition,
                              java.lang.String message)
                       throws CruiseControlException
Throws:
CruiseControlException

fail

public static void fail(java.lang.String message)
                 throws CruiseControlException
Throws:
CruiseControlException

fail

public static void fail(java.lang.String message,
                        java.lang.Exception e)
                 throws CruiseControlException
Throws:
CruiseControlException

assertFalse

public static void assertFalse(boolean condition,
                               java.lang.String message)
                        throws CruiseControlException
Throws:
CruiseControlException

assertExists

public static void assertExists(java.io.File file,
                                java.lang.String attributeName,
                                java.lang.Class plugin)
                         throws CruiseControlException
Throws:
CruiseControlException

assertIsNotDirectory

public static void assertIsNotDirectory(java.io.File file,
                                        java.lang.String attributeName,
                                        java.lang.Class plugin)
                                 throws CruiseControlException
Throws:
CruiseControlException

assertIsReadable

public static void assertIsReadable(java.io.File file,
                                    java.lang.String attributeName,
                                    java.lang.Class plugin)
                             throws CruiseControlException
Throws:
CruiseControlException