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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* Copyright (c) 2007, 2008, 2011, 2012, 2015, 2019 Eike Stepper (Loehne, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.net4j.util.om;
import org.eclipse.net4j.util.om.log.OMLogger;
import org.eclipse.net4j.util.om.pref.OMPreferences;
import org.eclipse.net4j.util.om.trace.OMTracer;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.osgi.service.debug.DebugOptions;
import org.osgi.framework.Bundle;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Iterator;
import java.util.Properties;
import java.util.ResourceBundle;
/**
* Represents a {@link Bundle bundle}, whether OSGi {@link OMPlatform#isOSGiRunning() is running} or not.
*
* @author Eike Stepper
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface OMBundle
{
public OMPlatform getPlatform();
public String getBundleID();
public URL getBaseURL();
/**
* @since 3.2
*/
public Iterator<Class<?>> getClasses();
public OMTracer tracer(String name);
public OMLogger logger();
public OMPreferences preferences();
/**
* @since 3.5
*/
public IStatus getStatus(Object obj);
/**
* @since 3.5
*/
public void coreException(Throwable t) throws CoreException;
public File getConfigFile();
public Properties getConfigProperties();
public String getStateLocation();
public InputStream getInputStream(String path) throws IOException;
public DebugSupport getDebugSupport();
public TranslationSupport getTranslationSupport();
/**
* @deprecated For internal use only.
*/
@Deprecated
public void setBundleContext(Object bundleContext);
/**
* A facility for accessing OSGi {@link DebugOptions debug options}, whether OSGi {@link OMPlatform#isOSGiRunning() is
* running} or not.
*
* @author Eike Stepper
*/
public interface DebugSupport
{
public boolean isDebugging();
public void setDebugging(boolean debugging);
public String getDebugOption(String option);
public void setDebugOption(String option, String value);
public String getDebugOption(String option, String defaultValue);
public boolean getDebugOption(String option, boolean defaultValue);
public void setDebugOption(String option, boolean value);
public int getDebugOption(String option, int defaultValue);
public void setDebugOption(String option, int value);
}
/**
* A facility for accessing {@link ResourceBundle resource bundles}.
*
* @author Eike Stepper
*/
public interface TranslationSupport
{
/**
* Indicates whether strings should be translated by default.
*
* @return <code>true</code> if strings should be translated by default; <code>false</code> otherwise.
*/
public boolean shouldTranslate();
/**
* Sets whether strings should be translated by default.
*
* @param shouldTranslate
* whether strings should be translated by default.
*/
public void setShouldTranslate(boolean shouldTranslate);
/**
* Returns the string resource associated with the key.
*
* @param key
* the key of the string resource.
* @return the string resource associated with the key.
*/
String getString(String key);
/**
* Returns the string resource associated with the key.
*
* @param key
* the key of the string resource.
* @param translate
* whether the result is to be translated to the current locale.
* @return the string resource associated with the key.
*/
String getString(String key, boolean translate);
/**
* Returns a string resource associated with the key, and performs substitutions.
*
* @param key
* the key of the string.
* @param args
* the message substitutions.
* @return a string resource associated with the key.
* @see #getString(String)
* @see java.text.MessageFormat#format(String, Object...)
*/
String getString(String key, Object... args);
/**
* Returns a string resource associated with the key, and performs substitutions.
*
* @param key
* the key of the string.
* @param translate
* whether the result is to be translated to the current locale.
* @param args
* the message substitutions.
* @return a string resource associated with the key.
* @see #getString(String)
* @see java.text.MessageFormat#format(String, Object[])
*/
String getString(String key, boolean translate, Object... args);
}
}
|
