Git.framework Reference Library

GITObjectHash Class Reference

GITObjectHash Class Reference

Declared in GITObjectHash.h

Overview

The GITObjectHash class provides methods for packing and unpacking SHA1 hashes in both NSString and NSData forms. GITObjectHash objects provide

Tasks

Class Methods

objectHashWithData:

+ (GITObjectHash *)objectHashWithData:(NSData *)hashData
Parameters
hashData

NSData containing a packed or unpacked SHA1

Return Value

object hash with the NSData object

Discussion

Creates an autoreleased object hash with an NSData containing a packed or unpacked SHA1.

See Also
Declared In
GITObjectHash.h

objectHashWithString:

+ (GITObjectHash *)objectHashWithString:(NSString *)hashString
Parameters
hashString

String containing a packed or unpacked SHA1

Return Value

object hash with the string

Discussion

Returns an object hash with a string containing a packed or unpacked SHA1.

See Also
Declared In
GITObjectHash.h

objectHashWithObjectData:

+ (GITObjectHash *)objectHashWithObjectData:(NSData *)objectData
Parameters
objectData

Object data to create GITObjectHash of

Return Value

object hash of the data object

Discussion

Returns an object hash from the SHA1 Hash of the provided data object.

See Also
Declared In
GITObjectHash.h

unpackedStringFromData:

+ (NSString *)unpackedStringFromData:(NSData *)data
Parameters
data

Data containing the packed SHA1

Return Value

NSString containing the unpacked SHA1

Discussion

Returns a string containing the unpacked SHA1 of the packed data.

Declared In
GITObjectHash.h

packedStringFromData:

+ (NSString *)packedStringFromData:(NSData *)data
Parameters
data

NSData containing the unpacked SHA1

Return Value

NSString containing the packed SHA1

Discussion

Returns a string containing the packed SHA1 of the unpacked data.

See Also
Declared In
GITObjectHash.h

unpackedDataFromString:

+ (NSData *)unpackedDataFromString:(NSString *)str
Parameters
str

String containing the packed SHA1

Return Value

NSData containing the unpacked SHA1

Discussion

Returns data containing the unpacked SHA1 of the packed string.

Declared In
GITObjectHash.h

packedDataFromString:

+ (NSData *)packedDataFromString:(NSString *)str
Parameters
str

String containing the unpacked SHA1

Return Value

NSData containing the packed SHA1

Discussion

Returns data containing the packed SHA1 of the unpacked string.

Declared In
GITObjectHash.h

unpackedDataFromData:

+ (NSData *)unpackedDataFromData:(NSData *)data
Parameters
data

NSData object containing packed SHA1

Return Value

NSData object containing unpacked SHA1

Discussion

Returns an NSData object containing the unpacked SHA1 of the packed data.

See Also
Declared In
GITObjectHash.h

packedDataFromData:

+ (NSData *)packedDataFromData:(NSData *)data
Parameters
data

NSData object containing unpacked SHA1

Return Value

NSData object containing packed SHA1

Discussion

Returns an NSData object containing the packed SHA1 of the unpacked data.

See Also
Declared In
GITObjectHash.h

unpackedDataFromBytes:length:

+ (NSData *)unpackedDataFromBytes:(uint8_t *)bytes length:(NSUInteger)length
Parameters
bytes

Byte array containing the packed SHA1

length

Size of the byte array

Return Value

NSData object containing unpacked SHA1

Discussion

Returns an NSData object containing the unpacked SHA1 of the packed bytes.

See Also
Declared In
GITObjectHash.h

packedDataFromBytes:length:

+ (NSData *)packedDataFromBytes:(uint8_t *)bytes length:(NSUInteger)length
Parameters
bytes

Byte array containing the unpacked SHA1

length

Size of the byte array

Return Value

NSData object containing packed SHA1

Discussion

Returns an NSData object containing the packed SHA1 of the unpacked bytes.

See Also
Declared In
GITObjectHash.h

Instance Methods

initWithString:

- (id)initWithString:(NSString *)str
Parameters
str

String containing a packed or unpacked SHA1

Return Value

object hash with the string

Discussion

Returns an object hash with a string containing a packed or unpacked SHA1.

See Also
Declared In
GITObjectHash.h

initWithData:

- (id)initWithData:(NSData *)data
Parameters
data

NSData containing a packed or unpacked SHA1

Return Value

object hash with the NSData object

Discussion

Returns an object hash with an NSData containing a packed or unpacked SHA1.

See Also
Declared In
GITObjectHash.h

initWithObjectData:

- (id)initWithObjectData:(NSData *)objectData
Parameters
objectData

Object data to create GITObjectHash of

Return Value

object hash of the data object

Discussion

Returns an object hash from the SHA1 Hash of the provided data object.

See Also
Declared In
GITObjectHash.h

unpackedString

- (NSString *)unpackedString
Return Value

unpacked string of the object hash

Discussion

Returns the unpacked string of the object hash.

See Also
Declared In
GITObjectHash.h

unpackedData

- (NSData *)unpackedData
Return Value

unpacked data of the object hash

Discussion

Returns the unpacked data of the object hash.

See Also
Declared In
GITObjectHash.h

packedData

- (NSData *)packedData
Return Value

packed data of the object hash

Discussion

Returns the packed data of the object hash.

See Also
Declared In
GITObjectHash.h

isEqual:

- (BOOL)isEqual:(id)other
Parameters
other

The object to be compared to the receiver

Return Value

YES if the receiver and other are equal, otherwise NO

Discussion

Returns a Boolean value that indicates whether the receiver and a given object are equal.

See Also
Declared In
GITObjectHash.h

isEqualToData:

- (BOOL)isEqualToData:(NSData *)data
Parameters
data

The data object with which to compare the receiver

Return Value

YES if the receiver and data are equal, otherwise NO

Discussion

Returns a Boolean value that indicates whether the receiver and a given data object are equal.

See Also
Declared In
GITObjectHash.h

isEqualToString:

- (BOOL)isEqualToString:(NSString *)str
Parameters
str

The string with which to compare the receiver

Return Value

YES if the receiver and str are equal, otherwise NO

Discussion

Returns a Boolean value that indicates whether the receiver and a given string are equal.

See Also
Declared In
GITObjectHash.h

isEqualToObjectHash:

- (BOOL)isEqualToObjectHash:(GITObjectHash *)hash
Parameters
hash

The ObjectHash with which to compare the receiver

Return Value

YES if the receiver and hash are equal, otherwise NO

Discussion

Returns a Boolean value that indicates whether the receiver and a given ObjectHash are equal.

See Also
Declared In
GITObjectHash.h

compare:

- (NSComparisonResult)compare:(GITObjectHash *)hash
Parameters
hash

The object hash with which to compare the receiver. This value must not be nil. If the value is nil, the behavior is undefined.

Return Value

NSOrderedAscending if the value of hash is greater than the receiver’s, NSOrderedSame if they’re equal, and NSOrderedDescending if the value of hash is less than the receiver’s.

Discussion

Returns an NSComparisonResult value that indicates whether the receiver is greater than, equal to, or less than a given object hash.

Declared In
GITObjectHash.h

Last updated: 2011-2-20