1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * https://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.bcel.classfile;
20
21 import java.io.DataOutputStream;
22 import java.io.IOException;
23
24 /**
25 * An annotation's element value pair.
26 *
27 * @since 6.0
28 */
29 public class ElementValuePair {
30
31 static final ElementValuePair[] EMPTY_ARRAY = {};
32
33 private final ElementValue elementValue;
34
35 private final ConstantPool constantPool;
36
37 private final int elementNameIndex;
38
39 /**
40 * Constructs an ElementValuePair.
41 *
42 * @param elementNameIndex the element name index.
43 * @param elementValue the element value.
44 * @param constantPool the constant pool.
45 */
46 public ElementValuePair(final int elementNameIndex, final ElementValue elementValue, final ConstantPool constantPool) {
47 this.elementValue = elementValue;
48 this.elementNameIndex = elementNameIndex;
49 this.constantPool = constantPool;
50 }
51
52 /**
53 * Dumps this element value pair to a DataOutputStream.
54 *
55 * @param dos the output stream.
56 * @throws IOException if an I/O error occurs.
57 */
58 protected void dump(final DataOutputStream dos) throws IOException {
59 dos.writeShort(elementNameIndex); // u2 name of the element
60 elementValue.dump(dos);
61 }
62
63 /**
64 * Gets the name index.
65 *
66 * @return the name index.
67 */
68 public int getNameIndex() {
69 return elementNameIndex;
70 }
71
72 /**
73 * Gets the name string.
74 *
75 * @return the name string.
76 */
77 public String getNameString() {
78 return constantPool.getConstantUtf8(elementNameIndex).getBytes();
79 }
80
81 /**
82 * Gets the value.
83 *
84 * @return the element value.
85 */
86 public final ElementValue getValue() {
87 return elementValue;
88 }
89
90 /**
91 * Gets a short string representation.
92 *
93 * @return a short string representation.
94 */
95 public String toShortString() {
96 final StringBuilder result = new StringBuilder();
97 result.append(getNameString()).append("=").append(getValue().toShortString());
98 return result.toString();
99 }
100 }