com.fasterxml.jackson.core.FormatFeature Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jackson-core Show documentation

Core Jackson abstractions, basic JSON streaming API implementation

There is a newer version: 2.17.0

package com.fasterxml.jackson.core;

/**
 * Marker interface that is to be implemented by data format - specific features.
 * Interface used since Java Enums can not extend classes or other Enums, but
 * they can implement interfaces; and as such we may be able to use limited
 * amount of generic functionality.
 *
 * Note that this type is only implemented by non-JSON formats:
 * types {@link JsonParser.Feature} and {@link JsonGenerator.Feature} do NOT
 * implement it. This is to make it easier to avoid ambiguity with method
 * calls.
 * 
 * @since 2.6 (to be fully used in 2.7 and beyond)
 */
public interface FormatFeature
{
    /**
     * Accessor for checking whether this feature is enabled by default.
     */
    public boolean enabledByDefault();
    
    /**
     * Returns bit mask for this feature instance; must be a single bit,
     * that is of form (1 << N)
     */
    public int getMask();

    /**
     * Convenience method for checking whether feature is enabled in given bitmask
     */
    public boolean enabledIn(int flags);
}