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
|
/*
* Copyright 2000-2009 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* 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 com.intellij.psi.impl.source.codeStyle.javadoc;
import org.jetbrains.annotations.NonNls;
import java.util.ArrayList;
/**
* Method comment
*
* @author Dmitry Skavish
*/
public class JDMethodComment extends JDParamListOwnerComment {
public JDMethodComment(CommentFormatter formatter) {
super(formatter);
}
private String returnTag;
private ArrayList<NameDesc> throwsList;
private static final @NonNls String THROWS_TAG = "@throws ";
private static final @NonNls String EXCEPTION_TAG = "@exception ";
@Override
protected void generateSpecial(String prefix, @NonNls StringBuffer sb) {
super.generateSpecial(prefix, sb);
if (returnTag != null) {
if (returnTag.trim().length() != 0 || myFormatter.getSettings().JD_KEEP_EMPTY_RETURN) {
sb.append(prefix);
sb.append("@return ");
sb.append(myFormatter.getParser().splitIntoCLines(returnTag, prefix + " ", false));
if (myFormatter.getSettings().JD_ADD_BLANK_AFTER_RETURN) {
sb.append(prefix);
sb.append('\n');
}
}
}
if (throwsList != null) {
String tag = myFormatter.getSettings().JD_USE_THROWS_NOT_EXCEPTION ? THROWS_TAG : EXCEPTION_TAG;
generateList(prefix, sb, throwsList, tag,
myFormatter.getSettings().JD_ALIGN_EXCEPTION_COMMENTS,
myFormatter.getSettings().JD_MIN_EXCEPTION_NAME_LENGTH,
myFormatter.getSettings().JD_MAX_EXCEPTION_NAME_LENGTH,
myFormatter.getSettings().JD_KEEP_EMPTY_EXCEPTION,
myFormatter.getSettings().JD_PARAM_DESCRIPTION_ON_NEW_LINE
);
}
}
public String getReturnTag() {
return returnTag;
}
public void setReturnTag(String returnTag) {
this.returnTag = returnTag;
}
public void removeThrow(NameDesc nd) {
if (throwsList == null) return;
throwsList.remove(nd);
}
public ArrayList<NameDesc> getThrowsList() {
return throwsList;
}
public void addThrow(String className, String description) {
if (throwsList == null) {
throwsList = new ArrayList<NameDesc>();
}
throwsList.add(new NameDesc(className, description));
}
public NameDesc getThrow(String name) {
return getNameDesc(name, throwsList);
}
public void setThrowsList(ArrayList<NameDesc> throwsList) {
this.throwsList = throwsList;
}
}
|
