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 processing abstractions (aka Streaming API), implementation for JSON

There is a newer version: 2.17.0

package com.fasterxml.jackson.core;

import com.fasterxml.jackson.core.util.JacksonFeature;

/**
 * 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.
 *
 * Since 2.12 this is more of an extra marker feature, as its core API is now
 * defined in more general {@link JacksonFeature}.
 * 
 * @since 2.6
 */
public interface FormatFeature
    extends JacksonFeature // since 2.12
{
    /**
     * Accessor for checking whether this feature is enabled by default.
     */
    @Override
    public boolean enabledByDefault();
    
    /**
     * Returns bit mask for this feature instance; must be a single bit,
     * that is of form (1 << N)
     */
    @Override
    public int getMask();

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