ProtoStringFeature.java

/*
 * Copyright 2022 Proto Utils Authors
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you 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 net.morimekta.proto.jackson;

import com.fasterxml.jackson.databind.DeserializationConfig;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;

/**
 * Proto specific string-valued features used to configure jackson
 * serialization. These are technically 'attributes' on the
 * serialization config.
 */
public enum ProtoStringFeature {
    /**
     * When serializing Any as unpacked objects, use this field name for the
     * type. Defaults to same as default JsonFormat.
     */
    ANY_TYPE_FIELD_NAME("@type"),
    /**
     * When serializing Any as unpacked objects, use this prefix before the
     * full name of the type. Defaults to same as proto default for Any.
     */
    ANY_TYPE_PREFIX("type.googleapis.com/")
    ;
    private final String defaultValue;

    ProtoStringFeature(String defaultValue) {
        this.defaultValue = defaultValue;
    }

    /**
     * @param mapper The mapper to set value on.
     * @param value The value to be set for this feature.
     * @return The mapper.
     */
    public ObjectMapper set(ObjectMapper mapper, String value) {
        mapper.setConfig(mapper.getSerializationConfig().withAttribute(this, value));
        mapper.setConfig(mapper.getDeserializationConfig().withAttribute(this, value));
        return mapper;
    }

    /**
     * @param sp The serializer provider.
     * @return The feature value, or default if not set.
     */
    public String get(SerializerProvider sp) {
        Object o = sp.getAttribute(this);
        if (o == null) {
            return defaultValue;
        }
        return o.toString();
    }

    /**
     * @param config The deserialization config.
     * @return The feature value, or default if not set.
     */
    public String get(DeserializationConfig config) {
        Object o = config.getAttributes().getAttribute(this);
        if (o == null) {
            return defaultValue;
        }
        return o.toString();
    }
}