Package: Identifiable

Identifiable

name	instruction	branch	complexity	line	method
of(Id)	M: 5 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
static {...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2023 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.util.Id;
31: import it.tidalwave.role.impl.DefaultIdentifiable;
32:
33: /***********************************************************************************************************************
34: *
35: * The role of an object that can expose a unique identifier.
36: *
37: * @stereotype Role
38: *
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.stable
41: *
42: **********************************************************************************************************************/
43: @FunctionalInterface
44: public interface Identifiable
45: {
46: public static final Class<Identifiable> _Identifiable_ = Identifiable.class;
47:
48: /*******************************************************************************************************************
49: *
50: * Returns the identifier.
51: *
52: * @return the id
53: *
54: ******************************************************************************************************************/
55: @Nonnull
56: public Id getId();
57:
58: /*******************************************************************************************************************
59: *
60: * Returns a default instance which returns the given idr.
61: *
62: * @param id the id
63: * @return the identifiable
64: * @since 3.2-ALPHA-6
65: *
66: ******************************************************************************************************************/
67: @Nonnull
68: public static Identifiable of (@Nonnull final Id id)
69: {
70: return new DefaultIdentifiable(id);
71: }
72: }