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

public Class PushCertificateIdent

extends Object
Class Inheritance
Static Imports
java.nio.charset.StandardCharsets.UTF_8, org.eclipse.jgit.util.RawParseUtils.lastIndexOfTrim

Identity in a push certificate.

This is similar to a org.eclipse.jgit.lib.PersonIdent in that it contains a name, timestamp, and timezone offset, but differs in the following ways:

Since
4.1

Field Summary

Modifier and TypeField and Description
private final String
private final int
private final String
private final long

Constructor Summary

AccessConstructor and Description
public
PushCertificateIdent(String
OpenPGP User ID; any UTF-8 string.
userId
,
long
local time.
when
,
int
timezone offset; see getTimeZoneOffset().
tzOffset
)

Construct a new identity from an OpenPGP User ID.

private
PushCertificateIdent(String raw, String userId, long when, int tzOffset)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public String

Returns:

the email portion of the User ID, if one was successfully parsed from getUserId(), or null.
getEmailAddress
()

Get the email portion of the User ID

public String

Returns:

the name portion of the User ID. If no email address would be parsed by getEmailAddress(), returns the full User ID with spaces trimmed.
getName
()

Get the name portion of the User ID.

public String

Returns:

the raw string.
getRaw
()

Get the raw string from which this identity was parsed.

public TimeZone

Returns:

this person's declared time zone; null if the timezone is unknown.
getTimeZone
()

Get this person's declared time zone

public int

Returns:

this person's declared time zone as minutes east of UTC. If the timezone is to the west of UTC it is negative.
getTimeZoneOffset
()

Get this person's declared time zone as minutes east of UTC.

public String

Returns:

the OpenPGP User ID, which may be any string.
getUserId
()

Get the OpenPGP User ID, which may be any string.

public Date

Returns:

the timestamp of the identity.
getWhen
()

Get the timestamp of the identity.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static PushCertificateIdent
parse(String
string to parse.
str
)

Parse an identity from a string.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

rawback to summary
private final String raw
tzOffsetback to summary
private final int tzOffset
userIdback to summary
private final String userId
whenback to summary
private final long when

Constructor Detail

PushCertificateIdentback to summary
public PushCertificateIdent(String userId, long when, int tzOffset)

Construct a new identity from an OpenPGP User ID.

Parameters
userId:String

OpenPGP User ID; any UTF-8 string.

when:long

local time.

tzOffset:int

timezone offset; see getTimeZoneOffset().

PushCertificateIdentback to summary
private PushCertificateIdent(String raw, String userId, long when, int tzOffset)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getEmailAddressback to summary
public String getEmailAddress()

Get the email portion of the User ID

Returns:String

the email portion of the User ID, if one was successfully parsed from getUserId(), or null.

getNameback to summary
public String getName()

Get the name portion of the User ID.

Returns:String

the name portion of the User ID. If no email address would be parsed by getEmailAddress(), returns the full User ID with spaces trimmed.

getRawback to summary
public String getRaw()

Get the raw string from which this identity was parsed.

If the string was constructed manually, a suitable canonical string is returned.

For the purposes of bytewise comparisons with other OpenPGP IDs, the string must be encoded as UTF-8.

Returns:String

the raw string.

getTimeZoneback to summary
public TimeZone getTimeZone()

Get this person's declared time zone

Returns:TimeZone

this person's declared time zone; null if the timezone is unknown.

getTimeZoneOffsetback to summary
public int getTimeZoneOffset()

Get this person's declared time zone as minutes east of UTC.

Returns:int

this person's declared time zone as minutes east of UTC. If the timezone is to the west of UTC it is negative.

getUserIdback to summary
public String getUserId()

Get the OpenPGP User ID, which may be any string.

Returns:String

the OpenPGP User ID, which may be any string.

getWhenback to summary
public Date getWhen()

Get the timestamp of the identity.

Returns:Date

the timestamp of the identity.

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
parseback to summary
public static PushCertificateIdent parse(String str)

Parse an identity from a string.

Spaces are trimmed when parsing the timestamp and timezone offset, with one exception. The timestamp must be preceded by a single space, and the rest of the string prior to that space (including any additional whitespace) is treated as the OpenPGP User ID.

If either the timestamp or timezone offsets are missing, mimics RawParseUtils#parsePersonIdent(String) behavior and sets them both to zero.

Parameters
str:String

string to parse.

Returns:PushCertificateIdent

a org.eclipse.jgit.transport.PushCertificateIdent object.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@SuppressWarnings:nls
@Override