Package com.adobe.epubcheck.api

Enum EPUBProfile

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EPUBProfile>
    public enum EPUBProfile
extends java.lang.Enum<EPUBProfile>

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private EPUBProfile()  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      EPUBProfile makeTypeCompatible​(java.util.Set<PublicationType> pubTypes)
      Checks this validation profile against the dc:type(s) declared in an OPF and returns a possibly overriden profile.
      PublicationType matchingType()  
      static EPUBProfile valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static EPUBProfile[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • EPUBProfile

        private EPUBProfile()

    • Method Detail

      • values

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

      • valueOf

        public static EPUBProfile 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
        java.lang.NullPointerException - if the argument is null

      • makeTypeCompatible

        public EPUBProfile makeTypeCompatible​(java.util.Set<PublicationType> pubTypes)
        Checks this validation profile against the dc:type(s) declared in an OPF and returns a possibly overriden profile.

        For instance, if the publication has a 'edupub' dc:type and the DEFAULT validation profile is given, the EDUPUB profile will be returned instead.

        If the given validation profile is modified, report an INFO message OPF_064.

        Parameters:
        The - publication's dc:type(s).
        Returns:
        This profile if it's compatible with the OPF dc:type(s), or else a compatible non-null validation profile.