com.linecorp.armeria.server.docs.FieldInfo.java Source code

Introduction

Here is the source code for com.linecorp.armeria.server.docs.FieldInfo.java

Source

/*
 * Copyright 2015 LINE Corporation
 *
 * LINE Corporation 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 com.linecorp.armeria.server.docs;

import static java.util.Objects.requireNonNull;

import java.util.Collections;
import java.util.Map;
import java.util.Objects;

import javax.annotation.Nullable;

import org.apache.thrift.meta_data.FieldMetaData;

import com.fasterxml.jackson.annotation.JsonProperty;

class FieldInfo {

    static FieldInfo of(FieldMetaData fieldMetaData) {
        return of(fieldMetaData, null, Collections.emptyMap());
    }

    static FieldInfo of(FieldMetaData fieldMetaData, @Nullable String namespace, Map<String, String> docStrings) {
        requireNonNull(fieldMetaData, "fieldMetaData");
        final String docStringKey = ThriftDocString.key(namespace, fieldMetaData.fieldName);
        return new FieldInfo(fieldMetaData.fieldName, RequirementType.of(fieldMetaData.requirementType),
                TypeInfo.of(fieldMetaData.valueMetaData, namespace, docStrings), docStrings.get(docStringKey));
    }

    static FieldInfo of(String name, RequirementType requirementType, TypeInfo type) {
        return of(name, requirementType, type, null, Collections.emptyMap());
    }

    static FieldInfo of(String name, RequirementType requirementType, TypeInfo type, @Nullable String namespace,
            Map<String, String> docStrings) {
        final String docStringKey = ThriftDocString.key(namespace, name);
        return new FieldInfo(name, requirementType, type, docStrings.get(docStringKey));
    }

    private final String name;
    private final RequirementType requirementType;
    private final TypeInfo type;
    private final String docString;

    private FieldInfo(String name, RequirementType requirementType, TypeInfo type, @Nullable String docString) {
        this.name = requireNonNull(name, "name");
        this.requirementType = requireNonNull(requirementType, "requirementType");
        this.type = requireNonNull(type, "type");
        this.docString = docString;
    }

    @JsonProperty
    public String name() {
        return name;
    }

    @JsonProperty
    public RequirementType requirementType() {
        return requirementType;
    }

    @JsonProperty
    public TypeInfo type() {
        return type;
    }

    @JsonProperty
    public String docString() {
        return docString;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        FieldInfo fieldInfo = (FieldInfo) o;
        return Objects.equals(name, fieldInfo.name) && Objects.equals(requirementType, fieldInfo.requirementType)
                && Objects.equals(type, fieldInfo.type);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name, requirementType, type);
    }

    @Override
    public String toString() {
        return "FieldInfo{" + "name='" + name + '\'' + ", requirementType=" + requirementType + ", type=" + type
                + '}';
    }
}