Index (SCM API Plugin 0.1 API)

A B C D E F G H I J L M N O R S T _

A

all() - Static method in class jenkins.scm.api.SCMSourceOwners: Lookup the SCMSourceOwners.
allOf(SCMHeadObserver...) - Static method in class jenkins.scm.api.SCMHeadObserver: Wraps multiple observers returning a combined observer that remains observing as long as at least one of the wrapped observers is still observing.

B

build(SCM, SCMRevision) - Method in class jenkins.scm.api.SCMFileSystem.Builder: Given a SCM this should try to build a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
build(SCMSource, SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMFileSystem.Builder: Given a SCMSource, a SCMHead and a SCMRevision this method should try to build a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.
build(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMSource: Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
build(SCMHead) - Method in class jenkins.scm.api.SCMSource: Builds a SCM instance for the specified head.
build(SCMHead, SCMRevision) - Method in class jenkins.scm.impl.NullSCMSource: Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.
build(SCMHead, SCMRevision) - Method in class jenkins.scm.impl.SingleSCMSource: Builds a SCM instance for the specified head and revision, no validation of the head is performed, a revision for a different head or source will be treated as equivalent to a null revision.

C

children() - Method in class jenkins.scm.api.SCMFile: If this object represents a directory, lists up all the immediate children.
collect() - Static method in class jenkins.scm.api.SCMHeadObserver: Creates an observer that collects all the heads and revisions.
compareTo(SCMHead) - Method in class jenkins.scm.api.SCMHead
content() - Method in class jenkins.scm.api.SCMFile: Reads the content of this file.
contentAsBytes() - Method in class jenkins.scm.api.SCMFile: A convenience method that reads the content and then turns it into a byte array.
contentAsString() - Method in class jenkins.scm.api.SCMFile: A convenience method that reads the content and then turns it into a string.
contentEncoding() - Method in class jenkins.scm.api.SCMFile: Encoding of this file.
contentMimeType() - Method in class jenkins.scm.api.SCMFile: Returns the MIME type of this file.

D

defaultListener(TaskListener) - Method in class jenkins.scm.api.SCMSource: Turns a possibly null TaskListener reference into a guaranteed non-null reference.

E

equals(Object) - Method in class jenkins.scm.api.SCMHead
equals(Object) - Method in class jenkins.scm.api.SCMRevision
equals(Object) - Method in class jenkins.scm.api.SCMSource
exists(String) - Method in class jenkins.scm.api.SCMSourceCriteria.Probe: Checks if the path, relative to the head candidate root, exists or not.

F

fetch(O, TaskListener) - Method in class jenkins.scm.api.SCMSource: Fetches the latest heads and corresponding revisions.
fetch(TaskListener) - Method in class jenkins.scm.api.SCMSource: Fetches the current list of heads.
fetch(SCMHead, TaskListener) - Method in class jenkins.scm.api.SCMSource: Gets the current head revision of the specified head.
first(SCMHeadObserver...) - Static method in class jenkins.scm.api.SCMHeadObserver: Wraps multiple observers returning a combined observer that remains observing until one of the wrapped observers stops observing.
forOwner(SCMSourceOwner) - Static method in class jenkins.scm.api.SCMSourceDescriptor: Returns the list of descriptors that are appropriate for a specified owner and SCMSourceDescriptor.isUserInstantiable().
forOwner(SCMSourceOwner, boolean) - Static method in class jenkins.scm.api.SCMSourceDescriptor: Returns the list of descriptors that are appropriate for a specified owner with the additional filter by SCMSourceDescriptor.isUserInstantiable().
forOwner(Class<? extends SCMSourceOwner>) - Static method in class jenkins.scm.api.SCMSourceDescriptor: Returns the list of descriptors that are appropriate for a specified type of owner and SCMSourceDescriptor.isUserInstantiable().
forOwner(Class<? extends SCMSourceOwner>, boolean) - Static method in class jenkins.scm.api.SCMSourceDescriptor: Returns the list of descriptors that are appropriate for a specified type of owner with the additional filter by SCMSourceDescriptor.isUserInstantiable().

G

get(String) - Method in class jenkins.scm.api.SCMFile: Gets a child/descendant path relative from this object.
get(String) - Method in class jenkins.scm.api.SCMFileSystem: Short for getRoot().get(path)
getCriteria() - Method in class jenkins.scm.api.SCMSource: Returns the branch criteria.
getDisplayName() - Method in class jenkins.scm.impl.SingleSCMSource.DescriptorImpl
getHead() - Method in class jenkins.scm.api.SCMRevision: Returns the SCMHead that this SCMRevision belongs to.
getId() - Method in class jenkins.scm.api.SCMSource: The ID of this source.
getId(SCMSource) - Method in class jenkins.scm.api.SCMSourceDescriptor: Return or generate the ID for a source instance.
getName() - Method in class jenkins.scm.api.SCMFile: Gets the file name of this file without any path portion, such as just "foo.txt"
This method is the equivalent of File.getName()
getName() - Method in class jenkins.scm.api.SCMHead: Returns the name.
getOwner() - Method in class jenkins.scm.api.SCMSource: Gets the owner.
getRevision() - Method in class jenkins.scm.api.SCMFileSystem: If this inspector is looking at the specific commit, returns that revision.
getRevision() - Method in class jenkins.scm.api.SCMRevisionAction: Gets the SCMRevision.
getRevision(Actionable) - Static method in class jenkins.scm.api.SCMRevisionAction: Gets the SCMRevision from the specified Actionable.
getRoot() - Method in class jenkins.scm.api.SCMFileSystem: Returns the SCMFile object that represents the root directory of the repository.
getRoot() - Method in class jenkins.scm.api.SCMSourceCriteria.Probe: Returns the SCMFile of the root of this head candidate if such deep introspection can be cheaply provided by the version control system in question.
getSCMDescriptors(SCMSourceOwner) - Static method in class jenkins.scm.impl.SingleSCMSource.DescriptorImpl: Returns the SCMDescriptor instances that are appropriate for the current context.
getSCMSource(String) - Method in interface jenkins.scm.api.SCMSourceOwner: Gets the source with the specified SCMSource.getId().
getSCMSourceCriteria(SCMSource) - Method in interface jenkins.scm.api.SCMSourceOwner: Returns the criteria for determining if a candidate head is relevant for consumption.
getSCMSources() - Method in interface jenkins.scm.api.SCMSourceOwner: Returns the SCMSource instances that this item is consuming.

H

hashCode() - Method in class jenkins.scm.api.SCMHead
hashCode() - Method in class jenkins.scm.api.SCMRevision
hashCode() - Method in class jenkins.scm.api.SCMSource

I

ID - Static variable in class jenkins.scm.impl.NullSCMSource: The "magic" id of the NullSCMSource.
isApplicable(Class<? extends SCMSourceOwner>) - Method in class jenkins.scm.api.SCMSourceDescriptor: Returns true if this source type is applicable to the given owner.
isContentBinary() - Method in class jenkins.scm.api.SCMFile: Checks if this file is a binary file.
isContentText() - Method in class jenkins.scm.api.SCMFile: The opposite of SCMFile.isContentBinary()
isDeterministic() - Method in class jenkins.scm.api.SCMRevision: Returns true if and only if this revision is deterministic, in other words that repeated checkouts of this revision will result in the exact same files being checked out.
isDirectory() - Method in class jenkins.scm.api.SCMFile: Returns true if this object represents a directory.
isFile() - Method in class jenkins.scm.api.SCMFile: Returns true if this object represents a file.
isFixedRevision() - Method in class jenkins.scm.api.SCMFileSystem: Whether this inspector is looking at the specific commit.
isHead(SCMSourceCriteria.Probe, TaskListener) - Method in interface jenkins.scm.api.SCMSourceCriteria: Validates if a potential head is actually a head.
isObserving() - Method in class jenkins.scm.api.SCMHeadObserver.AllFinished: Returns information about whether the observer wants more results.
isObserving() - Method in class jenkins.scm.api.SCMHeadObserver: Returns information about whether the observer wants more results.
isObserving() - Method in class jenkins.scm.api.SCMHeadObserver.OneFinished: Returns information about whether the observer wants more results.
isObserving() - Method in class jenkins.scm.api.SCMHeadObserver.Selector: Returns information about whether the observer wants more results.
isUserInstantiable() - Method in class jenkins.scm.api.SCMSourceDescriptor: Returns true if the source type is one that the user is permitted to configure.
iterator() - Method in class jenkins.scm.api.SCMSourceOwners.JenkinsItemEnumerator

J

jenkins.scm.api - package jenkins.scm.api
jenkins.scm.impl - package jenkins.scm.impl

L

lastModified() - Method in class jenkins.scm.api.SCMSourceCriteria.Probe: Returns the time that the potential head was last modified.

M

Messages - Class in jenkins.scm.api
Messages() - Constructor for class jenkins.scm.api.Messages
Messages - Class in jenkins.scm.impl
Messages() - Constructor for class jenkins.scm.impl.Messages

N

name() - Method in class jenkins.scm.api.SCMSourceCriteria.Probe: Returns the name of the potential head.
NullSCMSource - Class in jenkins.scm.impl: A special SCMSource that does not fetch any SCMHead instances and will build instances of NullSCM.
NullSCMSource() - Constructor for class jenkins.scm.impl.NullSCMSource: Constructor.

O

observe(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMHeadObserver.AllFinished: Observes a head and current revision.
observe(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMHeadObserver.Collector: Observes a head and current revision.
observe(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMHeadObserver: Observes a head and current revision.
observe(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMHeadObserver.OneFinished: Observes a head and current revision.
observe(SCMHead, SCMRevision) - Method in class jenkins.scm.api.SCMHeadObserver.Selector: Observes a head and current revision.
of(SCM) - Static method in class jenkins.scm.api.SCMFileSystem: Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance.
of(SCM, SCMRevision) - Static method in class jenkins.scm.api.SCMFileSystem: Given a SCM this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content at the specified SCMRevision.
of(SCMSource, SCMHead) - Static method in class jenkins.scm.api.SCMFileSystem: Given a SCMSource and a SCMHead this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead.
of(SCMSource, SCMHead, SCMRevision) - Static method in class jenkins.scm.api.SCMFileSystem: Given a SCMSource, a SCMHead and a SCMRevision this method will try to retrieve a corresponding SCMFileSystem instance that reflects the content of the specified SCMHead at the specified SCMRevision.
onSCMSourceUpdated(SCMSource) - Method in interface jenkins.scm.api.SCMSourceOwner: Called when a source has received notification of an update.

R

result() - Method in class jenkins.scm.api.SCMHeadObserver.Collector: Returns the collected results.
result() - Method in class jenkins.scm.api.SCMHeadObserver.Selector: Returns the result.
retrieve(SCMHeadObserver, TaskListener) - Method in class jenkins.scm.api.SCMSource: Fetches the latest heads and corresponding revisions.
retrieve(TaskListener) - Method in class jenkins.scm.api.SCMSource: Fetches the current list of heads.
retrieve(SCMHead, TaskListener) - Method in class jenkins.scm.api.SCMSource: Gets the current head revision of the specified head.
retrieve(SCMHeadObserver, TaskListener) - Method in class jenkins.scm.impl.NullSCMSource: Fetches the latest heads and corresponding revisions.
retrieve(SCMHeadObserver, TaskListener) - Method in class jenkins.scm.impl.SingleSCMSource: Fetches the latest heads and corresponding revisions.

S

SCMFile - Class in jenkins.scm.api: A file/directory inspected by SCMFileSystem.
SCMFile() - Constructor for class jenkins.scm.api.SCMFile
SCMFileSystem - Class in jenkins.scm.api: A virtual file system for a specific SCM potentially pinned to a specific SCMRevision.
SCMFileSystem(SCMRevision) - Constructor for class jenkins.scm.api.SCMFileSystem
SCMFileSystem.Builder - Class in jenkins.scm.api: Extension point that allows different plugins to implement SCMFileSystem classes for the same SCM or SCMSource and let Jenkins pick the most capable for any specific SCM implementation.
SCMFileSystem.Builder() - Constructor for class jenkins.scm.api.SCMFileSystem.Builder
SCMHead - Class in jenkins.scm.api: Represents a named SCM branch, tag or mainline.
SCMHead(String) - Constructor for class jenkins.scm.api.SCMHead: Constructor.
SCMHeadObserver - Class in jenkins.scm.api: Something that observes SCMHead and corresponding SCMRevision details.
SCMHeadObserver() - Constructor for class jenkins.scm.api.SCMHeadObserver
SCMHeadObserver.AllFinished - Class in jenkins.scm.api: An observer that wraps multiple observers and keeps observing as long as one of the wrapped observers wants to.
SCMHeadObserver.AllFinished(SCMHeadObserver...) - Constructor for class jenkins.scm.api.SCMHeadObserver.AllFinished: Constructor.
SCMHeadObserver.AllFinished(Iterable<SCMHeadObserver>) - Constructor for class jenkins.scm.api.SCMHeadObserver.AllFinished: Constructor.
SCMHeadObserver.Collector - Class in jenkins.scm.api: An observer that collects the observed SCMHeads and SCMRevisions.
SCMHeadObserver.Collector() - Constructor for class jenkins.scm.api.SCMHeadObserver.Collector
SCMHeadObserver.OneFinished - Class in jenkins.scm.api: An observer that wraps multiple observers and keeps observing until one of the wrapped observers stops observing.
SCMHeadObserver.OneFinished(SCMHeadObserver...) - Constructor for class jenkins.scm.api.SCMHeadObserver.OneFinished: Constructor.
SCMHeadObserver.OneFinished(Iterable<SCMHeadObserver>) - Constructor for class jenkins.scm.api.SCMHeadObserver.OneFinished: Constructor.
SCMHeadObserver.Selector - Class in jenkins.scm.api: An observer that collects the SCMRevision of a specific SCMHead and then stops observing.
SCMHeadObserver.Selector(SCMHead) - Constructor for class jenkins.scm.api.SCMHeadObserver.Selector: Constructor.
SCMRevision - Class in jenkins.scm.api: Base class that represents a specific (or not so specific) revision of a SCMHead.
SCMRevision(SCMHead) - Constructor for class jenkins.scm.api.SCMRevision: Constructor.
SCMRevisionAction - Class in jenkins.scm.api: Action added to AbstractBuild to remember which revision is built in the given build.
SCMRevisionAction(SCMRevision) - Constructor for class jenkins.scm.api.SCMRevisionAction: Constructor.
SCMSource - Class in jenkins.scm.api: A SCMSource is responsible for fetching SCMHead and corresponding SCMRevision instances from which it can build SCM instances that are configured to check out the specific SCMHead at the specified SCMRevision.
SCMSource(String) - Constructor for class jenkins.scm.api.SCMSource: Constructor.
SCMSourceCriteria - Interface in jenkins.scm.api: Filter that selects heads picked up by SCMSource out of all the branches and other heads found in the repository.
SCMSourceCriteria.Probe - Class in jenkins.scm.api: A probe for a branch candidate.
SCMSourceCriteria.Probe() - Constructor for class jenkins.scm.api.SCMSourceCriteria.Probe
SCMSourceDescriptor - Class in jenkins.scm.api: A Descriptor for SCMSources.
SCMSourceDescriptor() - Constructor for class jenkins.scm.api.SCMSourceDescriptor
SCMSourceOwner - Interface in jenkins.scm.api: An Item that owns SCMSource instances.
SCMSourceOwners - Class in jenkins.scm.api: Provides a means to lookup the SCMSourceOwners that own SCMSource instances.
SCMSourceOwners() - Constructor for class jenkins.scm.api.SCMSourceOwners
SCMSourceOwners.Enumerator - Class in jenkins.scm.api: Extension point to allow for access to embedded SCMSourceOwner instances that SCMSourceOwners.JenkinsItemEnumerator will not find.
SCMSourceOwners.Enumerator() - Constructor for class jenkins.scm.api.SCMSourceOwners.Enumerator
SCMSourceOwners.JenkinsItemEnumerator - Class in jenkins.scm.api: Provide all the Jenkins items that are SCMSourceOwners.
SCMSourceOwners.JenkinsItemEnumerator() - Constructor for class jenkins.scm.api.SCMSourceOwners.JenkinsItemEnumerator
select(SCMHead) - Static method in class jenkins.scm.api.SCMHeadObserver: Creates an observer that selects the revision of a specific head.
setOwner(SCMSourceOwner) - Method in class jenkins.scm.api.SCMSource: Sets the owner.
SingleSCMSource - Class in jenkins.scm.impl: A single fixed branch using a legacy SCM implementation.
SingleSCMSource(String, String, SCM) - Constructor for class jenkins.scm.impl.SingleSCMSource: Our constructor.
SingleSCMSource.DescriptorImpl - Class in jenkins.scm.impl: Our descriptor.
SingleSCMSource.DescriptorImpl() - Constructor for class jenkins.scm.impl.SingleSCMSource.DescriptorImpl
SingleSCMSource_DisplayName() - Static method in class jenkins.scm.impl.Messages: Single Source

T

toString() - Method in class jenkins.scm.api.SCMHead
toString() - Method in class jenkins.scm.api.SCMSource

_

_SingleSCMSource_DisplayName() - Static method in class jenkins.scm.impl.Messages: Single Source

A B C D E F G H I J L M N O R S T _