1 /*
2 * Copyright (C) 2009, Google Inc.
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
44 package org.eclipse.jgit.revwalk;
45
46 import java.util.Locale;
47
48 import org.eclipse.jgit.lib.Constants;
49
50 /**
51 * Case insensitive key for a {@link org.eclipse.jgit.revwalk.FooterLine}.
52 */
53 public final class FooterKey {
54 /** Standard {@code Signed-off-by} */
55 public static final FooterKeyl#FooterKey">FooterKey SIGNED_OFF_BY = new FooterKey("Signed-off-by"); //$NON-NLS-1$
56
57 /** Standard {@code Acked-by} */
58 public static final FooterKeyy.html#FooterKey">FooterKey ACKED_BY = new FooterKey("Acked-by"); //$NON-NLS-1$
59
60 /** Standard {@code CC} */
61 public static final FooterKeyoterKey.html#FooterKey">FooterKey CC = new FooterKey("CC"); //$NON-NLS-1$
62
63 private final String name;
64
65 final byte[] raw;
66
67 /**
68 * Create a key for a specific footer line.
69 *
70 * @param keyName
71 * name of the footer line.
72 */
73 public FooterKey(String keyName) {
74 name = keyName;
75 raw = Constants.encode(keyName.toLowerCase(Locale.ROOT));
76 }
77
78 /**
79 * Get name of this footer line.
80 *
81 * @return name of this footer line.
82 */
83 public String getName() {
84 return name;
85 }
86
87 /** {@inheritDoc} */
88 @SuppressWarnings("nls")
89 @Override
90 public String toString() {
91 return "FooterKey[" + name + "]";
92 }
93 }