summaryrefslogtreecommitdiff
path: root/scripting/java/com/sun/star/script/framework/provider/java/ScriptDescriptor.java
blob: ff56564b20dff21b19f14f7f567099e4c87d5f23 (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
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
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */
package com.sun.star.script.framework.provider.java;

import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;

/**
 * The <code>ScriptDescriptor</code> object is used to store the search
 * criteria that should be used for finding a particular script
 */
public class ScriptDescriptor {

    private final String m_name;
    private final String m_methodName;
    private final String m_className;
    private List<String> m_classpath;
    private final ArrayList<Class<?>> m_argumentTypes = new ArrayList<Class<?>>(11);

    /**
     * Constructs a ScriptDescriptor for the given name
     *
     * @param  name                          Script Name
     * @exception  IllegalArgumentException  if the given name does not contain a "."
     */
    public ScriptDescriptor(String name) throws IllegalArgumentException {
        int idx = name.lastIndexOf('.');

        if (idx == -1) {
            throw new IllegalArgumentException("Invalid method name");
        }

        this.m_name = name;
        this.m_methodName = name.substring(idx + 1);
        this.m_className = name.substring(0, idx);
    }

    /**
     * Gets the fully qualified name of this <code>ScriptDescriptor</code>
     *
     * @return    The Script Name value
     */
    public String getName() {
        return m_name;
    }

    /**
     * Gets the fully qualified name of this <code>ScriptDescriptor</code>
     *
     * @return    The Script Name value
     */
    public String getClassName() {
        return m_className;
    }

    /**
     * Gets the method name of this <code>ScriptDescriptor</code>
     *
     * @return    The methodName value
     */
    public String getMethodName() {
        return m_methodName;
    }

    /**
     * Sets the classpath value stored by this <code>ScriptDescriptor</code>
     *
     * @param  classpath  The new classpath value
     */
    public void setClasspath(String classpath) {
        StringTokenizer stk = new StringTokenizer(classpath, ":");

        while (stk.hasMoreTokens()) {
            this.m_classpath.add(stk.nextToken());
        }
    }

    /**
     * Sets the classpath value stored by this <code>ScriptDescriptor</code>
     *
     * @param  classpath  The new classpath value
     */
    public void setClasspath(List<String> classpath) {
        this.m_classpath = classpath;
    }

    /**
     * Gets the classpath value stored by this <code>ScriptDescriptor</code>
     *
     * @return    The classpath value
     */
    public List<String> getClasspath() {
        return m_classpath;
    }

    /**
     * Adds the given <code>Class</code> to the list of argument types stored in
     * this ScriptDescriptor
     *
     * @param  clazz  The feature to be added to the ArgumentType attribute
     */

    public synchronized void addArgumentType(Class<?> clazz) {
        m_argumentTypes.add(clazz);
    }

    /**
     * Gets a list of the types of the arguments stored in this
     * <code>ScriptDescriptor</code>
     *
     * return the argument types as an array of Class
     *
     * @return    The argumentTypes value
     */

    public synchronized Class<?>[] getArgumentTypes() {
        if (m_argumentTypes.size() > 0)
            return m_argumentTypes.toArray(new Class[ m_argumentTypes.size() ]);
        else
            return null;
    }

    /**
     * Returns a <code>String</code> representation of this
     * <code>ScriptDescriptor</code>
     *
     * @return    The scriptName including the parameters.
     */
    @Override
    public String toString() {
        StringBuilder description = new StringBuilder(m_name);
        Class<?>[] types = getArgumentTypes();

        description.append(" (");

        if (types != null) {
            for (int i = 0; i < types.length - 1; i++) {
                description.append(types[ i ].getName());
                description.append(", ");
            }

            description.append(types[ types.length - 1 ].getName());
        }

        description.append(")");

        return description.toString();
    }
}