org.jboss.jdeparser.AbstractJDocComment Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2014 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");a
 * 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 org.jboss.jdeparser;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * @author David M. Lloyd
 */
abstract class AbstractJDocComment extends AbstractJHtmlComment implements JDocComment {

    private Map> docTags;

    public JDocComment block() {
        return (JDocComment) super.block();
    }

    public JDocComment sp() {
        super.sp();
        return this;
    }

    public JDocComment nl() {
        super.nl();
        return this;
    }

    public JDocComment typeName(final JType type) {
        super.typeName(type);
        return this;
    }

    public JDocComment text(final String text) {
        super.text(text);
        return this;
    }

    public JDocComment inlineDocTag(final String tag, final String body) {
        super.inlineDocTag(tag, body);
        return this;
    }

    public JDocComment docRoot() {
        super.docRoot();
        return this;
    }

    public JDocComment p() {
        super.p();
        return this;
    }

    public JDocComment br() {
        super.br();
        return this;
    }

    public JDocComment value(final JType type, final String fieldName) {
        super.value(type, fieldName);
        return this;
    }

    public JHtmlComment docTag(final String tag) {
        Map> docTags = this.docTags;
        if (docTags == null) {
            docTags = this.docTags = new LinkedHashMap<>();
        }
        List tagList = docTags.get(tag);
        if (tagList == null) {
            docTags.put(tag, tagList = new ArrayList());
        }
        DocTagJHtmlComment tagComment = new DocTagJHtmlComment(tag);
        tagList.add(tagComment);
        return tagComment;
    }

    public JHtmlComment docTag(final String tag, final String firstWord) {
        JHtmlComment docTag = docTag(tag);
        docTag.text(firstWord).sp();
        return docTag;
    }

    public JHtmlComment _return() {
        return docTag("return");
    }

    public JHtmlComment _throws(final JType exceptionType) {
        return docTag("throws");
    }

    public JHtmlComment param(final String name) {
        return docTag("param", name);
    }

    Map> getDocTags() {
        return docTags;
    }
}