Interface ModuleDescriptors.Orderings

All Known Implementing Classes:
DefaultModuleDescriptorOrderingsFactory
Enclosing class:
ModuleDescriptors

public static interface ModuleDescriptors.Orderings
Responsible for creating Ordering instances to sort collections of module descriptors.
Since:
v4.4
See Also:
  • Ordering
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.common.collect.Ordering<com.atlassian.plugin.ModuleDescriptor>
    Creates an ordering instance that orders module descriptors according to the "origin" of the plugin they come from.
    com.google.common.collect.Ordering<com.atlassian.plugin.ModuleDescriptor>
    Creates an Ordering instance that orders module descriptors according to their "natural" order.
    com.google.common.collect.Ordering<com.atlassian.plugin.web.descriptors.WeightedDescriptor>
    Creates an Ordering instance that orders weighted module descriptors according to their weight.
  • Method Details

    • byOrigin

      com.google.common.collect.Ordering<com.atlassian.plugin.ModuleDescriptor> byOrigin()
      Creates an ordering instance that orders module descriptors according to the "origin" of the plugin they come from.
      Returns:
      An ordering instance that orders module descriptors according to the "origin" of the plugin they come from.
      See Also:
    • natural

      com.google.common.collect.Ordering<com.atlassian.plugin.ModuleDescriptor> natural()
      Creates an Ordering instance that orders module descriptors according to their "natural" order.

      Natural order is based on the module descriptor's complete key

      Returns:
      An Ordering instance that orders module descriptors according to their "natural" order.
    • weightedDescriptorComparator

      com.google.common.collect.Ordering<com.atlassian.plugin.web.descriptors.WeightedDescriptor> weightedDescriptorComparator()
      Creates an Ordering instance that orders weighted module descriptors according to their weight.
      Returns:
      An ordering instance that orders module descriptors according to their weight.
      See Also:
      • WeightedDescriptorComparator