com.webcohesion.enunciate.util.ExampleUtils Maven / Gradle / Ivy

Go to download
package com.webcohesion.enunciate.util;

import com.webcohesion.enunciate.EnunciateContext;
import com.webcohesion.enunciate.EnunciateException;
import com.webcohesion.enunciate.api.datatype.Example;
import com.webcohesion.enunciate.api.datatype.Syntax;
import com.webcohesion.enunciate.javac.decorations.element.DecoratedElement;
import com.webcohesion.enunciate.javac.javadoc.JavaDoc;
import com.webcohesion.enunciate.metadata.DocumentationExample;

import java.io.*;
import java.nio.charset.StandardCharsets;

/**
 * @author Ryan Heaton
 */
public class ExampleUtils {

  private ExampleUtils() {}

  public static Example loadCustomExample(Syntax syntax, String tagName, DecoratedElement element, EnunciateContext context) {
    Example example = null;
    JavaDoc.JavaDocTagList tagList = element.getJavaDoc().get(tagName);
    if (tagList != null) {
      for (String value : tagList) {
        int firstSpace = JavaDoc.indexOfFirstWhitespace(value);
        String mediaType = value.substring(0, firstSpace);
        if (syntax.isAssignableToMediaType(mediaType) && (firstSpace + 1) < value.length()) {
          String specifiedExample = value.substring(firstSpace + 1).trim();

          Reader reader;
          try {
            if (specifiedExample.startsWith("classpath:")) {
              String classpathResource = specifiedExample.substring(10);
              if (classpathResource.startsWith("/")) {
                classpathResource = classpathResource.substring(1);
              }
              InputStream resource = context.getResourceAsStream(classpathResource);
              if (resource == null) {
                throw new IllegalArgumentException("Unable to find /" + classpathResource + " on the classpath.");
              }
              reader = new InputStreamReader(resource, StandardCharsets.UTF_8);
            }
            else if (specifiedExample.startsWith("file:")) {
              File file = context.getConfiguration().resolveFile(specifiedExample.substring(5));
              if (!file.exists()) {
                throw new IllegalArgumentException("Unable to find " + specifiedExample.substring(5) + ".");
              }
              reader = new FileReader(file);
            }
            else {
              reader = new StringReader(specifiedExample);
            }
          }
          catch (IOException e) {
            throw new EnunciateException(e);
          }

          try {
            example = syntax.parseExample(reader);
          }
          catch (Exception e) {
            context.getLogger().warn("Unable to parse @%s tag at %s: %s", tagName, example, e.getMessage());
          }
        }
      }
    }
    return example;
  }

  public static boolean isExcluded(DecoratedElement element) {
    final DocumentationExample documentationExample = element.getAnnotation(DocumentationExample.class);
    return documentationExample != null && documentationExample.exclude();
  }
}