com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule.java Source code

Introduction

Here is the source code for com.phoenixnap.oss.ramlapisync.generation.rules.basic.ClassFieldDeclarationRule.java

Source

/*
 * Copyright 2002-2016 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 com.phoenixnap.oss.ramlapisync.generation.rules.basic;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.util.StringUtils;

import com.phoenixnap.oss.ramlapisync.data.ApiResourceMetadata;
import com.phoenixnap.oss.ramlapisync.generation.rules.Rule;
import com.sun.codemodel.JDefinedClass;
import com.sun.codemodel.JFieldVar;
import com.sun.codemodel.JMod;

/**
 * Creates a private field declaration for a RestTemplateClass with a Spring {@literal @}Autowired annotation or a {@literal @}Value
 * annotation with a customizable value.
 * 
 * The name of the field can be injected by the caller. Default is "restTemplate".
 *
 * EXAMPLE OUTPUT:
 * {@literal @}Autowired
 * BaseClass className;
 * 
 * or 
 * 
 * {@literal @}Value("${some.value}"
 * String className
 *
 * @author kurtpa
 * @author krisg
 * @since 0.5.0
 */
public class ClassFieldDeclarationRule implements Rule<JDefinedClass, JFieldVar, ApiResourceMetadata> {

    private String fieldName = "restTemplate";

    private Class<?> fieldClazz;

    private boolean autowire = true;

    private boolean valueAnnotation = false;

    private boolean qualifierAnnotation = false;

    private String qualifier;

    private String valueAnnotationValue;

    public ClassFieldDeclarationRule(String restTemplateFieldName, Class<?> fieldClazz,
            String valueAnnotationValue) {
        this(restTemplateFieldName, fieldClazz);
        this.autowire = false;
        this.valueAnnotation = true;
        this.valueAnnotationValue = valueAnnotationValue;
    }

    public ClassFieldDeclarationRule(String restTemplateFieldName, Class<?> fieldClazz, boolean autowire) {
        this(restTemplateFieldName, fieldClazz);
        this.autowire = autowire;
    }

    public ClassFieldDeclarationRule(String restTemplateFieldName, Class<?> fieldClazz, boolean autowire,
            String qualifierBeanName) {
        this(restTemplateFieldName, fieldClazz);
        if (qualifierBeanName != null) {
            this.qualifierAnnotation = true;
            this.qualifier = qualifierBeanName;
        }
        this.autowire = autowire;
    }

    public ClassFieldDeclarationRule(String restTemplateFieldName, Class<?> fieldClazz) {
        if (fieldClazz != null) {
            this.fieldClazz = fieldClazz;
        } else {
            throw new IllegalStateException("Class not specified");
        }
        if (StringUtils.hasText(restTemplateFieldName)) {
            this.fieldName = restTemplateFieldName;
        } else {
            this.fieldName = StringUtils.unqualify(fieldClazz.getSimpleName());
        }

    }

    @Override
    public JFieldVar apply(ApiResourceMetadata controllerMetadata, JDefinedClass generatableType) {
        JFieldVar field = generatableType.field(JMod.PRIVATE, this.fieldClazz, this.fieldName);

        //add @Autowired field annoation
        if (autowire) {
            field.annotate(Autowired.class);
        }

        //add @Qualifier("qualifierBeanName")
        if (qualifierAnnotation && !StringUtils.isEmpty(qualifier)) {
            field.annotate(Qualifier.class).param("value", qualifier);
        }

        //add @Value(value="") annotation to the field 
        if (valueAnnotation) {
            field.annotate(Value.class).param("value", valueAnnotationValue);
        }
        return field;
    }
}