Class FeatureReport.Feature

  • Enclosing class:
    FeatureReport

    public static final class FeatureReport.Feature
    extends java.lang.Object
    A noteworthy feature in an EPUB Rendition (e.g. presence of page breaks, encryption, subject, etc.)
    • Field Summary

      Fields 
      Modifier and Type Field Description
      private com.google.common.base.Optional<EPUBLocation> location  
      private FeatureEnum name  
      private com.google.common.base.Optional<java.lang.String> value  
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private Feature​(FeatureEnum name, EPUBLocation location, java.lang.String value)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.google.common.base.Optional<EPUBLocation> getLocation()
      The location of the feature.
      FeatureEnum getName()
      The name of the feature
      com.google.common.base.Optional<java.lang.String> getValue()
      The value of the feature, when relevant (can be absent).
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • location

        private com.google.common.base.Optional<EPUBLocation> location
      • value

        private com.google.common.base.Optional<java.lang.String> value
    • Method Detail

      • getName

        public FeatureEnum getName()
        The name of the feature
        Returns:
        the name of the feature
      • getLocation

        public com.google.common.base.Optional<EPUBLocation> getLocation()
        The location of the feature.
        Returns:
        the path to the document containing the feature (can be absent).
      • getValue

        public com.google.common.base.Optional<java.lang.String> getValue()
        The value of the feature, when relevant (can be absent).
        Returns:
        the value of the feature if it has one, or Optional.absent().