springfox.documentation.schema.property.BaseModelProperty.java Source code

Introduction

Here is the source code for springfox.documentation.schema.property.BaseModelProperty.java

Source

/*
 *
 *  Copyright 2015 the original author or authors.
 *
 *  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 springfox.documentation.schema.property;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.classmate.TypeResolver;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.introspect.AnnotatedMember;
import com.fasterxml.jackson.databind.introspect.BeanPropertyDefinition;
import com.google.common.base.Optional;
import springfox.documentation.schema.ResolvedTypes;
import springfox.documentation.service.AllowableValues;
import springfox.documentation.spi.schema.AlternateTypeProvider;

import static com.google.common.base.Optional.*;
import static springfox.documentation.schema.ResolvedTypes.*;

public abstract class BaseModelProperty implements ModelProperty {

    private final String name;
    protected final BeanPropertyDefinition jacksonProperty;
    protected final Optional<JsonFormat> jsonFormatAnnotation;
    protected final TypeResolver resolver;
    protected final AlternateTypeProvider alternateTypeProvider;

    public BaseModelProperty(String name, TypeResolver resolver, AlternateTypeProvider alternateTypeProvider,
            BeanPropertyDefinition jacksonProperty) {
        this.name = name;
        this.resolver = resolver;
        this.alternateTypeProvider = alternateTypeProvider;
        this.jacksonProperty = jacksonProperty;
        AnnotatedMember primaryMember = jacksonProperty.getPrimaryMember();
        if (primaryMember != null) {
            jsonFormatAnnotation = Optional.fromNullable(primaryMember.getAnnotation(JsonFormat.class));
        } else {
            jsonFormatAnnotation = Optional.absent();
        }
    }

    protected abstract ResolvedType realType();

    @Override
    public ResolvedType getType() {
        if (jsonFormatAnnotation.isPresent()) {
            if (jsonFormatAnnotation.get().shape() == JsonFormat.Shape.STRING) {
                return resolver.resolve(String.class);
            }
        }
        return alternateTypeProvider.alternateFor(realType());
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public String qualifiedTypeName() {
        if (getType().getTypeParameters().size() > 0) {
            return getType().toString();
        }
        return simpleQualifiedTypeName(getType());
    }

    @Override
    public AllowableValues allowableValues() {
        Optional<AllowableValues> allowableValues = fromNullable(ResolvedTypes.allowableValues(getType()));
        //Preference to inferred allowable values over list values via ApiModelProperty
        if (allowableValues.isPresent()) {
            return allowableValues.get();
        }
        return null;
    }

    @Override
    public boolean isRequired() {
        return jacksonProperty.isRequired();
    }

    @Override
    public boolean isReadOnly() {
        return !jacksonProperty.hasSetter();
    }

    @Override
    public String propertyDescription() {
        return null;
    }

    @Override
    public int position() {
        return 0;
    }

    public String example() {
        if (jsonFormatAnnotation.isPresent()) {
            if (jsonFormatAnnotation.get().shape() == JsonFormat.Shape.STRING) {
                return jsonFormatAnnotation.get().pattern();
            }
        }
        return null;
    }
}