Git.framework Reference Library

GITRefResolver Class Reference

GITRefResolver Class Reference

Declared in GITRefResolver.h

Overview

The GITRefResolver class provides methods to return GITRef objects by their name. The class also provides methods to obtain arrays of GITRef objects by tags, heads and remotes.

Tasks

Class Methods

resolverForRepo:

+ (GITRefResolver *)resolverForRepo:(GITRepo *)theRepo
Parameters
theRepo

The repository the receiver will resolve with

Return Value

resolver initialised with the specified repository

Discussion

Creates and returns an autoreleased Ref Resolver for the given repository.

See Also
Declared In
GITRefResolver.h

Instance Methods

initWithRepo:

- (id)initWithRepo:(GITRepo *)theRepo
Parameters
theRepo

The repository the receiver will resolve with

Return Value

resolver initialised with the specified repository

Discussion

Creates and returns a Ref Resolver for the given repository.

Declared In
GITRefResolver.h

resolveRefWithName:

- (GITRef *)resolveRefWithName:(NSString *)theName
Parameters
theName

Name of the reference to resolve

Return Value

Reference resolved from the specified name, or nil if the reference cannot be found or if an error occurred

Discussion

Returns a reference by resolving the specified name.

Resolves references in the following order:

  • refs/

  • refs/tags/

  • refs/heads/

  • refs/remotes/

See Also
Declared In
GITRefResolver.h

resolveRefWithName:error:

- (GITRef *)resolveRefWithName:(NSString *)theName error:(NSError **)theError
Parameters
theName

Name of the reference to resolve

theError

NSError describing the error that occurred

Return Value

Reference resolved from the specified name, or nil if the reference cannot be found or if an error occurred

Discussion

Returns a reference by resolving the specified name.

Resolves references in the following order:

  • refs/

  • refs/tags/

  • refs/heads/

  • refs/remotes/

Declared In
GITRefResolver.h

allRefs

- (NSArray *)allRefs
Return Value

array of all the references in the receivers repository

Discussion

Returns an array of all the references in the receivers repository.

Declared In
GITRefResolver.h

tagRefs

- (NSArray *)tagRefs
Return Value

array of all the tag references in the receivers repository

Discussion

Returns an array of all the tag references in the receivers repository.

See Also
Declared In
GITRefResolver.h

headRefs

- (NSArray *)headRefs
Return Value

array of all the head references in the receivers repository

Discussion

Returns an array of all the head references in the receivers repository.

See Also
Declared In
GITRefResolver.h

remoteRefs

- (NSArray *)remoteRefs
Return Value

array of all the head references in the receivers repository

Discussion

Returns an array of all the head references in the receivers repository.

See Also
Declared In
GITRefResolver.h

Last updated: 2011-2-20