de.mvbonline.tools.restapidoc.doclet.model.ClassDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of restapi-doc Show documentation

Creates documentation for a spring mvc RESTful api. Output is reStructuredText for sphinx using sphinxcontrib.httpdomain

The newest version!

package de.mvbonline.tools.restapidoc.doclet.model;

import java.io.Serializable;
import java.util.LinkedList;
import java.util.List;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;

/**
 * Model for javadoc comments on a class.
 *
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType
public class ClassDescription extends ElementDescription implements Serializable {

    @XmlAttribute
    private String fullClassName;

    @XmlElement
    private List properties;

    @XmlElement
    private List methods;

    public void addMethod(MethodDescription doc) {
        if (this.methods == null) {
            this.methods = new LinkedList();
        }
        this.methods.add(doc);
    }

    public void addProperty(ElementDescription doc) {
        if (this.properties == null) {
            this.properties = new LinkedList();
        }
        this.properties.add(doc);
    }

    public String getFullClassName() {
        return fullClassName;
    }

    public List getMethods() {
        return methods;
    }

    public List getProperties() {
        return properties;
    }

    public void setFullClassName(String fullClassName) {
        this.fullClassName = fullClassName;
    }

    public void setMethods(List methods) {
        this.methods = methods;
    }

    public void setProperties(List properties) {
        this.properties = properties;
    }
}