Skip to content

Commit 4274576

Browse files
committed
Javadoc
1 parent 6a45574 commit 4274576

File tree

6 files changed

+134
-1
lines changed

6 files changed

+134
-1
lines changed

src/main/java/org/apache/commons/jxpath/AbstractFactory.java

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,22 @@
2222
* AbstractFactory for that purpose. Install a factory on JXPathContext by calling {@link JXPathContext#setFactory JXPathContext. setFactory()}.
2323
* <p>
2424
* All methods of this class return false. Override any of them to return true to indicate that the factory has successfully created the described object.
25+
* </p>
2526
*/
2627
public abstract class AbstractFactory {
2728

29+
30+
/**
31+
* Constructs a new instance for subclasses.
32+
*/
33+
public AbstractFactory() {
34+
// empty
35+
}
36+
2837
/**
2938
* The parameters may describe a collection element or an individual object. It is up to the factory to infer which one it is. If it is a collection, the
3039
* factory should check if the collection exists. If not, it should create the collection. Then it should create the index'th element of the collection and
3140
* return true.
32-
* <p>
3341
*
3442
* @param context can be used to evaluate other XPaths, get to variables etc.
3543
* @param pointer describes the location of the node to be created

src/main/java/org/apache/commons/jxpath/BasicNodeSet.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,13 @@ public class BasicNodeSet implements NodeSet {
3131
private List<Pointer> readOnlyPointers;
3232
private List nodes;
3333
private List values;
34+
35+
/**
36+
* Constructs a new instance.
37+
*/
38+
public BasicNodeSet() {
39+
// empty
40+
}
3441

3542
/**
3643
* Add the specified NodeSet to this NodeSet.

src/main/java/org/apache/commons/jxpath/BasicVariables.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,18 @@
2525
public class BasicVariables implements Variables {
2626

2727
private static final long serialVersionUID = 2708263960832062725L;
28+
2829
/**
2930
* Contains the values of declared variables
3031
*/
3132
private final HashMap vars = new HashMap();
33+
34+
/**
35+
* Constructs a new instance.
36+
*/
37+
public BasicVariables() {
38+
// empty
39+
}
3240

3341
/**
3442
* Defines a new variable with the specified value or modifies the value of an existing variable.

src/main/java/org/apache/commons/jxpath/ri/Compiler.java

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,53 +45,148 @@
4545
*/
4646
public interface Compiler {
4747

48+
/** Constant {@value} */
4849
int NODE_TYPE_NODE = 1;
50+
51+
/** Constant {@value} */
4952
int NODE_TYPE_TEXT = 2;
53+
54+
/** Constant {@value} */
5055
int NODE_TYPE_COMMENT = 3;
56+
57+
/** Constant {@value} */
5158
int NODE_TYPE_PI = 4;
59+
60+
/** Constant {@value} */
5261
int AXIS_SELF = 1;
62+
63+
/** Constant {@value} */
5364
int AXIS_CHILD = 2;
65+
66+
/** Constant {@value} */
5467
int AXIS_PARENT = 3;
68+
69+
/** Constant {@value} */
5570
int AXIS_ANCESTOR = 4;
71+
72+
/** Constant {@value} */
5673
int AXIS_ATTRIBUTE = 5;
74+
75+
/** Constant {@value} */
5776
int AXIS_NAMESPACE = 6;
77+
78+
/** Constant {@value} */
5879
int AXIS_PRECEDING = 7;
80+
81+
/** Constant {@value} */
5982
int AXIS_FOLLOWING = 8;
83+
84+
/** Constant {@value} */
6085
int AXIS_DESCENDANT = 9;
86+
87+
/** Constant {@value} */
6188
int AXIS_ANCESTOR_OR_SELF = 10;
89+
90+
/** Constant {@value} */
6291
int AXIS_FOLLOWING_SIBLING = 11;
92+
93+
/** Constant {@value} */
6394
int AXIS_PRECEDING_SIBLING = 12;
95+
96+
/** Constant {@value} */
6497
int AXIS_DESCENDANT_OR_SELF = 13;
98+
99+
/** Constant {@value} */
65100
int FUNCTION_LAST = 1;
101+
102+
/** Constant {@value} */
66103
int FUNCTION_POSITION = 2;
104+
105+
/** Constant {@value} */
67106
int FUNCTION_COUNT = 3;
107+
108+
/** Constant {@value} */
68109
int FUNCTION_ID = 4;
110+
111+
/** Constant {@value} */
69112
int FUNCTION_LOCAL_NAME = 5;
113+
114+
/** Constant {@value} */
70115
int FUNCTION_NAMESPACE_URI = 6;
116+
117+
/** Constant {@value} */
71118
int FUNCTION_NAME = 7;
119+
120+
/** Constant {@value} */
72121
int FUNCTION_STRING = 8;
122+
123+
/** Constant {@value} */
73124
int FUNCTION_CONCAT = 9;
125+
126+
/** Constant {@value} */
74127
int FUNCTION_STARTS_WITH = 10;
128+
129+
/** Constant {@value} */
75130
int FUNCTION_CONTAINS = 11;
131+
132+
/** Constant {@value} */
76133
int FUNCTION_SUBSTRING_BEFORE = 12;
134+
135+
/** Constant {@value} */
77136
int FUNCTION_SUBSTRING_AFTER = 13;
137+
138+
/** Constant {@value} */
78139
int FUNCTION_SUBSTRING = 14;
140+
141+
/** Constant {@value} */
79142
int FUNCTION_STRING_LENGTH = 15;
143+
144+
/** Constant {@value} */
80145
int FUNCTION_NORMALIZE_SPACE = 16;
146+
147+
/** Constant {@value} */
81148
int FUNCTION_TRANSLATE = 17;
149+
150+
/** Constant {@value} */
82151
int FUNCTION_BOOLEAN = 18;
152+
153+
/** Constant {@value} */
83154
int FUNCTION_NOT = 19;
155+
156+
/** Constant {@value} */
84157
int FUNCTION_TRUE = 20;
158+
159+
/** Constant {@value} */
85160
int FUNCTION_FALSE = 21;
161+
162+
/** Constant {@value} */
86163
int FUNCTION_LANG = 22;
164+
165+
/** Constant {@value} */
87166
int FUNCTION_NUMBER = 23;
167+
168+
/** Constant {@value} */
88169
int FUNCTION_SUM = 24;
170+
171+
/** Constant {@value} */
89172
int FUNCTION_FLOOR = 25;
173+
174+
/** Constant {@value} */
90175
int FUNCTION_CEILING = 26;
176+
177+
/** Constant {@value} */
91178
int FUNCTION_ROUND = 27;
179+
180+
/** Constant {@value} */
92181
int FUNCTION_NULL = 28;
182+
183+
/** Constant {@value} */
93184
int FUNCTION_KEY = 29;
185+
186+
/** Constant {@value} */
94187
int FUNCTION_FORMAT_NUMBER = 30;
188+
189+
/** Constant {@value} */
95190
int FUNCTION_ENDS_WITH = 31;
96191

97192
/**

src/main/java/org/apache/commons/jxpath/ri/model/beans/BeanPointerFactory.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ public class BeanPointerFactory implements NodePointerFactory {
3232

3333
/** Factory order constant */
3434
public static final int BEAN_POINTER_FACTORY_ORDER = 900;
35+
36+
/**
37+
* Constructs a new instance.
38+
*/
39+
public BeanPointerFactory() {
40+
// TODO Auto-generated constructor stub
41+
}
3542

3643
@Override
3744
public NodePointer createNodePointer(final NodePointer parent, final QName name, final Object bean) {

src/main/java/org/apache/commons/jxpath/util/BasicTypeConverter.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,14 @@ public void setValue(final Object value) {
151151
}
152152
}
153153

154+
155+
/**
156+
* Constructs a new instance.
157+
*/
158+
public BasicTypeConverter() {
159+
// empty
160+
}
161+
154162
/**
155163
* Create a collection of a given type.
156164
*

0 commit comments

Comments
 (0)