com.basistech.rosette.apimodel.Response Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rosette-api-model Show documentation

Rosette API data models

There is a newer version: 1.31.0

/*
* Copyright 2017 Basis Technology Corp.
*
* 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 com.basistech.rosette.apimodel;

import lombok.EqualsAndHashCode;
import lombok.Getter;

import java.util.HashMap;
import java.util.Map;

/**
 * Base class for all responses.
 * In this version, they have nothing in common.
 */
@Getter
@EqualsAndHashCode
public abstract class Response {
    /**
     * @return extended information
     */
    protected Map extendedInformation;

    /**
     * add more extended information to the response
     * @param key
     * @param value
     */
    public void addExtendedInformation(String key, Object value) {
        if (extendedInformation == null) {
            extendedInformation = new HashMap<>();
        }
        extendedInformation.put(key, value);
    }
}