Package org.eclipse.jgit.attributes
Class AttributesHandler
java.lang.Object
org.eclipse.jgit.attributes.AttributesHandler
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
-
Field Summary
FieldsModifier and TypeFieldDescriptionThis is the default binary rule that is present in any git folder[attr]binary -diff -merge -text
private static final String
private final AttributesNode
private final AttributesNode
private static final String
private final TreeWalk
-
Constructor Summary
ConstructorsConstructorDescriptionAttributesHandler
(TreeWalk treeWalk) Create anAttributesHandler
with default rules as well as merged rules from global, info and worktree root attributes -
Method Summary
Modifier and TypeMethodDescriptionprivate static AttributesNode
attributesNode
(TreeWalk treeWalk, WorkingTreeIterator workingTreeIterator, DirCacheIterator dirCacheIterator, CanonicalTreeParser otherTree) Get theAttributesNode
for the current entry.protected void
expandMacro
(Attribute attr, Attributes result) Expand a macroprotected void
mergeAttributes
(AttributesNode node, String entryPath, boolean isDirectory, Attributes result) Merges the matching node attributes for an entry path.private void
mergeGlobalAttributes
(String entryPath, boolean isDirectory, Attributes result) Merges the matching GLOBAL attributes for an entry path.private void
mergeInfoAttributes
(String entryPath, boolean isDirectory, Attributes result) Merges the matching INFO attributes for an entry path.private void
mergePerDirectoryEntryAttributes
(String entryPath, int nameRoot, boolean isDirectory, WorkingTreeIterator workingTreeIterator, DirCacheIterator dirCacheIterator, CanonicalTreeParser otherTree, Attributes result) Merges the matching working directory attributes for an entry path.private static <T extends AbstractTreeIterator>
TparentOf
(T node) private static <T extends AbstractTreeIterator>
TrootOf
(T node)
-
Field Details
-
MACRO_PREFIX
- See Also:
-
BINARY_RULE_KEY
- See Also:
-
BINARY_RULE_ATTRIBUTES
This is the default binary rule that is present in any git folder[attr]binary -diff -merge -text
-
treeWalk
-
globalNode
-
infoNode
-
expansions
-
-
Constructor Details
-
AttributesHandler
Create anAttributesHandler
with default rules as well as merged rules from global, info and worktree root attributes- Parameters:
treeWalk
- aTreeWalk
- Throws:
IOException
-
-
Method Details
-
getAttributes
- Returns:
- the
Attributes
for the current path represented by theTreeWalk
- Throws:
IOException
-
mergeGlobalAttributes
Merges the matching GLOBAL attributes for an entry path.- Parameters:
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.
-
mergeInfoAttributes
Merges the matching INFO attributes for an entry path.- Parameters:
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.
-
mergePerDirectoryEntryAttributes
private void mergePerDirectoryEntryAttributes(String entryPath, int nameRoot, boolean isDirectory, @Nullable WorkingTreeIterator workingTreeIterator, @Nullable DirCacheIterator dirCacheIterator, @Nullable CanonicalTreeParser otherTree, Attributes result) throws IOException Merges the matching working directory attributes for an entry path.- Parameters:
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 '\').nameRoot
- index of the '/' preceeding the current level, or -1 if noneisDirectory
- true if the target item is a directory.workingTreeIterator
-dirCacheIterator
-otherTree
-result
- that will hold the attributes matching this entry path. This method will NOT override any existing entry in attributes.- 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 entryPathentryPath
- 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
Expand a macro- Parameters:
attr
- aAttribute
result
- contains the (recursive) expanded and merged macro attributes including the attribute iself
-
attributesNode
private static AttributesNode attributesNode(TreeWalk treeWalk, @Nullable WorkingTreeIterator workingTreeIterator, @Nullable DirCacheIterator dirCacheIterator, @Nullable CanonicalTreeParser otherTree) throws IOException Get theAttributesNode
for the current entry.This method implements the fallback mechanism between the index and the working tree depending on the operation type
- Parameters:
treeWalk
-workingTreeIterator
-dirCacheIterator
-otherTree
-- Returns:
- a
AttributesNode
of the current entry,NullPointerException
otherwise. - Throws:
IOException
- It raises anIOException
if a problem appears while parsing one on the attributes file.
-
parentOf
-
rootOf
-