1 /*
2 Copyright 2007 Ramon Servadei
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 */
16 package fulmine;
17
18 /**
19 * An object that can provide 3 attributes/components to uniquely address
20 * itself; an identity string, a type and a domain.
21 *
22 * @author Ramon Servadei
23 */
24 public interface IAddressable
25 {
26 /**
27 * Get the identification string for this entity. This is unique within the
28 * type and domain.
29 *
30 * @return a {@link String} identity providing an identification for this
31 * entity within its type and domain.
32 * @see #getType()
33 * @see #getDomain()
34 */
35 String getIdentity();
36
37 /**
38 * Get the type attribute of this object. The type is orthogonal to the
39 * domain.
40 *
41 * @see #getDomain()
42 * @return the type of this object
43 */
44 IType getType();
45
46 /**
47 * Get the domain attribute of this object. The domain is orthogonal to the
48 * type.
49 *
50 * @see #getType()
51 * @return the domain of this object
52 */
53 IDomain getDomain();
54
55 /**
56 * Get the unique address for this. The address is composed of the identity,
57 * domain and type.
58 *
59 * @return the unique address for this
60 */
61 String getAddress();
62 }