aboutsummaryrefslogtreecommitdiffstats
path: root/javaparser-core/src/main/java/com/github/javaparser/ast/body/TypeDeclaration.java
blob: 9a832db6803b54af5c0cbd171fc5e1ffef383389 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*
 * Copyright (C) 2007-2010 Júlio Vilmar Gesser.
 * Copyright (C) 2011, 2013-2016 The JavaParser Team.
 *
 * This file is part of JavaParser.
 * 
 * JavaParser can be used either under the terms of
 * a) the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 * b) the terms of the Apache License 
 *
 * You should have received a copy of both licenses in LICENCE.LGPL and
 * LICENCE.APACHE. Please refer to those files for details.
 *
 * JavaParser is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 */
 
package com.github.javaparser.ast.body;

import com.github.javaparser.Range;
import com.github.javaparser.ast.Modifier;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.comments.JavadocComment;
import com.github.javaparser.ast.expr.AnnotationExpr;
import com.github.javaparser.ast.expr.SimpleName;
import com.github.javaparser.ast.nodeTypes.NodeWithJavaDoc;
import com.github.javaparser.ast.nodeTypes.NodeWithMembers;
import com.github.javaparser.ast.nodeTypes.NodeWithModifiers;
import com.github.javaparser.ast.nodeTypes.NodeWithSimpleName;
import com.github.javaparser.ast.observing.ObservableProperty;

import java.util.EnumSet;
import java.util.LinkedList;
import java.util.List;

import static com.github.javaparser.utils.Utils.assertNotNull;

/**
 * @author Julio Vilmar Gesser
 */
public abstract class TypeDeclaration<T extends Node> extends BodyDeclaration<T> implements 
        NodeWithSimpleName<T>, 
        NodeWithJavaDoc<T>, 
        NodeWithModifiers<T>, 
        NodeWithMembers<T> {

	private SimpleName name;

    private EnumSet<Modifier> modifiers;

    private NodeList<BodyDeclaration<?>> members;

	public TypeDeclaration() {
		this(null,
                new NodeList<>(),
                EnumSet.noneOf(Modifier.class),
                new SimpleName(),
                new NodeList<>());
	}

    public TypeDeclaration(EnumSet<Modifier> modifiers, String name) {
        this(null,
                new NodeList<>(),
                modifiers,
                new SimpleName(name),
                new NodeList<>());
	}

	public TypeDeclaration(NodeList<AnnotationExpr> annotations,
                           EnumSet<Modifier> modifiers, SimpleName name,
                           NodeList<BodyDeclaration<?>> members) {
        this(null,
                annotations,
                modifiers,
                name,
                members);
	}

	public TypeDeclaration(Range range, NodeList<AnnotationExpr> annotations,
                           EnumSet<Modifier> modifiers, SimpleName name,
                           NodeList<BodyDeclaration<?>> members) {
		super(range, annotations);
		setName(name);
		setModifiers(modifiers);
		setMembers(members);
	}

	/**
	 * Adds the given declaration to the specified type.
	 *
	 * @param decl
	 *            member declaration
	 */
	public TypeDeclaration<T> addMember(BodyDeclaration<?> decl) {
		NodeList<BodyDeclaration<?>> members = getMembers();
		members.add(decl);
		return this;
	}

	@Override
	public NodeList<BodyDeclaration<?>> getMembers() {
		return members;
	}

	/**
     * Return the modifiers of this type declaration.
     * 
     * @see Modifier
     * @return modifiers
     */
	@Override
    public final EnumSet<Modifier> getModifiers() {
		return modifiers;
	}

    @SuppressWarnings("unchecked")
    @Override
    public T setMembers(NodeList<BodyDeclaration<?>> members) {
        notifyPropertyChange(ObservableProperty.MEMBERS, this.members, members);
		this.members = assertNotNull(members);
		setAsParentNodeOf(this.members);
        return (T) this;
	}

    @SuppressWarnings("unchecked")
    @Override
    public T setModifiers(EnumSet<Modifier> modifiers) {
        notifyPropertyChange(ObservableProperty.MODIFIERS, this.modifiers, modifiers);
		this.modifiers = assertNotNull(modifiers);
        return (T) this;
	}

	@Override
    public T setName(SimpleName name) {
		notifyPropertyChange(ObservableProperty.NAME, this.name, name);
		this.name = assertNotNull(name);
		setAsParentNodeOf(name);
        return (T) this;
	}

	@Override
	public final SimpleName getName() {
		return name;
	}

	@Override
	public JavadocComment getJavaDoc() {
		if(getComment() instanceof JavadocComment){
			return (JavadocComment) getComment();
		}
		return null;
	}

    @Override
    public List<NodeList<?>> getNodeLists() {
        List<NodeList<?>> res = new LinkedList<>(super.getNodeLists());
        res.add(members);
        return res;
    }
}