Top Description Fields Constructors Methods
org.eclipse.jgit.transport

public abstract Class OperationResult

extends Object
Class Inheritance
Known Direct Subclasses
org.eclipse.jgit.transport.PushResult, org.eclipse.jgit.transport.FetchResult
Imports
java.util.Collection, .Collections, .Map, .SortedMap, .TreeMap, org.eclipse.jgit.lib.Ref
Class holding result of operation on remote repository. This includes refs advertised by remote repo and local tracking refs updates.

Field Summary

Modifier and TypeField and Description
pack-priv Map<String, Ref>
advertisedRefs

pack-priv StringBuilder
messageBuffer

pack-priv String
peerUserAgent

pack-priv final SortedMap<String, TrackingRefUpdate>
updates

pack-priv URIish
uri

Constructor Summary

AccessConstructor and Description
public
OperationResult()

Method Summary

Modifier and TypeMethod and Description
pack-priv void
add(TrackingRefUpdate u)

pack-priv void
addMessages(String msg)

public final Ref

Returns:

the requested ref; null if the remote did not advertise this ref.
getAdvertisedRef(String
name of the ref to obtain.
name)

Get a single advertised ref by name.

public Collection<Ref>

Returns:

available/advertised refs. Never null. Not modifiable. The collection can be empty if the remote side has no refs (it is an empty/newly created repository).
getAdvertisedRefs()

Get the complete list of refs advertised by the remote.

public String

Returns:

the messages returned by the remote, most likely terminated by a newline (LF) character. The empty string is returned if the remote produced no additional messages.
getMessages()

Get the additional messages, if any, returned by the remote process.

public String

Returns:

advertised user agent, e.g. "JGit/4.0". Null if the peer did not advertise version information.
getPeerUserAgent()

Get the user agent advertised by the peer server, if available.

public TrackingRefUpdate

Returns:

status of the local ref; null if this local ref was not touched during this operation.
getTrackingRefUpdate(String
name of the local ref (e.g. "refs/remotes/origin/master").
localName)

Get the status for a specific local tracking ref update.

public Collection<TrackingRefUpdate>

Returns:

unmodifiable collection of local updates. Never null. Empty if there were no local tracking refs updated.
getTrackingRefUpdates()

Get the status of all local tracking refs that were updated.

public URIish

Returns:

the URI describing the location of the remote repository.
getURI()

Get the URI this result came from.

pack-priv void
setAdvertisedRefs(URIish u, Map<String, Ref> ar)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

advertisedRefsback to summary
pack-priv Map<String, Ref> advertisedRefs
messageBufferback to summary
pack-priv StringBuilder messageBuffer
peerUserAgentback to summary
pack-priv String peerUserAgent
updatesback to summary
pack-priv final SortedMap<String, TrackingRefUpdate> updates
uriback to summary
pack-priv URIish uri

Constructor Detail

OperationResultback to summary
public OperationResult()

Method Detail

addback to summary
pack-priv void add(TrackingRefUpdate u)
addMessagesback to summary
pack-priv void addMessages(String msg)
getAdvertisedRefback to summary
public final Ref getAdvertisedRef(String name)

Get a single advertised ref by name.

The name supplied should be valid ref name. To get a peeled value for a ref (aka refs/tags/v1.0^{}) use the base name (without the ^{} suffix) and look at the peeled object id.

Parameters
name:String

name of the ref to obtain.

Returns:Ref

the requested ref; null if the remote did not advertise this ref.

getAdvertisedRefsback to summary
public Collection<Ref> getAdvertisedRefs()

Get the complete list of refs advertised by the remote.

The returned refs may appear in any order. If the caller needs these to be sorted, they should be copied into a new array or List and then sorted by the caller as necessary.

Returns:Collection<Ref>

available/advertised refs. Never null. Not modifiable. The collection can be empty if the remote side has no refs (it is an empty/newly created repository).

getMessagesback to summary
public String getMessages()

Get the additional messages, if any, returned by the remote process.

These messages are most likely informational or error messages, sent by the remote peer, to help the end-user correct any problems that may have prevented the operation from completing successfully. Application UIs should try to show these in an appropriate context.

Returns:String

the messages returned by the remote, most likely terminated by a newline (LF) character. The empty string is returned if the remote produced no additional messages.

getPeerUserAgentback to summary
public String getPeerUserAgent()

Get the user agent advertised by the peer server, if available.

Returns:String

advertised user agent, e.g. "JGit/4.0". Null if the peer did not advertise version information.

Since
4.0
getTrackingRefUpdateback to summary
public TrackingRefUpdate getTrackingRefUpdate(String localName)

Get the status for a specific local tracking ref update.

Parameters
localName:String

name of the local ref (e.g. "refs/remotes/origin/master").

Returns:TrackingRefUpdate

status of the local ref; null if this local ref was not touched during this operation.

getTrackingRefUpdatesback to summary
public Collection<TrackingRefUpdate> getTrackingRefUpdates()

Get the status of all local tracking refs that were updated.

Returns:Collection<TrackingRefUpdate>

unmodifiable collection of local updates. Never null. Empty if there were no local tracking refs updated.

getURIback to summary
public URIish getURI()

Get the URI this result came from.

Each transport instance connects to at most one URI at any point in time.

Returns:URIish

the URI describing the location of the remote repository.

setAdvertisedRefsback to summary
pack-priv void setAdvertisedRefs(URIish u, Map<String, Ref> ar)