org.dominokit.jacksonapt.ser.bean.AbstractIdentitySerializationInfo Maven / Gradle / Ivy

Go to download

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

Apt based jackson

The newest version!

/*
 * Copyright 2013 Nicolas Morel
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.dominokit.jacksonapt.ser.bean;

import org.dominokit.jacksonapt.JsonSerializationContext;
import org.dominokit.jacksonapt.JsonSerializer;

/**
 * Contains identity informations for serialization process.
 *
 * @author Nicolas Morel
 * @version $Id: $
 */
public abstract class AbstractIdentitySerializationInfo extends HasSerializer> implements IdentitySerializationInfo {

    /**
     * if we always serialize the bean as an id even for the first encounter.
     */
    private final boolean alwaysAsId;

    /**
     * Name of the property holding the identity
     */
    private final String propertyName;

    /**
     * Constructor for AbstractIdentitySerializationInfo.
     *
     * @param alwaysAsId   a boolean.
     * @param propertyName a {@link java.lang.String} object.
     */
    protected AbstractIdentitySerializationInfo(boolean alwaysAsId, String propertyName) {
        this.alwaysAsId = alwaysAsId;
        this.propertyName = propertyName;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isAlwaysAsId() {
        return alwaysAsId;
    }

    /** {@inheritDoc} */
    @Override
    public boolean isProperty() {
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public String getPropertyName() {
        return propertyName;
    }

    /** {@inheritDoc} */
    @Override
    public abstract ObjectIdSerializer getObjectId(T bean, JsonSerializationContext ctx);
}