info.leadinglight.umljavadoclet.printer.DiagramOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of uml-java-doclet Show documentation
Add UML diagrams (using PlantUML) to Javadocs. Extends the standard Java doclet.
The newest version!
package info.leadinglight.umljavadoclet.printer;

/**
 * Handle options specific to uml-java-doclet.
 */
public class DiagramOptions {
    public DiagramOptions() {
        // Defaults
        _lineType = LineType.ORTHO;
        _dependenciesVisibility = Visibility.PUBLIC;
    }
    
    // LineType
    
    public enum LineType { SPLINE, POLYLINE, ORTHO };
    
    public LineType getLineType() {
        return _lineType;
    }
    
    public void setLineType(LineType lineType) {
        _lineType = lineType;
    }
    
    public void setLineType(String[] option) {
        if (option[0].equals(OPTION_LINE_TYPE)) {
            if (option[1].equals(OPTION_LINE_TYPE_ORTHO)) {
                setLineType(DiagramOptions.LineType.ORTHO);
            } else if (option[1].equals(OPTION_LINE_TYPE_POLYLINE)) {
                setLineType(DiagramOptions.LineType.POLYLINE);
            } else if (option[1].equals(OPTION_LINE_TYPE_SPLINE)) {
                setLineType(DiagramOptions.LineType.SPLINE);
            }
        }
    }
    
    public static String checkLineType(String[] option) {
        if (option[0].equals(OPTION_LINE_TYPE)) {
            if (!option[1].equals(OPTION_LINE_TYPE_ORTHO) && 
                    !option[1].equals(OPTION_LINE_TYPE_POLYLINE) &&
                    !option[1].equals(OPTION_LINE_TYPE_SPLINE)) {
                return "Invalid line type: ortho (default), polyline, or spline).";
            }
        }
        return null;
    }
    
    private LineType _lineType;

    private static final String OPTION_LINE_TYPE = "-linetype";
    private static final String OPTION_LINE_TYPE_ORTHO = "ortho";
    private static final String OPTION_LINE_TYPE_POLYLINE = "polyline";
    private static final String OPTION_LINE_TYPE_SPLINE = "spline";
    
    // Dependencies 
    
    public enum Visibility { PUBLIC, PROTECTED, PACKAGE, PRIVATE };
    
    public Visibility getDependenciesVisibility() {
        return _dependenciesVisibility;
    }
    
    public void setDependenciesVisibility(Visibility visibility) {
        _dependenciesVisibility = visibility;
    }
    
    public void setDependenciesVisibility(String[] option) {
        if (option[0].equals(OPTION_DEPENDENCIES)) {
            if (option[1].equals(OPTION_DEPENDENCIES_PUBLIC)) {
                setDependenciesVisibility(DiagramOptions.Visibility.PUBLIC);
            } else if (option[1].equals(OPTION_DEPENDENCIES_PROTECTED)) {
                setDependenciesVisibility(DiagramOptions.Visibility.PROTECTED);
            } else if (option[1].equals(OPTION_DEPENDENCIES_PACKAGE)) {
                setDependenciesVisibility(DiagramOptions.Visibility.PACKAGE);
            } else if (option[1].equals(OPTION_DEPENDENCIES_PRIVATE)) {
                setDependenciesVisibility(DiagramOptions.Visibility.PRIVATE);
            }
        }
    }
    
    public static String checkDependenciesVisibility(String[] option) {
        if (option[0].equals(OPTION_DEPENDENCIES)) {
            if (!option[1].equals(OPTION_DEPENDENCIES_PUBLIC) && 
                    !option[1].equals(OPTION_DEPENDENCIES_PROTECTED) &&
                    !option[1].equals(OPTION_DEPENDENCIES_PACKAGE) &&
                    !option[1].equals(OPTION_DEPENDENCIES_PRIVATE)) {
                return "Invalid dependencies: public (default), protected, package, or private.";
            }
        }
        return null;
    }
    
    private Visibility _dependenciesVisibility;

    private static final String OPTION_DEPENDENCIES = "-dependencies";
    private static final String OPTION_DEPENDENCIES_PUBLIC = "public";
    private static final String OPTION_DEPENDENCIES_PROTECTED = "protected";
    private static final String OPTION_DEPENDENCIES_PACKAGE = "package";
    private static final String OPTION_DEPENDENCIES_PRIVATE = "private";
    
    /**
     * Set the options as provided in the strings.
     * Invalid options are ignored.
     * @param options Options provided in javadoc format for options: an array of string arrays, each
     * array indicating the name of the option (index 0) and the associated options.
     */
    public void set(String[][] options) {
        for (String[] option: options) {
            setLineType(option);
            setDependenciesVisibility(option);
        }
    }
    
    /**
     * Check to see if the specified option is valid.
     * @param option Option to check.
     * @return Whether or not the option is valid.
     */
    public static boolean isValidOption(String option) {
        return option.equals(OPTION_LINE_TYPE) || option.equals(OPTION_DEPENDENCIES);
    }
    
    /**
     * Get the number of parameters for the specified option.
     * @param option Option to get parameters for.
     * @return Number of parameters.
     */
    public static int getOptionLength(String option) {
        if (option.equals(OPTION_LINE_TYPE)) {
            return 2;
        } else if (option.equals(OPTION_DEPENDENCIES)) {
            return 2;
        } else {
            return 0;
        }
    }
    
    public static String checkOption(String[] option) {
        String error = checkLineType(option);
        if (error != null && error.length() > 0) {
            return error;
        }
        return null;
    }
}