Class GroupKey
- java.lang.Object
-
- org.apache.maven.tools.plugin.extractor.GroupKey
-
- All Implemented Interfaces:
Comparable<GroupKey>
public final class GroupKey extends Object implements Comparable<GroupKey>
Group key: defines "grouping" for descriptor (based on source of extraction) and rank within group.- Since:
- TBD
-
-
Field Summary
Fields Modifier and Type Field Description static String
JAVA_GROUP
Java group is handled a bit special: is always first to be scanned.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(GroupKey o)
Compares by group then by order, with special case ofJAVA_GROUP
group: First,group
is considered, if equals toJAVA_GROUP
, is always first, other groups are in natural order (string) within same named groups, order is defined byorder
boolean
equals(Object o)
String
getGroup()
Returns the group this key belongs to, nevernull
.int
getOrder()
Returns the order within same group of this key.int
hashCode()
String
toString()
-
-
-
Field Detail
-
JAVA_GROUP
public static final String JAVA_GROUP
Java group is handled a bit special: is always first to be scanned.- See Also:
- Constant Field Values
-
-
Method Detail
-
getOrder
public int getOrder()
Returns the order within same group of this key. Returns int should be used for ordering only.
-
compareTo
public int compareTo(GroupKey o)
Compares by group then by order, with special case ofJAVA_GROUP
group:- First,
group
is considered, if equals toJAVA_GROUP
, is always first, other groups are in natural order (string) - within same named groups, order is defined by
order
- Specified by:
compareTo
in interfaceComparable<GroupKey>
- First,
-
-