Top Description Inners Fields Constructors Methods
org.eclipse.jgit.attributes

public final Class Attribute

extends Object
Class Inheritance
Imports
org.eclipse.jgit.annotations.Nullable

Represents an attribute.

According to the man page, an attribute can have the following states:

Since
3.7

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Attribute.State

The attribute value state see also https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

Field Summary

Modifier and TypeField and Description
private final String
private final Attribute.State
private final String

Constructor Summary

AccessConstructor and Description
public
Attribute(String
the attribute key. Should not be null.
key
,
Attribute.State
the attribute state. It should be either org.eclipse.jgit.attributes.Attribute.State#SET or org.eclipse.jgit.attributes.Attribute.State#UNSET. In order to create a custom value attribute prefer the use of Attribute(String, String) constructor.
state
)

Creates a new instance

private
Attribute(String key, Attribute.State state, String value)

public
Attribute(String
the attribute key. Should not be null.
key
,
String
the custom attribute value
value
)

Creates a new instance.

Method Summary

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

Overrides java.lang.Object.equals.

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

public String

Returns:

the attribute key (never returns null)
getKey
()

Get key

public Attribute.State

Returns:

the state (never returns null)
getState
()

Return the state.

public String

Returns:

the attribute value (may be null)
getValue
()

Get value

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

keyback to summary
private final String key
stateback to summary
private final Attribute.State state
valueback to summary
private final String value

Constructor Detail

Attributeback to summary
public Attribute(String key, Attribute.State state)

Creates a new instance

Parameters
key:String

the attribute key. Should not be null.

state:Attribute.State

the attribute state. It should be either org.eclipse.jgit.attributes.Attribute.State#SET or org.eclipse.jgit.attributes.Attribute.State#UNSET. In order to create a custom value attribute prefer the use of Attribute(String, String) constructor.

Attributeback to summary
private Attribute(String key, Attribute.State state, String value)
Attributeback to summary
public Attribute(String key, String value)

Creates a new instance.

Parameters
key:String

the attribute key. Should not be null.

value:String

the custom attribute value

Method Detail

equalsback to summary
public boolean equals(Object obj)

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
obj: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
getKeyback to summary
public String getKey()

Get key

Returns:String

the attribute key (never returns null)

getStateback to summary
public Attribute.State getState()

Return the state.

Returns:Attribute.State

the state (never returns null)

getValueback to summary
public String getValue()

Get value

Returns:String

the attribute value (may be null)

Annotations
@Nullable
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
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
@Override
org.eclipse.jgit.attributes back to summary

public final Enum Attribute.State

extends Enum<Attribute.State>
Class Inheritance

The attribute value state see also https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

Field Summary

Modifier and TypeField and Description
public static final Attribute.State
CUSTOM

the attribute is set to a custom value

public static final Attribute.State
SET

the attribute is set

public static final Attribute.State
UNSET

the attribute is unset

public static final Attribute.State
UNSPECIFIED

the attribute appears as if it would not be defined at all

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Attribute.State
public static Attribute.State[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CUSTOMback to summary
public static final Attribute.State CUSTOM

the attribute is set to a custom value

SETback to summary
public static final Attribute.State SET

the attribute is set

UNSETback to summary
public static final Attribute.State UNSET

the attribute is unset

UNSPECIFIEDback to summary
public static final Attribute.State UNSPECIFIED

the attribute appears as if it would not be defined at all

Since
4.2

Constructor Detail

Stateback to summary
private State()

Method Detail

valueOfback to summary
public static Attribute.State valueOf(String name)
valuesback to summary
public static Attribute.State[] values()