@@ -19,8 +19,10 @@ interface ItemInterface
1919 /**
2020 * Returns the normalized absolute path to this item.
2121 *
22- * @return string the normalized absolute path of this Item.
23- * @throws RepositoryException if an error occurs.
22+ * @return string the normalized absolute path of this Item
23+ *
24+ * @throws RepositoryException if an error occurs
25+ *
2426 * @api
2527 */
2628 public function getPath ();
@@ -31,9 +33,9 @@ public function getPath();
3133 * If this Item is the root node of the workspace, an empty string is returned.
3234 *
3335 * @return string the name of this Item in qualified form or an empty
34- * string if this Item is the root node of a workspace.
36+ * string if this Item is the root node of a workspace
3537 *
36- * @throws RepositoryException if an error occurs.
38+ * @throws RepositoryException if an error occurs
3739 *
3840 * @api
3941 */
@@ -54,20 +56,17 @@ public function getName();
5456 * returns this Item itself.
5557 *
5658 * If this node has more than one path (i.e., if it is a descendant of a
57- * shared node) then the path used to define the ancestor is implementaion -
59+ * shared node) then the path used to define the ancestor is implementation -
5860 * dependent.
5961 *
60- * @param int $depth An integer, 0 <= depth <= n where n is the depth
61- * of this Item.
62+ * @param int $depth an integer, 0 <= depth <= n where n is the depth of this Item
6263 *
63- * @return ItemInterface The ancestor of this Item at the specified
64- * depth.
64+ * @return ItemInterface the ancestor of this Item at the specified depth
6565 *
66- * @throws ItemNotFoundException if depth < 0 or depth > n
67- * where n is the depth of this item.
68- * @throws AccessDeniedException if the current session does not
69- * have sufficient access to retrieve the specified node.
70- * @throws RepositoryException if another error occurs.
66+ * @throws ItemNotFoundException if depth < 0 or depth > n where n is the depth of this item
67+ * @throws AccessDeniedException if the current session does not have sufficient access to
68+ * retrieve the specified node
69+ * @throws RepositoryException if another error occurs
7170 *
7271 * @api
7372 */
@@ -76,13 +75,12 @@ public function getAncestor($depth);
7675 /**
7776 * Returns the parent of this Item.
7877 *
79- * @return NodeInterface The parent of this Item.
78+ * @return NodeInterface the parent of this Item
8079 *
81- * @throws ItemNotFoundException if this Item is the root node of a
82- * workspace.
83- * @throws AccessDeniedException if the current session does not
84- * have sufficient access to retrieve the parent of this item.
85- * @throws RepositoryException if another error occurs.
80+ * @throws ItemNotFoundException if this Item is the root node of a workspace
81+ * @throws AccessDeniedException if the current session does not have sufficient access to
82+ * retrieve the parent of this item
83+ * @throws RepositoryException if another error occurs
8684 *
8785 * @api
8886 */
@@ -96,9 +94,9 @@ public function getParent();
9694 * - A property or child node of a child node of the root returns 2.
9795 * - And so on to this Item.
9896 *
99- * @return int The depth of this Item in the workspace item graph.
97+ * @return int the depth of this Item in the workspace item graph
10098 *
101- * @throws RepositoryException if an error occurs.
99+ * @throws RepositoryException if an error occurs
102100 *
103101 * @api
104102 */
@@ -107,9 +105,9 @@ public function getDepth();
107105 /**
108106 * Returns the Session through which this Item was acquired.
109107 *
110- * @return SessionInterface the Session through which this Item was
111- * acquired.
112- * @throws RepositoryException if an error occurs.
108+ * @return SessionInterface the Session through which this Item was acquired
109+ *
110+ * @throws RepositoryException if an error occurs
113111 *
114112 * @api
115113 */
@@ -118,10 +116,9 @@ public function getSession();
118116 /**
119117 * Indicates whether this Item is a Node or a Property.
120118 *
121- * Returns true if this Item is a Node; Returns false if this Item is a
122- * Property.
119+ * Returns true if this Item is a Node; Returns false if this Item is a Property.
123120 *
124- * @return bool true if this Item is a Node, false if it is a Property.
121+ * @return bool true if this Item is a Node, false if it is a Property
125122 *
126123 * @api
127124 */
@@ -142,7 +139,7 @@ public function isNode();
142139 * Note that in read-only implementations, this method will always return
143140 * false.
144141 *
145- * @return bool true if this item is new; false otherwise.
142+ * @return bool true if this item is new; false otherwise
146143 *
147144 * @api
148145 */
@@ -162,7 +159,7 @@ public function isNew();
162159 * Note that in read-only implementations, this method will always return
163160 * false.
164161 *
165- * @return bool true if this item is modified; false otherwise.
162+ * @return bool true if this item is modified; false otherwise
166163 *
167164 * @api
168165 */
@@ -194,12 +191,12 @@ public function isModified();
194191 * state.
195192 *
196193 * @param ItemInterface $otherItem the Item object to be tested for
197- * identity with this Item.
194+ * identity with this Item
198195 *
199196 * @return bool true if this Item object and otherItem represent the
200- * same actual repository item; false otherwise.
197+ * same actual repository item; false otherwise
201198 *
202- * @throws RepositoryException if an error occurs.
199+ * @throws RepositoryException if an error occurs
203200 *
204201 * @api
205202 */
@@ -212,10 +209,9 @@ public function isSame(ItemInterface $otherItem);
212209 * visitor). We leave it here, to allow sanity checks or other operations
213210 * an implementation might wants to do.
214211 *
215- * @param ItemVisitorInterface $visitor The ItemVisitor to be
216- * accepted.
212+ * @param ItemVisitorInterface $visitor the ItemVisitor to be accepted
217213 *
218- * @throws RepositoryException if an error occurs.
214+ * @throws RepositoryException if an error occurs
219215 *
220216 * @api
221217 */
@@ -232,10 +228,9 @@ public function accept(ItemVisitorInterface $visitor);
232228 * persistent storage as modified by changes that have been saved but not
233229 * yet committed.
234230 *
235- * @throws InvalidItemStateException if this <code>Item</code> object
236- * represents a workspace item that has been removed (either by this
237- * session or another).
238- * @throws RepositoryException if another error occurs.
231+ * @throws InvalidItemStateException if this <code>Item</code> object represents a workspace item
232+ * that has been removed (either by this session or another)
233+ * @throws RepositoryException if another error occurs
239234 *
240235 * @since JCR 2.1
241236 */
@@ -253,24 +248,25 @@ public function revert();
253248 * and causes the minimal re-numbering required to maintain the original
254249 * order but leave no gaps in the numbering.
255250 *
256- * @throws VersionException if the parent node of this item
257- * is versionable and checked-in or is non-versionable but its nearest
258- * versionable ancestor is checked-in and this implementation performs
259- * this validation immediately instead of waiting until save.
260- * @throws LockException if a lock prevents the removal of this
261- * item and this implementation performs this validation immediately
262- * instead of waiting until save.
263- * @throws ConstraintViolationException if removing the
264- * specified item would violate a node type or implementation-specific
265- * constraint and this implementation performs this validation
266- * immediately instead of waiting until save.
267- * @throws AccessDeniedException if this item or an item in its
268- * subgraph is currently the target of a REFERENCE property located in
269- * this workspace but outside this item's subgraph and the current
270- * Session does not have read access to that REFERENCE property or if
271- * the current Session does not have sufficient privileges to remove
272- * the item.
273- * @throws RepositoryException if another error occurs.
251+ * @throws VersionException if the parent node of this item is versionable and
252+ * checked-in or is non-versionable but its nearest
253+ * versionable ancestor is checked-in and this
254+ * implementation performs this validation immediately
255+ * instead of waiting until save
256+ * @throws LockException if a lock prevents the removal of this item and this
257+ * implementation performs this validation immediately
258+ * instead of waiting until save
259+ * @throws ConstraintViolationException if removing the specified item would violate a node
260+ * type or implementation-specific constraint and this
261+ * implementation performs this validation immediately
262+ * instead of waiting until save
263+ * @throws AccessDeniedException if this item or an item in its subgraph is currently
264+ * the target of a REFERENCE property located in this
265+ * workspace but outside this item's subgraph and the
266+ * current Session does not have read access to that
267+ * REFERENCE property or if the current Session does not
268+ * have sufficient privileges to remove the item
269+ * @throws RepositoryException if another error occurs
274270 *
275271 * @see SessionInterface::removeItem(String)
276272 *
0 commit comments