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

public final Class Attributes

extends Object
Class Inheritance
Imports
java.util.ArrayList, .Collection, .LinkedHashMap, .Map, org.eclipse.jgit.attributes.Attribute.State, org.eclipse.jgit.lib.Constants
Represents a set of attributes for a path
Since
4.2

Field Summary

Modifier and TypeField and Description
private final Map<String, Attribute>
map

Constructor Summary

AccessConstructor and Description
public
Attributes(Attribute...
a org.eclipse.jgit.attributes.Attribute
attributes)

Creates a new instance

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the entry can be content merged, false otherwise
canBeContentMerged()

Test if the given attributes implies to handle the related entry as a binary file (i.e. if the entry has an -merge or a merge=binary attribute) or if it can be content merged.

public boolean

Returns:

true if the org.eclipse.jgit.attributes.Attributes contains this key
containsKey(String
key of an attribute
key)

Whether there is an attribute with this key

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 Attribute

Returns:

the attribute or null
get(String
a java.lang.String object.
key)

Get the attribute with the given key

public Collection<Attribute>

Returns:

all attributes
getAll()

Get all attributes

public Attribute.State

Returns:

the state (never returns null)
getState(String
key of an attribute
key)

Return the state.

public String

Returns:

the attribute value (may be null)
getValue(String
an attribute key
key)

Get attribute value

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean

Returns:

true if the key is org.eclipse.jgit.attributes.Attribute.State#CUSTOM, false in all other cases see getValue(String) for the value of the key
isCustom(String
a java.lang.String object.
key)

Is this a custom attribute

public boolean

Returns:

true if the set does not contain any attributes
isEmpty()

Whether the set of attributes is empty

public boolean

Returns:

true if the key is org.eclipse.jgit.attributes.Attribute.State#SET, false in all other cases
isSet(String
a java.lang.String object.
key)

Whether the attribute is set

public boolean

Returns:

true if the key is org.eclipse.jgit.attributes.Attribute.State#UNSET, false in all other cases
isUnset(String
a java.lang.String object.
key)

Whether the attribute is unset

public boolean

Returns:

true if the key is org.eclipse.jgit.attributes.Attribute.State#UNSPECIFIED, false in all other cases
isUnspecified(String
a java.lang.String object.
key)

Whether the attribute with the given key is unspecified

public void
put(Attribute
an org.eclipse.jgit.attributes.Attribute
a)

Put an attribute

public void
remove(String
an attribute name
key)

Remove attribute with given key

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

mapback to summary
private final Map<String, Attribute> map

Constructor Detail

Attributesback to summary
public Attributes(Attribute... attributes)

Creates a new instance

Parameters
attributes:Attribute[]

a org.eclipse.jgit.attributes.Attribute

Method Detail

canBeContentMergedback to summary
public boolean canBeContentMerged()

Test if the given attributes implies to handle the related entry as a binary file (i.e. if the entry has an -merge or a merge=binary attribute) or if it can be content merged.

Returns:boolean

true if the entry can be content merged, false otherwise

Since
4.9
containsKeyback to summary
public boolean containsKey(String key)

Whether there is an attribute with this key

Parameters
key:String

key of an attribute

Returns:boolean

true if the org.eclipse.jgit.attributes.Attributes contains this key

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
getback to summary
public Attribute get(String key)

Get the attribute with the given key

Parameters
key:String

a java.lang.String object.

Returns:Attribute

the attribute or null

getAllback to summary
public Collection<Attribute> getAll()

Get all attributes

Returns:Collection<Attribute>

all attributes

getStateback to summary
public Attribute.State getState(String key)

Return the state.

Parameters
key:String

key of an attribute

Returns:Attribute.State

the state (never returns null)

getValueback to summary
public String getValue(String key)

Get attribute value

Parameters
key:String

an attribute key

Returns:String

the attribute value (may be null)

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
isCustomback to summary
public boolean isCustom(String key)

Is this a custom attribute

Parameters
key:String

a java.lang.String object.

Returns:boolean

true if the key is org.eclipse.jgit.attributes.Attribute.State#CUSTOM, false in all other cases see getValue(String) for the value of the key

isEmptyback to summary
public boolean isEmpty()

Whether the set of attributes is empty

Returns:boolean

true if the set does not contain any attributes

isSetback to summary
public boolean isSet(String key)

Whether the attribute is set

Parameters
key:String

a java.lang.String object.

Returns:boolean

true if the key is org.eclipse.jgit.attributes.Attribute.State#SET, false in all other cases

isUnsetback to summary
public boolean isUnset(String key)

Whether the attribute is unset

Parameters
key:String

a java.lang.String object.

Returns:boolean

true if the key is org.eclipse.jgit.attributes.Attribute.State#UNSET, false in all other cases

isUnspecifiedback to summary
public boolean isUnspecified(String key)

Whether the attribute with the given key is unspecified

Parameters
key:String

a java.lang.String object.

Returns:boolean

true if the key is org.eclipse.jgit.attributes.Attribute.State#UNSPECIFIED, false in all other cases

putback to summary
public void put(Attribute a)

Put an attribute

Parameters
a:Attribute

an org.eclipse.jgit.attributes.Attribute

removeback to summary
public void remove(String key)

Remove attribute with given key

Parameters
key:String

an attribute name

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