public abstract class SCMNavigatorTrait extends SCMTrait<SCMNavigatorTrait>
SCMSource
.ExtensionPoint.LegacyInstancesAreScopedToHudson
Constructor and Description |
---|
SCMNavigatorTrait() |
Modifier and Type | Method and Description |
---|---|
static List<SCMNavigatorTraitDescriptor> |
_for(Class<? extends SCMNavigatorContext> contextClass,
Class<? extends SCMSourceBuilder> builderClass)
Returns the subset of
SCMNavigatorTraitDescriptor instances that are applicable to the specified types
of SCMNavigatorContext and SCMSourceBuilder . |
static List<SCMNavigatorTraitDescriptor> |
_for(SCMNavigatorDescriptor scmNavigator,
Class<? extends SCMNavigatorContext> contextClass,
Class<? extends SCMSourceBuilder> builderClass)
Returns the subset of
SCMNavigatorTraitDescriptor instances that are applicable to the specified
SCMNavigatorDescriptor and specified types of SCMNavigatorContext and SCMSourceBuilder . |
static DescriptorExtensionList<SCMNavigatorTrait,SCMNavigatorTraitDescriptor> |
all()
Returns all the
SCMNavigatorTraitDescriptor instances. |
void |
applyToBuilder(SCMSourceBuilder<?,?> builder)
Applies this trait to the
SCMBuilder . |
void |
applyToContext(SCMNavigatorContext<?,?> context)
Applies this trait to the
SCMNavigatorContext . |
SCMSourceObserver |
applyToObserver(SCMSourceObserver observer)
Applies this trait to an observer for use during a
SCMNavigatorRequest . |
protected void |
decorateBuilder(SCMSourceBuilder<?,?> builder)
SPI: Override this method to decorate a
SCMBuilder . |
protected void |
decorateContext(SCMNavigatorContext<?,?> context)
SPI: Override this method to decorate a
SCMNavigatorContext . |
protected SCMSourceObserver |
decorateObserver(SCMSourceObserver observer)
SPI: Override this method to decorate the
SCMSourceObserver used during a SCMNavigatorRequest . |
SCMNavigatorTraitDescriptor |
getDescriptor() |
protected boolean |
includeCategory(SCMHeadCategory category)
SPI: Override this method to control whether specific
SCMHeadCategory instances are required. |
boolean |
isCategoryEnabled(SCMHeadCategory category)
Checks if the supplied category is required by this trait.
|
public final void applyToContext(SCMNavigatorContext<?,?> context)
SCMNavigatorContext
.context
- the context.protected void decorateContext(SCMNavigatorContext<?,?> context)
SCMNavigatorContext
. You can assume that your
SCMNavigatorTraitDescriptor.isApplicableToContext(Class)
is true
within this method and that
the provided context is an instance of SCMNavigatorTraitDescriptor.getContextClass()
.context
- the context (invariant: SCMNavigatorTraitDescriptor.isApplicableToContext(Class)
is true
and SCMNavigatorTraitDescriptor.getContextClass()
Class.isInstance(Object)
)
is true
)@NonNull public final SCMSourceObserver applyToObserver(@NonNull SCMSourceObserver observer)
SCMNavigatorRequest
.observer
- the observer.@NonNull protected SCMSourceObserver decorateObserver(@NonNull SCMSourceObserver observer)
SCMSourceObserver
used during a SCMNavigatorRequest
.observer
- the observer.public final void applyToBuilder(SCMSourceBuilder<?,?> builder)
SCMBuilder
.builder
- the builder.protected void decorateBuilder(SCMSourceBuilder<?,?> builder)
SCMBuilder
. You can assume that your
SCMNavigatorTraitDescriptor.isApplicableToBuilder(SCMSourceBuilder)
is true
within this method
and that
the provided builder is an instance of SCMNavigatorTraitDescriptor.getBuilderClass()
.builder
- the builder (invariant:
SCMNavigatorTraitDescriptor.isApplicableToBuilder(SCMSourceBuilder)
is
true
and SCMNavigatorTraitDescriptor.getBuilderClass()
Class.isInstance(Object)
) is true
)public final boolean isCategoryEnabled(@NonNull SCMHeadCategory category)
category
- the category.true
if this trait requires the supplied category.protected boolean includeCategory(@NonNull SCMHeadCategory category)
SCMHeadCategory
instances are required.category
- the category.true
to require the category.public SCMNavigatorTraitDescriptor getDescriptor()
getDescriptor
in interface Describable<SCMNavigatorTrait>
getDescriptor
in class SCMTrait<SCMNavigatorTrait>
public static DescriptorExtensionList<SCMNavigatorTrait,SCMNavigatorTraitDescriptor> all()
SCMNavigatorTraitDescriptor
instances.SCMNavigatorTraitDescriptor
instances.public static List<SCMNavigatorTraitDescriptor> _for(@CheckForNull Class<? extends SCMNavigatorContext> contextClass, @CheckForNull Class<? extends SCMSourceBuilder> builderClass)
SCMNavigatorTraitDescriptor
instances that are applicable to the specified types
of SCMNavigatorContext
and SCMSourceBuilder
.contextClass
- (optional) type of SCMNavigatorContext
.builderClass
- (optional) type of SCMSourceBuilder
.SCMNavigatorTraitDescriptor
instances.public static List<SCMNavigatorTraitDescriptor> _for(@CheckForNull SCMNavigatorDescriptor scmNavigator, @CheckForNull Class<? extends SCMNavigatorContext> contextClass, @CheckForNull Class<? extends SCMSourceBuilder> builderClass)
SCMNavigatorTraitDescriptor
instances that are applicable to the specified
SCMNavigatorDescriptor
and specified types of SCMNavigatorContext
and SCMSourceBuilder
.scmNavigator
- (optional) SCMNavigatorDescriptor
.contextClass
- (optional) type of SCMNavigatorContext
.builderClass
- (optional) type of SCMSourceBuilder
.SCMNavigatorTraitDescriptor
instances.Copyright © 2016–2022. All rights reserved.