Package org.eclipse.jgit.attributes

Class AttributesHandler

java.lang.Object

org.eclipse.jgit.attributes.AttributesHandler

public class AttributesHandler
extends Object

The attributes handler knows how to retrieve, parse and merge attributes from the various gitattributes files. Furthermore it collects and expands macro expressions. The method getAttributes() yields the ready processed attributes for the current path represented by the TreeWalk

The implementation is based on the specifications in http://git-scm.com/docs/gitattributes

Since:

4.3

Constructor Summary

Constructors

Constructor	Description
AttributesHandler(TreeWalk treeWalk)	Deprecated. since 6.1, use AttributesHandler(TreeWalk, Supplier) instead
AttributesHandler(TreeWalk treeWalk, Supplier<CanonicalTreeParser> attributesTree)	Create an AttributesHandler with default rules as well as merged rules from global, info and worktree root attributes

Method Summary

Modifier and Type	Method	Description
protected void	expandMacro(Attribute attr, Attributes result)	Expand a macro
Attributes	getAttributes()	See TreeWalk.getAttributes()
protected void	mergeAttributes(AttributesNode node, String entryPath, boolean isDirectory, Attributes result)	Merges the matching node attributes for an entry path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributesHandler

@Deprecated
public AttributesHandler(TreeWalk treeWalk)
                  throws IOException

Deprecated.

since 6.1, use AttributesHandler(TreeWalk, Supplier) instead

Create an AttributesHandler with default rules as well as merged rules from global, info and worktree root attributes

Parameters:

treeWalk - a TreeWalk

Throws:

IOException

AttributesHandler

public AttributesHandler(TreeWalk treeWalk,
                         Supplier<CanonicalTreeParser> attributesTree)
                  throws IOException

Create an AttributesHandler with default rules as well as merged rules from global, info and worktree root attributes

Parameters:

treeWalk - a TreeWalk

attributesTree - the tree to read .gitattributes from

Throws:

IOException

Since:

6.1

Method Detail

getAttributes

public Attributes getAttributes()
                         throws IOException

See TreeWalk.getAttributes()

Returns:

the Attributes for the current path represented by the TreeWalk

Throws:

IOException

mergeAttributes

protected void mergeAttributes(@Nullable
                               AttributesNode node,
                               String entryPath,
                               boolean isDirectory,
                               Attributes result)

Merges the matching node attributes for an entry path.

Parameters:

node - the node to scan for matches to entryPath

entryPath - the path to test. The path must be relative to this attribute node's own repository path, and in repository path format (uses '/' and not '\').

isDirectory - true if the target item is a directory.

result - that will hold the attributes matching this entry path. This method will NOT override any existing entry in attributes.

expandMacro

protected void expandMacro(Attribute attr,
                           Attributes result)

Expand a macro

Parameters:

attr - a Attribute

result - contains the (recursive) expanded and merged macro attributes including the attribute iself