1 /*
2 * Copyright (C) 2016, Matthias Sohn <matthias.sohn@sap.com>
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 import java.io.InputStream;
47 import java.io.OutputStream;
48 import java.util.Set;
49 import java.util.concurrent.ConcurrentHashMap;
50
51 import org.eclipse.jgit.lib.Repository;
52
53 /**
54 * Registry for built-in filters
55 *
56 * @since 4.6
57 */
58 public class FilterCommandRegistry {
59 private static ConcurrentHashMap<String, FilterCommandFactory> filterCommandRegistry = new ConcurrentHashMap<>();
60
61 /**
62 * Register a {@link org.eclipse.jgit.attributes.FilterCommandFactory}
63 * responsible for creating
64 * {@link org.eclipse.jgit.attributes.FilterCommand}s for a certain command
65 * name. If the factory f1 is registered for the name "jgit://builtin/x"
66 * then a call to <code>getCommand("jgit://builtin/x", ...)</code> will call
67 * <code>f1(...)</code> to create a new instance of
68 * {@link org.eclipse.jgit.attributes.FilterCommand}
69 *
70 * @param filterCommandName
71 * the command name for which this factory is registered
72 * @param factory
73 * the factory responsible for creating
74 * {@link org.eclipse.jgit.attributes.FilterCommand}s for the
75 * specified name
76 * @return the previous factory associated with <tt>commandName</tt>, or
77 * <tt>null</tt> if there was no mapping for <tt>commandName</tt>
78 */
79 public static FilterCommandFactory register(String filterCommandName,
80 FilterCommandFactory factory) {
81 return filterCommandRegistry.put(filterCommandName, factory);
82 }
83
84 /**
85 * Unregister the {@link org.eclipse.jgit.attributes.FilterCommandFactory}
86 * registered for the given command name
87 *
88 * @param filterCommandName
89 * the FilterCommandFactory's filter command name
90 * @return the previous factory associated with <tt>filterCommandName</tt>,
91 * or <tt>null</tt> if there was no mapping for <tt>commandName</tt>
92 */
93 public static FilterCommandFactory unregister(String filterCommandName) {
94 return filterCommandRegistry.remove(filterCommandName);
95 }
96
97 /**
98 * Check whether any
99 * {@link org.eclipse.jgit.attributes.FilterCommandFactory} is registered
100 * for a given command name
101 *
102 * @param filterCommandName
103 * the name for which the registry should be checked
104 * @return <code>true</code> if any factory was registered for the name
105 */
106 public static boolean isRegistered(String filterCommandName) {
107 return filterCommandRegistry.containsKey(filterCommandName);
108 }
109
110 /**
111 * Get registered filter commands
112 *
113 * @return Set of commandNames for which a
114 * {@link org.eclipse.jgit.attributes.FilterCommandFactory} is
115 * registered
116 */
117 public static Set<String> getRegisteredFilterCommands() {
118 return filterCommandRegistry.keySet();
119 }
120
121 /**
122 * Create a new {@link org.eclipse.jgit.attributes.FilterCommand} for the
123 * given name. A factory must be registered for the name in advance.
124 *
125 * @param filterCommandName
126 * The name for which a new
127 * {@link org.eclipse.jgit.attributes.FilterCommand} should be
128 * created
129 * @param db
130 * the repository this command should work on
131 * @param in
132 * the {@link java.io.InputStream} this
133 * {@link org.eclipse.jgit.attributes.FilterCommand} should read
134 * from
135 * @param out
136 * the {@link java.io.OutputStream} this
137 * {@link org.eclipse.jgit.attributes.FilterCommand} should write
138 * to
139 * @return the command if a command could be created or <code>null</code> if
140 * there was no factory registered for that name
141 * @throws java.io.IOException
142 */
143 public static FilterCommand createFilterCommand(String filterCommandName,
144 Repository db, InputStream in, OutputStream out)
145 throws IOException {
146 FilterCommandFactory cf = filterCommandRegistry.get(filterCommandName);
147 return (cf == null) ? null : cf.create(db, in, out);
148 }
149
150 }