aboutsummaryrefslogtreecommitdiffstats
path: root/subprojects/viatra-runtime/src/main/java/tools/refinery/viatra/runtime/matchers/context/common/JavaTransitiveInstancesKey.java
blob: eb972c2daaf521bb657dd24114596f4b6baf8000 (plain) (blame)
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
/*******************************************************************************
 * Copyright (c) 2010-2015, Bergmann Gabor, Istvan Rath and Daniel Varro
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-v20.html.
 * 
 * SPDX-License-Identifier: EPL-2.0
 *******************************************************************************/
package tools.refinery.viatra.runtime.matchers.context.common;



/**
 * Instance tuples are of form (x), where object x is an instance of the given Java class or its subclasses.
 * <p> Fine print 1: classes with the same name are considered equivalent. 
 * Can be instantiated with class name, even if the class itself is not loaded yet; but if the class is available, passing it in the constructor is beneficial to avoid classloading troubles.  
 * <p> Fine print 2: primitive types (char, etc.) are transparently treated as their wrapper class (Character, etc.). 
 * <p> Non-enumerable type, can only be checked.
 * <p> Stateless type (objects can't change their type)
 * @author Bergmann Gabor
 *
*/
public class JavaTransitiveInstancesKey extends BaseInputKeyWrapper<String> {
    
    /**
     * The actual Class whose (transitive) instances this relation contains. Can be null at compile time, if only the name is available.
     * Can be a primitive.  
     */
    private Class<?> cachedOriginalInstanceClass;
    
    /**
     * Same as {@link #cachedOriginalInstanceClass}, but primitive classes are replaced with their wrapper classes (e.g. int --> java.lang.Integer).
     */
    private Class<?> cachedWrapperInstanceClass;

    /**
     * Preferred constructor.
     */
    public JavaTransitiveInstancesKey(Class<?> instanceClass) {
        this(primitiveTypeToWrapperClass(instanceClass).getName());
        this.cachedOriginalInstanceClass = instanceClass;
    }
    
    /**
     * Call this constructor only in contexts where the class itself is not available for loading, e.g. it has not yet been compiled.
     */
    public JavaTransitiveInstancesKey(String className) {
        super(className);
    }
    

    /**
     * Returns null if class cannot be loaded.
     */
    private Class<?> getOriginalInstanceClass() {
        if (cachedOriginalInstanceClass == null) {
            try {
                resolveClassInternal();
            } catch (ClassNotFoundException e) {
                // class not yet available at this point
            }
        }
        return cachedOriginalInstanceClass;
    }


    /**
     * @return non-null instance class
     * @throws ClassNotFoundException 
     */
    private Class<?> forceGetOriginalInstanceClass() throws ClassNotFoundException {
        if (cachedOriginalInstanceClass == null) {
            resolveClassInternal();
        }
        return cachedOriginalInstanceClass;
    }
    
    /**
     * @return non-null instance class, wrapped if primitive class
     * @throws ClassNotFoundException 
     */
    public Class<?> forceGetWrapperInstanceClass() throws ClassNotFoundException {
        forceGetOriginalInstanceClass();
        return getWrapperInstanceClass();
    }
    /**
     * @return non-null instance class, wrapped if primitive class
     * @throws ClassNotFoundException 
     */
    public Class<?> forceGetInstanceClass() throws ClassNotFoundException {
        return forceGetWrapperInstanceClass();
    }
    
    /**
     * @return instance class, wrapped if primitive class, null if class cannot be loaded
     */
    public Class<?> getWrapperInstanceClass()  {
        if (cachedWrapperInstanceClass == null) {
            cachedWrapperInstanceClass = primitiveTypeToWrapperClass(getOriginalInstanceClass());
        }
        return cachedWrapperInstanceClass;
    }
    /**
     * @return instance class, wrapped if primitive class, null if class cannot be loaded
     */
    public Class<?> getInstanceClass()  {
        return getWrapperInstanceClass();
    }
    
    private void resolveClassInternal() throws ClassNotFoundException {
        cachedOriginalInstanceClass = Class.forName(wrappedKey);
    }
    
    @Override
    public String getPrettyPrintableName() {
        getWrapperInstanceClass();
        return cachedWrapperInstanceClass == null ? wrappedKey == null ? "<null>" : wrappedKey : cachedWrapperInstanceClass.getName();
    }

    @Override
    public String getStringID() {
        return "javaClass#"+ getPrettyPrintableName();
    }

    @Override
    public int getArity() {
        return 1;
    }
    
    @Override
    public boolean isEnumerable() {
        return false;
    }
    
    @Override
    public String toString() {
        return this.getPrettyPrintableName();
    }

    private static Class<?> primitiveTypeToWrapperClass(Class<?> instanceClass) {
        if (instanceClass != null && instanceClass.isPrimitive()) {
            if (Void.TYPE.equals(instanceClass))
                return Void.class;
            if (Boolean.TYPE.equals(instanceClass))
                return Boolean.class;
            if (Character.TYPE.equals(instanceClass))
                return Character.class;
            if (Byte.TYPE.equals(instanceClass))
                return Byte.class;
            if (Short.TYPE.equals(instanceClass))
                return Short.class;
            if (Integer.TYPE.equals(instanceClass))
                return Integer.class;
            if (Long.TYPE.equals(instanceClass))
                return Long.class;
            if (Float.TYPE.equals(instanceClass))
                return Float.class;
            if (Double.TYPE.equals(instanceClass))
                return Double.class;
        }
        return instanceClass;
    }


}