Project

Profile

Help

Revision a8a62a9a

Added by Debbie Lockett about 1 year ago

Saxon 10 - fix minor javadoc issues (warnings in build for broken links, etc.)

View differences:

latest10/hej/net/sf/saxon/dom/DOMNodeWrapper.java
976 976
         * Get properties of this iterator, as a bit-significant integer.
977 977
         *
978 978
         * @return the properties of this iterator. This will be some combination of
979
         *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
980
         *         and {@link Property#LOOKAHEAD}. It is always
979
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
980
         *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
981 981
         *         acceptable to return the value zero, indicating that there are no known special properties.
982 982
         *         It is acceptable for the properties of the iterator to change depending on its state.
983 983
         */
......
1162 1162
         * Get properties of this iterator, as a bit-significant integer.
1163 1163
         *
1164 1164
         * @return the properties of this iterator. This will be some combination of
1165
         *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
1166
         *         and {@link Property#LOOKAHEAD}. It is always
1165
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
1166
         *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
1167 1167
         *         acceptable to return the value zero, indicating that there are no known special properties.
1168 1168
         *         It is acceptable for the properties of the iterator to change depending on its state.
1169 1169
         */
latest10/hej/net/sf/saxon/dotnet/DotNetNodeWrapper.java
685 685
         * Get properties of this iterator, as a bit-significant integer.
686 686
         *
687 687
         * @return the properties of this iterator. This will be some combination of
688
         *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
689
         *         and {@link Property#LOOKAHEAD}. It is always
688
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
689
         *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
690 690
         *         acceptable to return the value zero, indicating that there are no known special properties.
691 691
         *         It is acceptable for the properties of the iterator to change depending on its state.
692 692
         */
......
849 849
         * Get properties of this iterator, as a bit-significant integer.
850 850
         *
851 851
         * @return the properties of this iterator. This will be some combination of
852
         *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
853
         *         and {@link Property#LOOKAHEAD}. It is always
852
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
853
         *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
854 854
         *         acceptable to return the value zero, indicating that there are no known special properties.
855 855
         *         It is acceptable for the properties of the iterator to change depending on its state.
856 856
         */
latest10/hej/net/sf/saxon/dotnet/DotNetPullProvider.java
65 65

  
66 66
    /**
67 67
     * Close the event reader. This indicates that no further events are required.
68
     * It is not necessary to close an event reader after {@link Event#END_OF_INPUT} has
68
     * It is not necessary to close an event reader after {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} has
69 69
     * been reported, but it is recommended to close it if reading terminates
70 70
     * prematurely. Once an event reader has been closed, the effect of further
71 71
     * calls on next() is undefined.
......
137 137

  
138 138
    /**
139 139
     * Get the NodeName identifying the name of the current node. This method
140
     * can be used after the {@link Event#START_ELEMENT}, {@link Event#PROCESSING_INSTRUCTION},
141
     * {@link Event#ATTRIBUTE}, or {@link Event#NAMESPACE} events. With some PullProvider implementations,
142
     * it can also be used after {@link Event#END_ELEMENT}, but this is not guaranteed: a client who
140
     * can be used after the {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, {@link net.sf.saxon.pull.PullProvider.Event#PROCESSING_INSTRUCTION},
141
     * {@link net.sf.saxon.pull.PullProvider.Event#ATTRIBUTE}, or {@link net.sf.saxon.pull.PullProvider.Event#NAMESPACE} events. With some PullProvider implementations,
142
     * it can also be used after {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}, but this is not guaranteed: a client who
143 143
     * requires the information at that point (for example, to do serialization) should insert an
144 144
     * {@link com.saxonica.xqj.pull.ElementNameTracker} into the pipeline.
145 145
     * If called at other times, the result is undefined and may result in an IllegalStateException.
......
227 227
     * Get the string value of the current element, text node, processing-instruction,
228 228
     * or top-level attribute or namespace node, or atomic value.
229 229
     * <p>In other situations the result is undefined and may result in an IllegalStateException.</p>
230
     * <p>If the most recent event was a {@link Event#START_ELEMENT}, this method causes the content
230
     * <p>If the most recent event was a {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, this method causes the content
231 231
     * of the element to be read. The current event on completion of this method will be the
232
     * corresponding {@link Event#END_ELEMENT}. The next call of next() will return the event following
232
     * corresponding {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}. The next call of next() will return the event following
233 233
     * the END_ELEMENT event.</p>
234 234
     *
235 235
     * @return the String Value of the node in question, defined according to the rules in the
......
261 261
     * Get the next event
262 262
     *
263 263
     * @return an integer code indicating the type of event. The code
264
     *         {@link Event#END_OF_INPUT} is returned at the end of the sequence.
264
     *         {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} is returned at the end of the sequence.
265 265
     */
266 266

  
267 267
    public Event next() throws XPathException {
latest10/hej/net/sf/saxon/expr/BigRangeIterator.java
69 69
     * Get properties of this iterator, as a bit-significant integer.
70 70
     *
71 71
     * @return the properties of this iterator. This will be some combination of
72
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
73
     *         and {@link Property#LOOKAHEAD}. It is always
72
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
73
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
74 74
     *         acceptable to return the value zero, indicating that there are no known special properties.
75 75
     *         It is acceptable for the properties of the iterator to change depending on its state.
76 76
     */
latest10/hej/net/sf/saxon/expr/ItemMappingIterator.java
134 134
     * Get properties of this iterator, as a bit-significant integer.
135 135
     *
136 136
     * @return the properties of this iterator. This will be some combination of
137
     *         properties such as {@link Property#GROUNDED},
138
     *         {@link Property#LAST_POSITION_FINDER},
139
     *         and {@link Property#LOOKAHEAD}. It is always
137
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED},
138
     *         {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
139
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
140 140
     *         acceptable to return the value zero, indicating that there are no known special properties.
141 141
     *         It is acceptable for the properties of the iterator to change depending on its state.
142 142
     */
latest10/hej/net/sf/saxon/expr/LastPositionFinder.java
24 24
     * non-destructive: it does not change the state of the iterator.
25 25
     * The result is undefined if the next() method of the iterator has already returned null.
26 26
     * This method must not be called unless the result of getProperties() on the iterator
27
     * includes the bit setting {@link SequenceIterator.Property#LAST_POSITION_FINDER}
27
     * includes the bit setting {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER}
28 28
     *
29 29
     * @return the number of items in the sequence
30 30
     * @throws XPathException if an error occurs evaluating the sequence in order to determine
latest10/hej/net/sf/saxon/expr/RangeIterator.java
84 84
     * Get properties of this iterator, as a bit-significant integer.
85 85
     *
86 86
     * @return the properties of this iterator. This will be some combination of
87
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
88
     *         and {@link Property#LOOKAHEAD}. It is always
87
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
88
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
89 89
     *         acceptable to return the value zero, indicating that there are no known special properties.
90 90
     *         It is acceptable for the properties of the iterator to change depending on its state.
91 91
     */
latest10/hej/net/sf/saxon/expr/ReverseRangeIterator.java
69 69
     * Get properties of this iterator, as a bit-significant integer.
70 70
     *
71 71
     * @return the properties of this iterator. This will be some combination of
72
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
73
     *         and {@link Property#LOOKAHEAD}. It is always
72
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
73
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
74 74
     *         acceptable to return the value zero, indicating that there are no known special properties.
75 75
     *         It is acceptable for the properties of the iterator to change depending on its state.
76 76
     */
latest10/hej/net/sf/saxon/expr/SubsequenceIterator.java
122 122
     * Get properties of this iterator, as a bit-significant integer.
123 123
     *
124 124
     * @return the properties of this iterator. This will be some combination of
125
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
126
     *         and {@link Property#LOOKAHEAD}. It is always
125
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
126
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
127 127
     *         acceptable to return the value zero, indicating that there are no known special properties.
128 128
     *         It is acceptable for the properties of the iterator to change depending on its state.
129 129
     */
......
138 138
     * non-destructive: it does not change the state of the iterator.
139 139
     * The result is undefined if the next() method of the iterator has already returned null.
140 140
     * This method must not be called unless the result of getProperties() on the iterator
141
     * includes the bit setting {@link Property#LAST_POSITION_FINDER}
141
     * includes the bit setting {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER}
142 142
     */
143 143

  
144 144
    public int getLength() throws XPathException {
latest10/hej/net/sf/saxon/expr/TailIterator.java
108 108
     * Get properties of this iterator, as a bit-significant integer.
109 109
     *
110 110
     * @return the properties of this iterator. This will be some combination of
111
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
112
     *         and {@link Property#LOOKAHEAD}. It is always
111
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
112
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
113 113
     *         acceptable to return the value zero, indicating that there are no known special properties.
114 114
     *         It is acceptable for the properties of the iterator to change depending on its state.
115 115
     */
latest10/hej/net/sf/saxon/expr/UnionEnumeration.java
114 114
     * Get properties of this iterator, as a bit-significant integer.
115 115
     *
116 116
     * @return the properties of this iterator. This will be some combination of
117
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
118
     *         and {@link Property#LOOKAHEAD}. It is always
117
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
118
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
119 119
     *         acceptable to return the value zero, indicating that there are no known special properties.
120 120
     *         It is acceptable for the properties of the iterator to change depending on its state.
121 121
     */
latest10/hej/net/sf/saxon/expr/ValueTailIterator.java
79 79
     * Get properties of this iterator, as a bit-significant integer.
80 80
     *
81 81
     * @return the properties of this iterator. This will be some combination of
82
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
83
     *         and {@link Property#LOOKAHEAD}. It is always
82
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
83
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
84 84
     *         acceptable to return the value zero, indicating that there are no known special properties.
85 85
     *         It is acceptable for the properties of the iterator to change depending on its state.
86 86
     */
latest10/hej/net/sf/saxon/expr/sort/GroupAdjacentIterator.java
169 169
     * Get properties of this iterator, as a bit-significant integer.
170 170
     *
171 171
     * @return the properties of this iterator. This will be some combination of
172
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
173
     *         and {@link Property#LOOKAHEAD}. It is always
172
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
173
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
174 174
     *         acceptable to return the value zero, indicating that there are no known special properties.
175 175
     *         It is acceptable for the properties of the iterator to change depending on its state.
176 176
     */
latest10/hej/net/sf/saxon/expr/sort/GroupByIterator.java
257 257
     * Get properties of this iterator, as a bit-significant integer.
258 258
     *
259 259
     * @return the properties of this iterator. This will be some combination of
260
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
261
     *         and {@link Property#LOOKAHEAD}. It is always
260
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
261
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
262 262
     *         acceptable to return the value zero, indicating that there are no known special properties.
263 263
     *         It is acceptable for the properties of the iterator to change depending on its state.
264 264
     */
latest10/hej/net/sf/saxon/expr/sort/MergeIterator.java
113 113
     * Get properties of this iterator, as a bit-significant integer.
114 114
     *
115 115
     * @return the properties of this iterator. This will be some combination of
116
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
117
     *         and {@link Property#LOOKAHEAD}. It is always
116
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
117
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
118 118
     *         acceptable to return the value zero, indicating that there are no known special properties.
119 119
     *         It is acceptable for the properties of the iterator to change depending on its state.
120 120
     */
latest10/hej/net/sf/saxon/expr/sort/SortedIterator.java
107 107
     * next(). It is used only when there is an explicit need to tell if we
108 108
     * are at the last element.
109 109
     * <p>This method must not be called unless the result of getProperties() on the iterator
110
     * includes the bit setting {@link Property#LOOKAHEAD}</p>
110
     * includes the bit setting {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}</p>
111 111
     *
112 112
     * @return true if there are more items in the sequence
113 113
     */
......
169 169
     * Get properties of this iterator, as a bit-significant integer.
170 170
     *
171 171
     * @return the properties of this iterator. This will be some combination of
172
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
173
     *         and {@link Property#LOOKAHEAD}. It is always
172
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
173
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
174 174
     *         acceptable to return the value zero, indicating that there are no known special properties.
175 175
     *         It is acceptable for the properties of the iterator to change depending on its state.
176 176
     */
latest10/hej/net/sf/saxon/functions/Remove.java
116 116
         * Get properties of this iterator, as a bit-significant integer.
117 117
         *
118 118
         * @return the properties of this iterator. This will be some combination of
119
         * properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
120
         * and {@link Property#LOOKAHEAD}. It is always
119
         * properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
120
         * and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
121 121
         * acceptable to return the value zero, indicating that there are no known special properties.
122 122
         * It is acceptable for the properties of the iterator to change depending on its state.
123 123
         */
latest10/hej/net/sf/saxon/om/Chain.java
337 337
         * Get properties of this iterator, as a bit-significant integer.
338 338
         *
339 339
         * @return the properties of this iterator. This will be some combination of
340
         *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
341
         *         and {@link Property#LOOKAHEAD}. It is always
340
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
341
         *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
342 342
         *         acceptable to return the value zero, indicating that there are no known special properties.
343 343
         *         It is acceptable for the properties of the iterator to change depending on its state.
344 344
         */
latest10/hej/net/sf/saxon/om/FocusTrackingIterator.java
146 146
     * next(). It is used only when there is an explicit need to tell if we
147 147
     * are at the last element.
148 148
     * <p>This method must not be called unless the result of getProperties() on the iterator
149
     * includes the bit setting {@link Property#LOOKAHEAD}</p>
149
     * includes the bit setting {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}</p>
150 150
     *
151 151
     * @return true if there are more items in the sequence
152 152
     * @throws ClassCastException if the base iterator does not support lookahead processing
......
163 163
     * @return the corresponding Value
164 164
     * @throws XPathException in the cases of subclasses (such as the iterator over a MemoClosure)
165 165
     *                        which cause evaluation of expressions while materializing the value.
166
     * @throws ClassCastException if the iterator does not have the {@link Property#GROUNDED} property.
166
     * @throws ClassCastException if the iterator does not have the {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED} property.
167 167
     */
168 168
    @Override
169 169
    public GroundedValue materialize() throws XPathException {
......
177 177
     * @return the corresponding Value
178 178
     * @throws XPathException in the cases of subclasses (such as the iterator over a MemoClosure)
179 179
     *                        which cause evaluation of expressions while materializing the value.
180
     * @throws ClassCastException if the iterator does not have the {@link Property#GROUNDED} property.
180
     * @throws ClassCastException if the iterator does not have the {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED} property.
181 181
     */
182 182
    @Override
183 183
    public GroundedValue getResidue() throws XPathException {
......
204 204
     * Get properties of this iterator, as a bit-significant integer.
205 205
     *
206 206
     * @return the properties of this iterator. This will be some combination of
207
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
208
     *         and {@link Property#LOOKAHEAD}. It is always
207
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
208
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
209 209
     *         acceptable to return the value zero, indicating that there are no known special properties.
210 210
     *         It is acceptable for the properties of the iterator to change depending on its state.
211 211
     * @since 8.6
latest10/hej/net/sf/saxon/om/MemoSequence.java
325 325
         * Get properties of this iterator, as a bit-significant integer.
326 326
         *
327 327
         * @return the properties of this iterator. This will be some combination of
328
         *         properties such as {@link Property#GROUNDED} and {@link Property#LAST_POSITION_FINDER}. It is always
328
         *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED} and {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER}. It is always
329 329
         *         acceptable to return the value zero, indicating that there are no known special properties.
330 330
         */
331 331

  
latest10/hej/net/sf/saxon/pull/PullFilter.java
87 87
     * currentEvent to the event returned by any call on next().</p>
88 88
     *
89 89
     * @return an integer code indicating the type of event. The code
90
     *         {@link Event#END_OF_INPUT} is returned at the end of the sequence.
90
     *         {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} is returned at the end of the sequence.
91 91
     */
92 92

  
93 93
    public Event next() throws XPathException {
......
156 156

  
157 157
    /**
158 158
     * Close the event reader. This indicates that no further events are required.
159
     * It is not necessary to close an event reader after {@link Event#END_OF_INPUT} has
159
     * It is not necessary to close an event reader after {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} has
160 160
     * been reported, but it is recommended to close it if reading terminates
161 161
     * prematurely. Once an event reader has been closed, the effect of further
162 162
     * calls on next() is undefined.
......
174 174
     * Get the string value of the current element, text node, processing-instruction,
175 175
     * or top-level attribute or namespace node, or atomic value.
176 176
     * <p>In other situations the result is undefined and may result in an IllegalStateException.</p>
177
     * <p>If the most recent event was a {@link Event#START_ELEMENT}, this method causes the content
178
     * of the element to be read. The next event notified will be the corresponding {@link Event#END_ELEMENT}.</p>
177
     * <p>If the most recent event was a {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, this method causes the content
178
     * of the element to be read. The next event notified will be the corresponding {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}.</p>
179 179
     *
180 180
     * @return the String Value of the node in question, defined according to the rules in the
181 181
     *         XPath data model.
latest10/hej/net/sf/saxon/pull/PullProvider.java
177 177
     * Get the next event
178 178
     *
179 179
     * @return an Event object indicating the type of event. The code
180
     *         {@link Event#END_OF_INPUT} is returned at the end of the sequence.
180
     *         {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} is returned at the end of the sequence.
181 181
     * @throws net.sf.saxon.trans.XPathException
182 182
     *          if a dynamic error occurs
183 183
     */
......
250 250

  
251 251
    /**
252 252
     * Close the event reader. This indicates that no further events are required.
253
     * It is not necessary to close an event reader after {@link Event#END_OF_INPUT} has
253
     * It is not necessary to close an event reader after {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} has
254 254
     * been reported, but it is recommended to close it if reading terminates
255 255
     * prematurely. Once an event reader has been closed, the effect of further
256 256
     * calls on next() is undefined.
......
260 260

  
261 261
    /**
262 262
     * Get the NodeName identifying the name of the current node. This method
263
     * can be used after the {@link Event#START_ELEMENT}, {@link Event#PROCESSING_INSTRUCTION},
264
     * {@link Event#ATTRIBUTE}, or {@link Event#NAMESPACE} events. With some PullProvider implementations,
265
     * it can also be used after {@link Event#END_ELEMENT}, but this is not guaranteed.
263
     * can be used after the {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, {@link net.sf.saxon.pull.PullProvider.Event#PROCESSING_INSTRUCTION},
264
     * {@link net.sf.saxon.pull.PullProvider.Event#ATTRIBUTE}, or {@link net.sf.saxon.pull.PullProvider.Event#NAMESPACE} events. With some PullProvider implementations,
265
     * it can also be used after {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}, but this is not guaranteed.
266 266
     * If called at other times, the result is undefined and may result in an IllegalStateException.
267 267
     * If called when the current node is an unnamed namespace node (a node representing the default namespace)
268 268
     * the returned value is null.
......
277 277
     * Get the string value of the current element, text node, processing-instruction,
278 278
     * or top-level attribute or namespace node, or atomic value.
279 279
     * <p>In other situations the result is undefined and may result in an IllegalStateException.</p>
280
     * <p>If the most recent event was a {@link Event#START_ELEMENT}, this method causes the content
280
     * <p>If the most recent event was a {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, this method causes the content
281 281
     * of the element to be read. The current event on completion of this method will be the
282
     * corresponding {@link Event#END_ELEMENT}. The next call of next() will return the event following
282
     * corresponding {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}. The next call of next() will return the event following
283 283
     * the END_ELEMENT event.</p>
284 284
     *
285 285
     * @return the String Value of the node in question, defined according to the rules in the
latest10/hej/net/sf/saxon/pull/PullPushTee.java
64 64
     * copies it to the branch Receiver, and then returns the event to the caller.
65 65
     *
66 66
     * @return an integer code indicating the type of event. The code
67
     *         {@link Event#END_OF_INPUT} is returned at the end of the sequence.
67
     *         {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} is returned at the end of the sequence.
68 68
     */
69 69

  
70 70
    public Event next() throws XPathException {
latest10/hej/net/sf/saxon/pull/StaxBridge.java
138 138
     * Get the next event
139 139
     *
140 140
     * @return an integer code indicating the type of event. The code
141
     *         {@link Event#END_OF_INPUT} is returned at the end of the sequence.
141
     *         {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} is returned at the end of the sequence.
142 142
     */
143 143

  
144 144
    public Event next() throws XPathException {
......
376 376

  
377 377
    /**
378 378
     * Close the event reader. This indicates that no further events are required.
379
     * It is not necessary to close an event reader after {@link Event#END_OF_INPUT} has
379
     * It is not necessary to close an event reader after {@link net.sf.saxon.pull.PullProvider.Event#END_OF_INPUT} has
380 380
     * been reported, but it is recommended to close it if reading terminates
381 381
     * prematurely. Once an event reader has been closed, the effect of further
382 382
     * calls on next() is undefined.
......
392 392

  
393 393
    /**
394 394
     * Get the NodeName identifying the name of the current node. This method
395
     * can be used after the {@link Event#START_ELEMENT}, {@link Event#PROCESSING_INSTRUCTION},
396
     * {@link Event#ATTRIBUTE}, or {@link Event#NAMESPACE} events. With some PullProvider implementations,
397
     * it can also be used after {@link Event#END_ELEMENT}, but this is not guaranteed.
395
     * can be used after the {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, {@link net.sf.saxon.pull.PullProvider.Event#PROCESSING_INSTRUCTION},
396
     * {@link net.sf.saxon.pull.PullProvider.Event#ATTRIBUTE}, or {@link net.sf.saxon.pull.PullProvider.Event#NAMESPACE} events. With some PullProvider implementations,
397
     * it can also be used after {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}, but this is not guaranteed.
398 398
     * If called at other times, the result is undefined and may result in an IllegalStateException.
399 399
     * If called when the current node is an unnamed namespace node (a node representing the default namespace)
400 400
     * the returned value is null.
......
433 433
     * Get the string value of the current element, text node, processing-instruction,
434 434
     * or top-level attribute or namespace node, or atomic value.
435 435
     * <p>In other situations the result is undefined and may result in an IllegalStateException.</p>
436
     * <p>If the most recent event was a {@link Event#START_ELEMENT}, this method causes the content
436
     * <p>If the most recent event was a {@link net.sf.saxon.pull.PullProvider.Event#START_ELEMENT}, this method causes the content
437 437
     * of the element to be read. The current event on completion of this method will be the
438
     * corresponding {@link Event#END_ELEMENT}. The next call of next() will return the event following
438
     * corresponding {@link net.sf.saxon.pull.PullProvider.Event#END_ELEMENT}. The next call of next() will return the event following
439 439
     * the END_ELEMENT event.</p>
440 440
     *
441 441
     * @return the String Value of the node in question, defined according to the rules in the
latest10/hej/net/sf/saxon/regex/ARegexIterator.java
145 145
     * Get properties of this iterator, as a bit-significant integer.
146 146
     *
147 147
     * @return the properties of this iterator. This will be some combination of
148
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
149
     *         and {@link Property#LOOKAHEAD}. It is always
148
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
149
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
150 150
     *         acceptable to return the value zero, indicating that there are no known special properties.
151 151
     *         It is acceptable for the properties of the iterator to change depending on its state.
152 152
     */
latest10/hej/net/sf/saxon/regex/JRegexIterator.java
118 118
     * Get properties of this iterator, as a bit-significant integer.
119 119
     *
120 120
     * @return the properties of this iterator. This will be some combination of
121
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
122
     *         and {@link Property#LOOKAHEAD}. It is always
121
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
122
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
123 123
     *         acceptable to return the value zero, indicating that there are no known special properties.
124 124
     *         It is acceptable for the properties of the iterator to change depending on its state.
125 125
     */
latest10/hej/net/sf/saxon/s9api/Destination.java
95 95
     *               generating a validator to add to the output pipeline. The {@link Destination} object
96 96
     *               is responsible for instantiating this validator and inserting it into the pipeline.
97 97
     *               In most cases this is done by invoking the helper method
98
     *               {@link SerializationProperties#makeSequenceNormalizer(Outputter)}. Validation can be skipped
98
     *               {@link SerializationProperties#makeSequenceNormalizer(Receiver)}. Validation can be skipped
99 99
     *               in the case of non-XML destinations.
100 100
     * @return the Receiver to which events are to be sent.
101 101
     *         <p>It is the caller's responsibility to
latest10/hej/net/sf/saxon/s9api/Push.java
201 201
    }
202 202

  
203 203
    /**
204
     * A {@link Container} representing a document node.
204
     * A {@link net.sf.saxon.s9api.Push.Container} representing a document node.
205 205
     *
206 206
     * <p>If the document is constrained to be well-formed then the permitted sequence of events is
207 207
     * {@code (COMMENT | PI)* ELEMENT (COMMENT | PI)* CLOSE}.</p>
......
223 223
    }
224 224

  
225 225
    /**
226
     * A {@link Container} representing an element node.
226
     * A {@link net.sf.saxon.s9api.Push.Container} representing an element node.
227 227
     *
228 228
     * <p>The permitted sequence of events for an element node is
229 229
     * {@code (ATTRIBUTE | NAMESPACE)* (COMMENT | PI | TEXT | ELEMENT)* CLOSE?}.</p>
latest10/hej/net/sf/saxon/tree/iter/ArrayIterator.java
203 203
     * Get properties of this iterator, as a bit-significant integer.
204 204
     *
205 205
     * @return the properties of this iterator. This will be some combination of
206
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
207
     *         and {@link Property#LOOKAHEAD}. It is always
206
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
207
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
208 208
     *         acceptable to return the value zero, indicating that there are no known special properties.
209 209
     *         It is acceptable for the properties of the iterator to change depending on its state.
210 210
     */
latest10/hej/net/sf/saxon/tree/iter/EmptyIterator.java
92 92
     * Get properties of this iterator, as a bit-significant integer.
93 93
     *
94 94
     * @return the properties of this iterator. This will be some combination of
95
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
96
     *         and {@link Property#LOOKAHEAD}. It is always
95
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
96
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
97 97
     *         acceptable to return the value zero, indicating that there are no known special properties.
98 98
     *         It is acceptable for the properties of the iterator to change depending on its state.
99 99
     */
latest10/hej/net/sf/saxon/tree/iter/ListIterator.java
59 59
     * Get properties of this iterator, as a bit-significant integer.
60 60
     *
61 61
     * @return the properties of this iterator. This will be some combination of
62
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
63
     *         and {@link Property#LOOKAHEAD}. It is always
62
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
63
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
64 64
     *         acceptable to return the value zero, indicating that there are no known special properties.
65 65
     *         It is acceptable for the properties of the iterator to change depending on its state.
66 66
     */
latest10/hej/net/sf/saxon/tree/iter/LookaheadIterator.java
24 24
     * next(). It is used only when there is an explicit need to tell if we
25 25
     * are at the last element.
26 26
     * <p>This method must not be called unless the result of getProperties() on the iterator
27
     * includes the property {@link SequenceIterator.Property#LOOKAHEAD} </p>
27
     * includes the property {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD} </p>
28 28
     *
29 29
     * @return true if there are more items in the sequence
30 30
     */
latest10/hej/net/sf/saxon/tree/iter/ManualIterator.java
145 145
     * Get properties of this iterator, as a bit-significant integer.
146 146
     *
147 147
     * @return the properties of this iterator. This will be some combination of
148
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
149
     *         and {@link Property#LOOKAHEAD}. It is always
148
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
149
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
150 150
     *         acceptable to return the value zero, indicating that there are no known special properties.
151 151
     *         It is acceptable for the properties of the iterator to change depending on its state.
152 152
     */
latest10/hej/net/sf/saxon/tree/iter/NodeWrappingAxisIterator.java
71 71
     * Get properties of this iterator, as a bit-significant integer.
72 72
     *
73 73
     * @return the properties of this iterator. This will be some combination of
74
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
75
     *         and {@link Property#LOOKAHEAD}. It is always
74
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
75
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
76 76
     *         acceptable to return the value zero, indicating that there are no known special properties.
77 77
     *         It is acceptable for the properties of the iterator to change depending on its state.
78 78
     */
latest10/hej/net/sf/saxon/tree/iter/ReverseListIterator.java
72 72
     * Get properties of this iterator, as a bit-significant integer.
73 73
     *
74 74
     * @return the properties of this iterator. This will be some combination of
75
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
76
     *         and {@link Property#LOOKAHEAD}. It is always
75
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
76
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
77 77
     *         acceptable to return the value zero, indicating that there are no known special properties.
78 78
     *         It is acceptable for the properties of the iterator to change depending on its state.
79 79
     */
latest10/hej/net/sf/saxon/tree/iter/SingleNodeIterator.java
112 112
     * Get properties of this iterator, as a bit-significant integer.
113 113
     *
114 114
     * @return the properties of this iterator. This will be some combination of
115
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
116
     *         and {@link Property#LOOKAHEAD}. It is always
115
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
116
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
117 117
     *         acceptable to return the value zero, indicating that there are no known special properties.
118 118
     *         It is acceptable for the properties of the iterator to change depending on its state.
119 119
     */
latest10/hej/net/sf/saxon/tree/iter/SingletonIterator.java
130 130
     * Get properties of this iterator, as a bit-significant integer.
131 131
     *
132 132
     * @return the properties of this iterator. This will be some combination of
133
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
134
     *         and {@link Property#LOOKAHEAD}. It is always
133
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
134
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
135 135
     *         acceptable to return the value zero, indicating that there are no known special properties.
136 136
     *         It is acceptable for the properties of the iterator to change depending on its state.
137 137
     */
latest10/hej/net/sf/saxon/tree/iter/UntypedAtomizingIterator.java
57 57
     * Get properties of this iterator, as a bit-significant integer.
58 58
     *
59 59
     * @return the properties of this iterator. This will be some combination of
60
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
61
     *         and {@link Property#LOOKAHEAD}. It is always
60
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
61
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
62 62
     *         acceptable to return the value zero, indicating that there are no known special properties.
63 63
     *         It is acceptable for the properties of the iterator to change depending on its state.
64 64
     */
latest10/hej/net/sf/saxon/tree/linked/AttributeAxisIterator.java
97 97
     * Get properties of this iterator, as a bit-significant integer.
98 98
     *
99 99
     * @return the properties of this iterator. This will be some combination of
100
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
101
     *         and {@link Property#LOOKAHEAD}. It is always
100
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
101
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
102 102
     *         acceptable to return the value zero, indicating that there are no known special properties.
103 103
     *         It is acceptable for the properties of the iterator to change depending on its state.
104 104
     */
latest10/hej/net/sf/saxon/tree/linked/TreeEnumeration.java
103 103
     * Get properties of this iterator, as a bit-significant integer.
104 104
     *
105 105
     * @return the properties of this iterator. This will be some combination of
106
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
107
     *         and {@link Property#LOOKAHEAD}. It is always
106
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
107
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
108 108
     *         acceptable to return the value zero, indicating that there are no known special properties.
109 109
     *         It is acceptable for the properties of the iterator to change depending on its state.
110 110
     */
latest10/hej/net/sf/saxon/tree/tiny/AttributeIterator.java
108 108
     * Get properties of this iterator, as a bit-significant integer.
109 109
     *
110 110
     * @return the properties of this iterator. This will be some combination of
111
     *         properties such as {@link Property#GROUNDED}, {@link Property#LAST_POSITION_FINDER},
112
     *         and {@link Property#LOOKAHEAD}. It is always
111
     *         properties such as {@link net.sf.saxon.om.SequenceIterator.Property#GROUNDED}, {@link net.sf.saxon.om.SequenceIterator.Property#LAST_POSITION_FINDER},
112
     *         and {@link net.sf.saxon.om.SequenceIterator.Property#LOOKAHEAD}. It is always
113 113
     *         acceptable to return the value zero, indicating that there are no known special properties.
114 114
     *         It is acceptable for the properties of the iterator to change depending on its state.
115 115
     */
latest10/hej/net/sf/saxon/value/DayTimeDurationValue.java
57 57
     * constructor performs limited validation. The components (apart from sign) must all be non-negative
58 58
     * integers; they need not be normalized (for example, 36 hours is acceptable)
59 59
     * <p>Note: for historic reasons this constructor only supports microsecond precision. For nanosecond
60
     * precision, use the constructor {@link DayTimeDurationValue#DayTimeDurationValue(int, int, int, long, int)}</p>
60
     * precision, use the constructor {@link #DayTimeDurationValue(int, int, int, long, int)}</p>
61 61
     *
62 62
     * @param sign         positive number for positive durations, negative for negative duratoins
63 63
     * @param days         number of days
latest10/hej/net/sf/saxon/value/DurationValue.java
45 45
     * that the values are normalized, for example it is acceptable to specify months=18. The values of
46 46
     * the individual components must all be non-negative.
47 47
     * <p>Note: For historic reasons this constructor only supports microsecond precision. To get nanosecond
48
     * precision, use the constructor {@link DurationValue#DurationValue(int, int, int, int, int, long, int, AtomicType)}.</p>
48
     * precision, use the constructor {@link #DurationValue(int, int, int, int, int, long, int, AtomicType)}.</p>
49 49
     *
50 50
     * @param positive     true if the duration is positive, false if negative. For a negative duration
51 51
     *                     the components are all supplied as positive integers (or zero).
......
74 74
     * the individual components must all be non-negative.
75 75
     * <p>Note: for historic reasons this constructor was written to expect microseconds rather than nanoseconds.
76 76
     * To supply nanoseconds, use the alternative constructor
77
     * {@link DurationValue#DurationValue(int, int, int, int, int, long, int, AtomicType)}.</p>
77
     * {@link #DurationValue(int, int, int, int, int, long, int, AtomicType)}.</p>
78 78
     *
79 79
     * @param positive     true if the duration is positive, false if negative. For a negative duration
80 80
     *                     the components are all supplied as positive integers (or zero).

Also available in: Unified diff