dk.jyskebank.tools.enunciate.modules.openapi.paths.Param Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2017-2018 Jyske Bank
 *
 * 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 dk.jyskebank.tools.enunciate.modules.openapi.paths;

import static dk.jyskebank.tools.enunciate.modules.openapi.yaml.YamlHelper.safeYamlString;

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

import com.webcohesion.enunciate.EnunciateLogger;
import com.webcohesion.enunciate.api.resources.Parameter;

import dk.jyskebank.tools.enunciate.modules.openapi.DataTypeReferenceRenderer;
import dk.jyskebank.tools.enunciate.modules.openapi.ObjectTypeRenderer;
import dk.jyskebank.tools.enunciate.modules.openapi.yaml.YamlHelper;

public class Param {
  private static final String SIMPLE = "simple";
  private static final String FORM = "form";
  private static final String QUERY = "query";
  private static final String PATH = "path";
  private static final String MATRIX = "matrix";
  private static final String HEADER = "header";
  private static final String COOKIE = "cookie";
  private final Parameter parameter;
  private final ParameterRenderer renderer;
  private final boolean required;
  private String paramPassedIn;
  private String paramStyle;

  private static final Map typeLabel2in = new HashMap<>();
  static {
    typeLabel2in.put(COOKIE, COOKIE);
    typeLabel2in.put(HEADER, HEADER);
    typeLabel2in.put(MATRIX, PATH);
    typeLabel2in.put(PATH, PATH);
    typeLabel2in.put(QUERY, QUERY);
    typeLabel2in.put(FORM, QUERY);
  }

  private static final Map typeLabel2style = new HashMap<>();
  static {
    typeLabel2style.put(COOKIE, FORM);
    typeLabel2style.put(HEADER, SIMPLE);
    typeLabel2style.put(MATRIX, MATRIX);
    typeLabel2style.put(PATH, SIMPLE);
    typeLabel2style.put(QUERY, FORM);
    typeLabel2style.put(FORM, FORM);
  }

  public Param(EnunciateLogger logger, DataTypeReferenceRenderer dataTypeReferenceRenderer, ObjectTypeRenderer objectTypeRenderer, Parameter parameter) {
    this.parameter = parameter;
    
    renderer = new ParameterRenderer(logger, dataTypeReferenceRenderer, objectTypeRenderer, parameter);
    String typeLabel = parameter.getTypeLabel();
    paramPassedIn = typeLabel2in.get(typeLabel);
    paramStyle = typeLabel2style.get(typeLabel);
    
    if (paramPassedIn == null) {
      throw new IllegalStateException("Do not know how to pass type " + typeLabel);
    }
    if (paramStyle == null) {
      throw new IllegalStateException("Do not know style to use with type " + typeLabel);
    }

    required = PATH.equals(paramPassedIn);
  }

  public String getName() {
    return safeYamlString(parameter.getName());
  }

  public String getInFormat() {
    return paramPassedIn;
  }
  
  public String getDescription() {
    return YamlHelper.safeYamlString(parameter.getDescription());
  }

  public String getRequired() {
    return Boolean.toString(required);
  }
  
  public ParameterRenderer getRenderDataType() {
    return renderer;
  }
  
  public String getStyle() {
    return paramStyle;
  }
}