org.apache.commons.pipeline.validation
Class ValidationFailure

java.lang.Object
  extended by org.apache.commons.pipeline.validation.ValidationFailure

public class ValidationFailure
extends Object

This class is used to store a collection of information about a particular validation failure.


Nested Class Summary
static class ValidationFailure.Type
          Enumeration of possible causes of validation failure
 
Constructor Summary
ValidationFailure(ValidationFailure.Type type, String message, Stage upstream, Stage downstream)
          Creates a new instance of ValidationError
 
Method Summary
 Stage getDownstreamStage()
          The stage downstream of the connection that could not be validated
 String getMessage()
          Returns the descriptive message about the error
 ValidationFailure.Type getType()
          Type identifying what sort of problem was encountered
 Stage getUpstreamStage()
          The stage upstream of the connection that could not be validated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValidationFailure

public ValidationFailure(ValidationFailure.Type type,
                         String message,
                         Stage upstream,
                         Stage downstream)
Creates a new instance of ValidationError

Parameters:
type - The type of problem encountered
message - A message with more detailed information about the problem
upstream - A reference to the upstream stage
downstream - A reference to a downstream stage
Method Detail

getType

public ValidationFailure.Type getType()
Type identifying what sort of problem was encountered

Returns:
the type of problem encountered

getMessage

public String getMessage()
Returns the descriptive message about the error

Returns:
message describing the error

getUpstreamStage

public Stage getUpstreamStage()
The stage upstream of the connection that could not be validated

Returns:
reference to the upstream Stage

getDownstreamStage

public Stage getDownstreamStage()
The stage downstream of the connection that could not be validated

Returns:
reference to the downstream Stage


Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.