Package org.cip4.jdflib.core

Class JDFElement.EnumValidationLevel

java.lang.Object
org.apache.commons.lang.enums.Enum
org.apache.commons.lang.enums.ValuedEnum
org.cip4.jdflib.core.JDFElement.EnumValidationLevel
All Implemented Interfaces:
Serializable, Comparable
Enclosing class:
JDFElement
public static final class JDFElement.EnumValidationLevel extends ValuedEnum
Enumeration for validation level
  • level ValidationLevel_NoWarnIncomplete: Ignore warnings and don't require all required parameters
  • level ValidationLevel_NoWarnComplete: Ignore warnings and require all required parameters
  • level ValidationLevel_Incomplete: incomplete elements are valid
  • level ValidationLevel_Complete: full validation of an individual resource
  • level ValidationLevel_RecursiveIncomplete: incomplete validation of an individual resource and all of its child elements - e.g. for pools
  • level ValidationLevel_RecursiveComplete: full validation of an individual resource and all of its child elements - e.g. for pools
See Also:

  • Field Details

  • Constructor Details

    • EnumValidationLevel

      protected EnumValidationLevel(String name)

  • Method Details

    • getEnum

      public static JDFElement.EnumValidationLevel getEnum(String enumName)
      Parameters:
      enumName -
      Returns:

    • getEnum

      public static JDFElement.EnumValidationLevel getEnum(int enumValue)
      Parameters:
      enumValue -
      Returns:

    • getEnumMap

      public static Map getEnumMap()
      Returns:

    • getEnumList

      public static List getEnumList()
      Returns:

    • iterator

      public static Iterator iterator()
      Returns:

    • isRecursive

      public static boolean isRecursive(JDFElement.EnumValidationLevel vl)
      return true if vl is a recursvive EnumValidationLevel
      Parameters:
      vl - the EnumValidationLevel to check
      Returns:
      true if vl is recursive

    • isNoWarn

      public static boolean isNoWarn(JDFElement.EnumValidationLevel vl)
      return true if vl is a recursvive EnumValidationLevel
      Parameters:
      vl - the EnumValidationLevel to check
      Returns:
      true if vl is recursive

    • isRequired

      public static boolean isRequired(JDFElement.EnumValidationLevel level)
      returns true if the enumeration level is either Complete, NoWarnComplete or RecursiveComplete, i.e. if the parameter is required
      Parameters:
      level - the level to check
      Returns:
      true if required

    • setNoWarning

      public static JDFElement.EnumValidationLevel setNoWarning(JDFElement.EnumValidationLevel level, boolean noWarning)
      calculate the corresponding nowarn level based on level
      Parameters:
      level - the level to strip warnings from
      noWarning - if true, set to nowarne, else set to standard
      Returns:
      the validationlevel withot warnings

    • incompleteLevel

      public static JDFElement.EnumValidationLevel incompleteLevel(JDFElement.EnumValidationLevel level)
      calculate the corresponding incomplete level based on level
      Parameters:
      level - the level to test
      Returns:
      EnumValidationLevel - the modified level