JsDoc.java

package com.eas.script;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.StringTokenizer;

/**
 *
 * @author vv
 */
public class JsDoc {

    private String body;
    private String[] lines;
    private Tag tag;
    private final List<Tag> tags = new ArrayList<>();

    public JsDoc(String aBody) {
        if (aBody == null) {
            throw new IllegalArgumentException("JsDoc body is null.");
        }
        body = aBody;
        String[] rawLines = body.split("\n"); //NOI18N
        lines = new String[rawLines.length];
        for (int i = 0; i < lines.length; i++) {
            lines[i] = trimLeading(rawLines[i]);
        }
    }

    public String getBody() {
        return body;
    }

    public List<Tag> getAnnotations() {
        return Collections.unmodifiableList(tags);
    }

    public boolean containsTag(String name) {
        return Tag.getTagWithName(tags, name) != null;
    }

    public Tag getTag(String name) {
        return Tag.getTagWithName(tags, name);
    }

    public void parseAnnotations() {
        for (String line : lines) {
            if (line.startsWith("@")) { //NOI18N
                // Split whith all whitespace characters
                String[] annotationTokens = line.split("[\\s,]+"); //NOI18N
                String annotationName = annotationTokens[0];
                String annotationText = line.substring(annotationName.length()).trim();
                tag = new Tag(annotationName, annotationText);
                tags.add(tag);
            }
        }
    }

    private static String trimLeading(String source) {
        return trimLeading(source.trim(), '*').trim();
    }

    private static String trimLeading(String source, char symbol) {
        for (int i = 0; i < source.length(); ++i) {
            char c = source.charAt(i);
            if (c != symbol) {
                return source.substring(i);
            }
        }
        return source;
    }

    /**
     * An JsDoc tag, can be used as annotation
     */
    public static class Tag {

        /**
         * Author tag
         */
        public static final String AUTHOR_TAG = "@author";

        /**
         * Annotation for defining application element's name.
         */
        public static final String NAME_TAG = "@name";
        /**
         * Annotation marks a module as a protocol acceptor Example:
         *
         * @protocol asc6, asc2
         */
        public static final String ACCEPTOR_TAG = "@acceptor";
        public static final String ACCEPTED_PROTOCOL_TAG = "@protocol";

        /**
         * Annotation marks a module as an extra rols mapper
         */
        public static final String VALIDATOR_TAG = "@validator";
        /**
         * Annotation marks a module as resident server task of system session
         */
        public static final String RESIDENT_TAG = "@resident";
        /**
         * Annotation marks a module or top level function access restrictions
         * for specific roles example:
         *
         * @rolesAllowed admin, manager
         */
        public static final String ROLES_ALLOWED_TAG = "@rolesallowed";
        public static final String ROLES_ALLOWED_READ_TAG = "@rolesallowedread";
        public static final String ROLES_ALLOWED_WRITE_TAG = "@rolesallowedwrite";
        /**
         * Annotation marks query entity undelying table readonly for changes
         * made on entity.
         */
        public static final String READONLY_TAG = "@readonly";
        /**
         * Annotation marks query entity undelying tables writable for changes
         * made on entity.
         */
        public static final String WRITABLE_TAG = "@writable";
        public static final String PROCEDURE_TAG = "@procedure";
        /**
         * Annotation marks module accessible for external execution (for
         * example using HTTP).
         */
        public static final String PUBLIC_TAG = "@public";
        /**
         * Annotation marks module as stateless.
         */
        public static final String STATELESS_TAG = "@stateless";
        /**
         * Annotation marks module as a WebSocket endpoint. Incompatible with
         *
         * @stateless and @resident WebSocket endpoint are session modules by
         * Java EE design.
         */
        public static final String WEBSOCKET_TAG = "@websocket";

        private final String name;
        private final String text;
        private List<String> params;

        public Tag(String aName, String aText) {
            name = aName;
            text = aText;
        }

        public String getName() {
            return name;
        }

        public String getText() {
            return text;
        }

        public List<String> getParams() {
            if (params == null) {
                params = parseParams();
            }
            return Collections.unmodifiableList(params);
        }

        /**
         * Utility method for checking if a tag with some name is in the list.
         *
         * @param aTags Tags list
         * @param aTagName Tag's name
         * @return True if there is a tag with provided name
         */
        public static Tag getTagWithName(List<Tag> aTags, String aTagName) {
            if (aTags != null) {
                for (Tag tag : aTags) {
                    if (tag.getName().equals(aTagName)) {
                        return tag;
                    }
                }
                return null;
            } else {
                throw new NullPointerException("Tag list is null.");
            }
        }

        @Override
        public String toString() {
            return name + (text != null ? " " + text : "");
        }

        private List<String> parseParams() {
            StringTokenizer st = new StringTokenizer(text, " \t\n\r\f,"); //NOI18N
            List<String> items = new ArrayList<>();
            while (st.hasMoreTokens()) {
                items.add(st.nextToken());
            }
            return items;
        }
    }
}