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
|
/*
* Copyright (c) OSGi Alliance (2011, 2012). 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.
*/
package org.osgi.framework.resource;
import java.util.Map;
/**
* A capability that has been declared from a {@link Resource}.
*
* <p>
* Instances of this type must be <i>effectively immutable</i>. That is, for a
* given instance of this interface, the methods defined by this interface must
* always return the same result.
*
* @ThreadSafe
* @version $Id$
*/
public interface Capability {
/**
* Returns the name space of this capability.
*
* @return The name space of this capability.
*/
String getNamespace();
/**
* Returns the directives of this capability.
*
* <p>
* Only the following list of directives have specified semantics:
* <ul>
* <li> {@link ResourceConstants#CAPABILITY_EFFECTIVE_DIRECTIVE effective}
* <li> {@link ResourceConstants#CAPABILITY_USES_DIRECTIVE uses}
* <li> {@link ResourceConstants#CAPABILITY_MANDATORY_DIRECTIVE mandatory} -
* only recognized for the {@link ResourceConstants#WIRING_BUNDLE_NAMESPACE
* osgi.wiring.bundle} and
* {@link ResourceConstants#WIRING_PACKAGE_NAMESPACE osgi.wiring.package}
* name spaces.
* <li> {@link ResourceConstants#CAPABILITY_EXCLUDE_DIRECTIVE exclude} - only
* recognized for the {@link ResourceConstants#WIRING_PACKAGE_NAMESPACE
* osgi.wiring.package} name space.
* <li> {@link ResourceConstants#CAPABILITY_INCLUDE_DIRECTIVE include} - only
* recognized for the {@link ResourceConstants#WIRING_PACKAGE_NAMESPACE
* osgi.wiring.package} name space.
* </ul>
* All other directives have no specified semantics and are considered extra
* user defined information. The OSGi Alliance reserves the right to extend
* the set of directives which have specified semantics.
*
* @return An unmodifiable map of directive names to directive values for
* this capability, or an empty map if this capability has no
* directives.
*/
Map<String, String> getDirectives();
/**
* Returns the attributes of this capability.
*
* @return An unmodifiable map of attribute names to attribute values for
* this capability, or an empty map if this capability has no
* attributes.
*/
Map<String, Object> getAttributes();
/**
* Returns the resource declaring this capability.
*
* @return The resource declaring this capability.
*/
Resource getResource();
/**
* Compares this {@code Capability} to another {@code Capability}.
*
* <p>
* This {@code Capability} is equal to another {@code Capability} if they
* have the same name space, directives and attributes and are declared by
* the same resource.
*
* @param obj The object to compare against this {@code Capability}.
* @return {@code true} if this {@code Capability} is equal to the other
* object; {@code false} otherwise.
*/
boolean equals(Object obj);
/**
* Returns the hashCode of this {@code Capability}.
*
* @return The hashCode of this {@code Capability}.
*/
int hashCode();
}
|
