Package com.adobe.epubcheck.api

Class FeatureReport

java.lang.Object

com.adobe.epubcheck.api.FeatureReport

public final class FeatureReport
extends java.lang.Object

A feature report holds a list of noteworthy EPUB features. Features are typically reported by handlers at parsing time. The report can be looked-up after the parsing phase to enable checks that depend on conditions spanning over multiple documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FeatureReport.Feature	A noteworthy feature in an EPUB Rendition (e.g.

Field Summary

Fields

Modifier and Type	Field	Description
private com.google.common.collect.SetMultimap<FeatureEnum,FeatureReport.Feature>	features

Constructor Summary

Constructors

Constructor	Description
FeatureReport()

Method Summary

Modifier and Type	Method	Description
java.util.Set<FeatureReport.Feature>	getFeature(FeatureEnum feature)	Returns the set of FeatureReport.Feature stored in this report for the given feature name.
boolean	hasFeature(FeatureEnum feature)	Returns true iff this reports contains data for a feature name.
void	report(FeatureEnum name, EPUBLocation location)	Add a new feature to this report.
void	report(FeatureEnum name, EPUBLocation location, java.lang.String value)	Add a new feature to this report.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

features

private final com.google.common.collect.SetMultimap<FeatureEnum,FeatureReport.Feature> features

Constructor Detail

FeatureReport

public FeatureReport()

Method Detail

report

public void report(FeatureEnum name,
                   EPUBLocation location)

Add a new feature to this report.

Parameters:

name - The name of the feature (must not be null)

path - The location of the feature (can be null)

report

public void report(FeatureEnum name,
                   EPUBLocation location,
                   java.lang.String value)

Add a new feature to this report.

Parameters:

name - The name of the feature (must not be null)

path - The location of the feature (can be null)

value - The value of the feature (can be null)

hasFeature

public boolean hasFeature(FeatureEnum feature)

Returns true iff this reports contains data for a feature name.

Parameters:

feature - the feature name to look-up

Returns:

true iff this reports contains data for a feature name.

getFeature

public java.util.Set<FeatureReport.Feature> getFeature(FeatureEnum feature)

Returns the set of FeatureReport.Feature stored in this report for the given feature name.

Parameters:

feature - the feature name to look-up

Returns:

the (possibly empty) set of FeatureReport.Feature stored in this report for the given feature name.