org.apache.maven.diagrams.connectors.classes.filter
Enum ClassFilterStatus

java.lang.Object
  extended by java.lang.Enum<ClassFilterStatus>
      extended by org.apache.maven.diagrams.connectors.classes.filter.ClassFilterStatus
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ClassFilterStatus>

public enum ClassFilterStatus
extends java.lang.Enum<ClassFilterStatus>

Every class (interface) can be in one of such a states (in terms of filtering classes)

Author:
Piotr Tabor

Enum Constant Summary
EXCLUDED_WITH_KEEP_EDGES
          Matches one of includePattern and matched excludePattern with keep edges first
EXCLUDED_WITHOUT_KEEP_EDGES
          Matches one of includePattern and matched excludePattern without keep edges first
INCLUDED
          Matches one of includePattern and doesn't match any excludePattern
NOT_INCLUDED
          Does not match any includePattern
 
Method Summary
 boolean toSkip()
          NOT_INCLUDED and EXCLUDED_WITHOUT_KEEP_EDGES classes are skipped
static ClassFilterStatus valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ClassFilterStatus[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NOT_INCLUDED

public static final ClassFilterStatus NOT_INCLUDED
Does not match any includePattern


INCLUDED

public static final ClassFilterStatus INCLUDED
Matches one of includePattern and doesn't match any excludePattern


EXCLUDED_WITH_KEEP_EDGES

public static final ClassFilterStatus EXCLUDED_WITH_KEEP_EDGES
Matches one of includePattern and matched excludePattern with keep edges first


EXCLUDED_WITHOUT_KEEP_EDGES

public static final ClassFilterStatus EXCLUDED_WITHOUT_KEEP_EDGES
Matches one of includePattern and matched excludePattern without keep edges first

Method Detail

values

public static final ClassFilterStatus[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ClassFilterStatus c : ClassFilterStatus.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ClassFilterStatus valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

toSkip

public boolean toSkip()
NOT_INCLUDED and EXCLUDED_WITHOUT_KEEP_EDGES classes are skipped



Copyright © 2002-2009 Apache Software Foundation. All Rights Reserved.