blob: e6a64a8ec50aee54ac8992cac57482e05741f683 (
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
|
/*******************************************************************************
* Copyright (c) 2004, 2012 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.osgi.service.resolver;
import java.util.Map;
import org.osgi.framework.Version;
import org.osgi.framework.wiring.BundleCapability;
/**
* This class represents a base description object for a state. All description
* objects in a state have a name and a version.
* <p>
* This interface is not intended to be implemented by clients. The
* {@link StateObjectFactory} should be used to construct instances.
* </p>
* @since 3.1
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface BaseDescription {
/**
* Returns the name.
* @return the name
*/
public String getName();
/**
* Returns the version.
* @return the version
*/
public Version getVersion();
/**
* Returns the bundle which supplies this base description
* @return the bundle which supplies this base description
* @since 3.2
*/
public BundleDescription getSupplier();
/**
* Returns the directives declared with the description.
* This will return all known directives for the type of description.
* The set of directives differs for each description type.
* @return the known directives declared with the description
* @since 3.7
*/
public Map<String, String> getDeclaredDirectives();
/**
* Returns the attributes declared with the description.
* This will return all known attributes for the type of description.
* The set of attributes differs for each description type.
* @return the attributes declared with the description
* @since 3.7
*/
public Map<String, Object> getDeclaredAttributes();
/**
* Returns the capability represented by this description.
* Some descriptions types may not be able to represent
* a capability. In such cases <code>null</code> is
* returned.
* @return the capability represented by this base description
* @since 3.7
*/
public BundleCapability getCapability();
/**
* Returns the user object associated to this description, or
* <code>null</code> if none exists.
*
* @return the user object associated to this description,
* or <code>null</code>
* @since 3.8
*/
public Object getUserObject();
/**
* Associates a user-provided object to this description, or
* removes an existing association, if <code>null</code> is provided. The
* provided object is not interpreted in any ways by this
* description.
*
* @param userObject an arbitrary object provided by the user, or
* <code>null</code>
* @since 3.8
*/
public void setUserObject(Object userObject);
}
|
