blob: 6f13a1b536b116eebb255285b958d889db733939 (
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
|
/*
* Copyright (c) OSGi Alliance (2011, 2015). 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.resource;
import java.util.List;
import org.osgi.annotation.versioning.ConsumerType;
/**
* A resource is the representation of a uniquely identified and typed data. A
* resource declares requirements that need to be satisfied by capabilities
* before it can provide its capabilities.
*
* <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
* @author $Id$
*/
@ConsumerType
public interface Resource {
/**
* Returns the capabilities declared by this resource.
*
* @param namespace The namespace of the declared capabilities to return or
* {@code null} to return the declared capabilities from all
* namespaces.
* @return An unmodifiable list containing the declared {@link Capability}s
* from the specified namespace. The returned list will be empty if
* this resource declares no capabilities in the specified
* namespace.
*/
List<Capability> getCapabilities(String namespace);
/**
* Returns the requirements declared by this bundle resource.
*
* @param namespace The namespace of the declared requirements to return or
* {@code null} to return the declared requirements from all
* namespaces.
* @return An unmodifiable list containing the declared {@link Requirement}
* s from the specified namespace. The returned list will be empty
* if this resource declares no requirements in the specified
* namespace.
*/
List<Requirement> getRequirements(String namespace);
/**
* Compares this {@code Resource} to another {@code Resource}.
*
* <p>
* This {@code Resource} is equal to another {@code Resource} if both have
* the same content and come from the same location. Location may be defined
* as the bundle location if the resource is an installed bundle or the
* repository location if the resource is in a repository.
*
* @param obj The object to compare against this {@code Resource}.
* @return {@code true} if this {@code Resource} is equal to the other
* object; {@code false} otherwise.
*/
@Override
boolean equals(Object obj);
/**
* Returns the hashCode of this {@code Resource}.
*
* @return The hashCode of this {@code Resource}.
*/
@Override
int hashCode();
}
|
