Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
X
xwiki-platform
Manage
Activity
Members
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
XWiki
xwiki-platform
Commits
65e121de
Commit
65e121de
authored
5 months ago
by
Thomas Mortagne
Browse files
Options
Downloads
Patches
Plain Diff
[Misc] Improve javadoc
parent
587aaf1e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
xwiki-platform-core/xwiki-platform-model/xwiki-platform-model-api/src/main/java/org/xwiki/model/reference/EntityReference.java
+12
-2
12 additions, 2 deletions
.../main/java/org/xwiki/model/reference/EntityReference.java
with
12 additions
and
2 deletions
xwiki-platform-core/xwiki-platform-model/xwiki-platform-model-api/src/main/java/org/xwiki/model/reference/EntityReference.java
+
12
−
2
View file @
65e121de
...
...
@@ -388,11 +388,16 @@ public int size()
}
/**
* Extract the last entity of the given type from this one by traversing the current entity to the root.
* Extract the entity of the given type which is the closest to this reference when traversing from this reference
* to the root.
* <p>
* For example when passing {@link DocumentReference} {@code wiki:Space1.Space2.Document} it will return the
* {@link SpaceReference} {@code wiki:Space1.Space2}.
*
* @param type the type of the entity to be extracted
* @return the last entity of the given type in the current entity when traversing to the root (the current entity
* will be returned if it's of the passed type) or null if no entity of the passed type exist
* @see #extractFirstReference(EntityType)
*/
public
EntityReference
extractReference
(
EntityType
type
)
{
...
...
@@ -406,12 +411,17 @@ public EntityReference extractReference(EntityType type)
}
/**
* Extract the first entity of the given type from this one by traversing the current entity to the root.
* Extract the entity of the given type which is the closest to the root reference when traversing from this
* reference to the root.
* <p>
* For example when passing {@link DocumentReference} {@code wiki:Space1.Space2.Document} it will return the
* {@link SpaceReference} {@code wiki:Space1}.
*
* @param type the type of the entity to be extracted
* @return the first entity of the given type in the current entity when traversing to the root or null if no entity
* of the passed type exist
* @since 7.4M1
* @see #extractReference(EntityType)
*/
public
EntityReference
extractFirstReference
(
EntityType
type
)
{
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment