Package org.apache.ivy.core.sort
Class ModuleInSort
java.lang.Object
org.apache.ivy.core.sort.ModuleInSort
Decorates a ModuleDescriptor with some attributes used during the sort. Thus every instance of a
ModuleInSort can be used in only one ModuleDescriptorSorter at a time.
The added fields are:
isSorted
: is true if and only if this module has already been added to the sorted list.loopElements
: When the module is the root of a loop (=the first element of a loop met during the sort),loopElements
contains all ModuleInSort of the loop (excluding the root itself.isLoopIntermediateElement
: When a loop is detected, all modules included in the loop (except the root) haveisLoopIntermediateElement
set to true.caller
: During the sort, we traverse recursively the graph. When doing that, caller point to the parent element.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate ModuleInSort
private boolean
private boolean
private List<ModuleInSort>
private final ModuleDescriptor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add this module to the sorted list except if this module is an intermediary element of a loop.private void
addToSortList
(List<ModuleDescriptor> sortedList) Add this module to the sorted list.boolean
checkLoop
(ModuleInSort futurCaller, CircularDependencyStrategy depStrategy) Check if a adding this element as a dependency of caller will introduce a circular dependency.void
boolean
isInLoop()
boolean
This ModuleInSort has already been analyzed.boolean
isSorted()
This ModuleInSort has been placed on the sorted liststatic void
logLoopWarning
(List<ModuleDescriptor> loopElement) Log a warning saying that a loop is detectedboolean
match
(DependencyDescriptor descriptor, VersionMatcher versionMatcher) Return true if this module match the DependencyDescriptor with the given versionMatcher.void
setCaller
(ModuleInSort caller) toString()
-
Field Details
-
module
-
isSorted
private boolean isSorted -
loopElements
-
isLoopIntermediateElement
private boolean isLoopIntermediateElement -
caller
-
-
Constructor Details
-
ModuleInSort
-
-
Method Details
-
isInLoop
public boolean isInLoop() -
isSorted
public boolean isSorted()This ModuleInSort has been placed on the sorted list -
isProcessed
public boolean isProcessed()This ModuleInSort has already been analyzed. It is either already added to the sorted list, either it is included in a loop and will be added when the root of the loop will be added to the list. -
setCaller
-
endOfCall
public void endOfCall() -
checkLoop
Check if a adding this element as a dependency of caller will introduce a circular dependency. If it is, all the elements of the loop are flagged as 'loopIntermediateElement', and the loopElements of this module (which is the root of the loop) is updated. The depStrategy is invoked on order to report a correct circular loop message.- Parameters:
futurCaller
- ModuleInSortdepStrategy
- CircularDependencyStrategy- Returns:
- true if a loop is detected.
-
addToSortedListIfRequired
Add this module to the sorted list except if this module is an intermediary element of a loop. If this module is the 'root' of a loop, then all elements of that loops are added before.- Parameters:
sorted
- The list of sorted elements on which this module will be added
-
addToSortList
Add this module to the sorted list. If current is the 'root' of a loop, then all elements of that loops are added before. -
toString
-
getDependencies
-
logLoopWarning
Log a warning saying that a loop is detected -
match
Return true if this module match the DependencyDescriptor with the given versionMatcher. If this module has no version defined, then true is always returned. -
getSortedModuleDescriptor
-