aboutsummaryrefslogtreecommitdiffstats
path: root/core/core-infrastructure/src/main/java/org/onap/policy/apex/core/infrastructure/java/compile/singleclass/SingleClassByteCodeFileObject.java
blob: 4a0536ee1f80a4fabba9816994af9e7266272272 (plain)
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
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 * ================================================================================
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.apex.core.infrastructure.java.compile.singleclass;

import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import javax.tools.SimpleJavaFileObject;

/**
 * The Class SingleClassByteCodeFileObject is a specialization of the {@link SimpleJavaFileObject} class, which is
 * itself an implementation of the {@code JavaFileObject} interface, which provides a file abstraction for tools
 * operating on Java programming language source and class files. The {@link SimpleJavaFileObject} class provides simple
 * implementations for most methods in {@code JavaFileObject}. This class is designed to be sub classed and used as a
 * basis for {@code JavaFileObject} implementations. Subclasses can override the implementation and specification of any
 * method of this class as long as the general contract of {@code JavaFileObject} is obeyed.
 *
 * <p>This class holds the byte code for a single class in memory.
 *
 * @author Liam Fallon (liam.fallon@ericsson.com)
 */
public class SingleClassByteCodeFileObject extends SimpleJavaFileObject {

    // The ByteArrayOutputStream holds the byte code for the class
    private ByteArrayOutputStream byteArrayOutputStream;

    /**
     * Instantiates the byte code for the class in memory.
     *
     * @param className the class name is used to compose a URI for the class
     */
    public SingleClassByteCodeFileObject(final String className) {
        super(URI.create("byte:///" + className + ".class"), Kind.CLASS);
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public OutputStream openOutputStream() {
        // Create the byte array output stream that will hold the byte code for the class, when the class source code is
        // compiled, this output stream is passed
        // to the compiler and the byte code for the class is written into the output stream.
        byteArrayOutputStream = new ByteArrayOutputStream();
        return byteArrayOutputStream;
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public InputStream openInputStream() {
        // No input stream for streaming out the byte code
        return null;
    }

    /**
     * Gets the byte code of the class.
     *
     * @return the byte code of the class
     */
    public byte[] getByteCode() {
        return byteArrayOutputStream.toByteArray();
    }
}