org.daisy.dotify.api.formatter.FallbackRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dotify.library Show documentation

Dotify Library

There is a newer version: 1.0.7

package org.daisy.dotify.api.formatter;

/**
 * Provides a common interface for fallback rules. Note that the action of
 * a fallback rule is defined by the implementing class.
 *
 * @author Joel Håkansson
 */
public interface FallbackRule {
    /**
     * Gets the identifier of the collection that this rule should be applied to.
     *
     * @return returns the identifier
     */
    public String applyToCollection();

    /**
     * Returns true of the rule can only be applied to the context collection,
     * in other words the collection that triggers the fallback actions.
     *
     * @return returns true if the rule can only be applied to the context
     * collection, false otherwise
     */
    public boolean mustBeContextCollection();
}