AnnotationBasedResourceGroupImpl.java

/**
 * Copyright © 2006-2016 Web Cohesion (info@webcohesion.com)
 *
 * 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.webcohesion.enunciate.modules.jaxrs.api.impl;

import com.webcohesion.enunciate.api.PathSummary;
import com.webcohesion.enunciate.api.resources.Method;
import com.webcohesion.enunciate.api.resources.Resource;
import com.webcohesion.enunciate.api.resources.ResourceGroup;
import com.webcohesion.enunciate.facets.Facet;
import com.webcohesion.enunciate.javac.TypeElementComparator;
import com.webcohesion.enunciate.javac.javadoc.DefaultJavaDocTagHandler;
import com.webcohesion.enunciate.javac.javadoc.JavaDoc;
import com.webcohesion.enunciate.util.PathSortStrategy;
import com.webcohesion.enunciate.util.PathSummaryComparator;

import javax.lang.model.element.AnnotationMirror;
import java.lang.annotation.Annotation;
import java.util.*;

/**
 * @author Ryan Heaton
 */
public class AnnotationBasedResourceGroupImpl implements ResourceGroup {

  private final String contextPath;
  private final String label;
  private final List<Resource> resources;
  private final PathSortStrategy sortStrategy;

  public AnnotationBasedResourceGroupImpl(String contextPath, String label, List<Resource> resources, PathSortStrategy sortStrategy) {
    this.contextPath = contextPath;
    this.label = label;
    this.resources = resources;
    this.sortStrategy = sortStrategy;
  }

  @Override
  public String getSlug() {
    return "resource_" + scrubLabelForSlug(label);
  }

  @Override
  public String getRelativeContextPath() {
    return this.contextPath;
  }

  @Override
  public String getLabel() {
    return this.label;
  }

  @Override
  public String getSortKey() {
    return this.label;
  }

  @Override
  public String getDescription() {
    //we'll return a description if all descriptions of all methods are the same, or if there's only one defining resource class.
    String description = null;
    Set<com.webcohesion.enunciate.modules.jaxrs.model.Resource> definingResourceClasses = new TreeSet<com.webcohesion.enunciate.modules.jaxrs.model.Resource>(new TypeElementComparator());
    RESOURCES : for (Resource resource : this.resources) {
      for (Method method : resource.getMethods()) {
        if (description != null && method.getDescription() != null && !description.equals(method.getDescription())){
          description = null;
          break RESOURCES;
        }

        description = method.getDescription();
        if (description != null && description.trim().isEmpty()) {
          description = null;
        }
      }

      if (resource instanceof ResourceImpl) {
        definingResourceClasses.add(((ResourceImpl) resource).resourceMethod.getParent());
      }
    }

    if (definingResourceClasses.size() == 1) {
      description = definingResourceClasses.iterator().next().getDocValue();
    }

    return description;
  }

  @Override
  public String getDeprecated() {
    String deprecated = null;
    for (Resource resource : this.resources) {
      deprecated = resource.getDeprecated();
      if (deprecated == null) {
        //if _any_ resources are not deprecated, this resource group isn't deprecated either.
        return null;
      }
    }
    return deprecated;
  }

  @Override
  public List<PathSummary> getPaths() {
    HashMap<String, PathSummary> paths = new HashMap<String, PathSummary>();
    for (Resource resource : this.resources) {
      PathSummary pathSummary = paths.get(resource.getPath());
      if (pathSummary == null) {
        pathSummary = new PathSummaryImpl(resource.getPath(), new TreeSet<String>(), resource.getStyles());
        paths.put(resource.getPath(), pathSummary);
      }

      for (Method method : resource.getMethods()) {
        pathSummary.getMethods().add(method.getHttpMethod());
      }
    }
    ArrayList<PathSummary> pathSummaries = new ArrayList<PathSummary>(paths.values());
    Collections.sort(pathSummaries, new PathSummaryComparator(sortStrategy));
    return pathSummaries;
  }

  @Override
  public List<Resource> getResources() {
    return this.resources;
  }

  private static String scrubLabelForSlug(String facetValue) {
    return facetValue.replace('/', '_').replace(':', '_').replace('{', '_').replace('}', '_').replace(' ', '_');
  }

  @Override
  public <A extends Annotation> A getAnnotation(Class<A> annotationType) {
    return null;
  }

  @Override
  public Map<String, AnnotationMirror> getAnnotations() {
    return Collections.emptyMap();
  }

  @Override
  public Set<Facet> getFacets() {
    TreeSet<Facet> facets = new TreeSet<Facet>();
    for (Resource resource : this.resources) {
      facets.addAll(resource.getFacets());
    }
    return facets;
  }

  @Override
  public JavaDoc getJavaDoc() {
    return JavaDoc.EMPTY;
  }

  @Override
  public Set<String> getStyles() {
    TreeSet<String> styles = new TreeSet<String>();
    for (Resource resource : this.resources) {
      styles.addAll(resource.getStyles());
    }
    return styles;
  }
}