summaryrefslogtreecommitdiffstats
path: root/include/jvmaccess/classpath.hxx
blob: 9882a42ce25e6e41e0d9a2f1fe53e8d960f004f3 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * 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 .
 */

#ifndef INCLUDED_JVMACCESS_CLASSPATH_HXX
#define INCLUDED_JVMACCESS_CLASSPATH_HXX

#include <sal/config.h>

#include <jni.h>

#include <jvmaccess/jvmaccessdllapi.h>
#include <rtl/ustring.hxx>

namespace com::sun::star::uno {
    class XComponentContext;
}

namespace com::sun::star::uno { template <typename > class Reference; }

namespace jvmaccess {

/**
   Helper functions for class path handling.
 */
namespace ClassPath {

/**
   translates a class path into a java.net.URL[] instance.

   @param context
   a component context; must not be null.

   @param environment
   a JNI environment; must not be null.

   @param classPath
   a list of zero or more internal (see the
   com.sun.star.uri.ExternalUriReferenceTranslator service) URI references,
   where any space characters (U+0020) are ignored (and, in particular, separate
   adjacent URI references).  Any vnd.sun.star.expand URL references in the list
   are expanded using the com.sun.star.util.theMacroExpander singleton of the
   given context.

   @returns
   a local reference to a java.net.URL[] instance containing the external (see
   the com.sun.star.uri.ExternalUriReferenceTranslator service) equivalents of
   all the URI references in the given classPath.  If null, a (still pending)
   JNI exception occurred.

   @throws com::sun::star::uno::RuntimeException
 */
JVMACCESS_DLLPUBLIC jobjectArray translateToUrls(
    css::uno::Reference<css::uno::XComponentContext> const & context,
    JNIEnv * environment, OUString const & classPath);

}

}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */