1 /*
2 * Copyright (C) 2014, Arthur Daussy <arthur.daussy@obeo.fr>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.attributes;
44
45 import java.io.IOException;
46
47 import org.eclipse.jgit.lib.CoreConfig;
48
49 /**
50 * An interface used to retrieve the global and info
51 * {@link org.eclipse.jgit.attributes.AttributesNode}s.
52 *
53 * @since 4.2
54 */
55 public interface AttributesNodeProvider {
56
57 /**
58 * Retrieve the {@link org.eclipse.jgit.attributes.AttributesNode} that
59 * holds the information located in $GIT_DIR/info/attributes file.
60 *
61 * @return the {@link org.eclipse.jgit.attributes.AttributesNode} that holds
62 * the information located in $GIT_DIR/info/attributes file.
63 * @throws java.io.IOException
64 * if an error is raised while parsing the attributes file
65 */
66 public AttributesNode getInfoAttributesNode() throws IOException;
67
68 /**
69 * Retrieve the {@link org.eclipse.jgit.attributes.AttributesNode} that
70 * holds the information located in the global gitattributes file.
71 *
72 * @return the {@link org.eclipse.jgit.attributes.AttributesNode} that holds
73 * the information located in the global gitattributes file.
74 * @throws java.io.IOException
75 * java.io.IOException if an error is raised while parsing the
76 * attributes file
77 * @see CoreConfig#getAttributesFile()
78 */
79 public AttributesNode getGlobalAttributesNode() throws IOException;
80
81 }