File: ReflectionUtils.java

package info (click to toggle)
libsis-jhdf5-java 19.04.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 8,668 kB
  • sloc: java: 79,644; ansic: 18,986; sh: 309; makefile: 49; xml: 12
file content (139 lines) | stat: -rw-r--r-- 4,895 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
/*
 * Copyright 2007 - 2018 ETH Zuerich, CISD and SIS.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ch.systemsx.cisd.hdf5;

import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.util.HashMap;
import java.util.Map;

/**
 * Utility methods for reflection, used for inferring the mapping between a compound data type and
 * the fields of a Java class.
 * <p>
 * <i>This is an internal API that should not be expected to be stable between releases!</i>
 * 
 * @author Bernd Rinn
 */
public final class ReflectionUtils
{

    private ReflectionUtils()
    {
        // Cannot be instantiated
    }

    /**
     * Returns a map from field names to fields for all fields in the given <var>clazz</var>.
     */
    public static Map<String, Field> getFieldMap(final Class<?> clazz)
    {
        return getFieldMap(clazz, true);
    }

    /**
     * Returns a map from field names to fields for all fields in the given <var>clazz</var>.
     * 
     * @param clazz The clazz to get the fields from.
     * @param excludeNonMappedFields If <code>true</code>, do not include fields to the map which
     *            are not supposed to be mapped to HDF5 members.
     */
    public static Map<String, Field> getFieldMap(final Class<?> clazz,
            boolean excludeNonMappedFields)
    {
        final Map<String, Field> map = new HashMap<String, Field>();
        final CompoundType ct = clazz.getAnnotation(CompoundType.class);
        final boolean includeAllFields =
                excludeNonMappedFields ? ((ct != null) ? ct.mapAllFields() : true) : true;
        for (Class<?> c = clazz; c != null; c = c.getSuperclass())
        {
            for (Field f : c.getDeclaredFields())
            {
                final CompoundElement e = f.getAnnotation(CompoundElement.class);
                if (e != null && org.apache.commons.lang3.StringUtils.isNotEmpty(e.memberName()))
                {
                    map.put(e.memberName(), f);
                } else if (e != null || includeAllFields)
                {
                    map.put(f.getName(), f);
                }
            }
        }
        return map;
    }

    /**
     * Ensures that the given <var>member</var> is accessible even if by definition it is not.
     */
    public static void ensureAccessible(final AccessibleObject memberOrNull)
    {
        if (memberOrNull != null && memberOrNull.isAccessible() == false)
        {
            memberOrNull.setAccessible(true);
        }
    }

    /**
     * Creates an object of <var>clazz</var> using the default constructor, making the default
     * constructor accessible if necessary.
     */
    public static <T> Constructor<T> getDefaultConstructor(final Class<T> clazz)
            throws SecurityException, NoSuchMethodException, IllegalArgumentException,
            InstantiationException, IllegalAccessException, InvocationTargetException
    {
        final Constructor<T> defaultConstructor = clazz.getDeclaredConstructor();
        ensureAccessible(defaultConstructor);
        return defaultConstructor;

    }

    /**
     * Creates an object of <var>clazz</var> using the default constructor, making the default
     * constructor accessible if necessary.
     */
    public static <T> T newInstance(final Class<T> clazz) throws SecurityException,
            NoSuchMethodException, IllegalArgumentException, InstantiationException,
            IllegalAccessException, InvocationTargetException
    {
        final Constructor<T> defaultConstructor = clazz.getDeclaredConstructor();
        ensureAccessible(defaultConstructor);
        return defaultConstructor.newInstance();

    }

    /**
     * Returns the enum options of the given <var>enumClass</var>. If <var>enumClass</var> is not an
     * enum class, return an empty array.
     */
    public static String[] getEnumOptions(Class<? extends Enum<?>> enumClass)
    {
        final Enum<?>[] constants = enumClass.getEnumConstants();
        if (constants == null)
        {
            return new String[0];
        }
        final String[] options = new String[constants.length];
        for (int i = 0; i < options.length; ++i)
        {
            options[i] = constants[i].name();
        }
        return options;
    }

}