io.openapitools.jackson.dataformat.hal.HALMapper Maven / Gradle / Ivy

Go to download

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

Dataformat extension for Jackson to handle the HAL JSON format.

There is a newer version: 1.0.9

Show newest version

package io.openapitools.jackson.dataformat.hal;

import com.fasterxml.jackson.databind.ObjectMapper;

/**
 * Customized {@link ObjectMapper} that will serialize objects into the HAL format if properly annotated.
 */
public class HALMapper extends ObjectMapper {
    protected static final JacksonHALModule DEFAULT_HAL_MODULE = new JacksonHALModule();
    
    /**
     * Create new HAL mapper with default configuration.
     */
    public HALMapper() {
        registerModule(DEFAULT_HAL_MODULE);
    }
    
    /**
     * Copy constructor to support {@link #copy()}.
     * @param mapper Mapper to copy.
     */
    public HALMapper(HALMapper mapper) {
        super(mapper);
        registerModule(DEFAULT_HAL_MODULE);
    }
    
    @Override
    public ObjectMapper copy() {
        return new HALMapper(this);
    }
}