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 - 2024 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 the License.
12: * 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 an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.role;
27:
28: import javax.annotation.Nonnull;
29: import it.tidalwave.util.Id;
30: import it.tidalwave.role.impl.DefaultIdentifiable;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * The role of an object that can expose a unique identifier.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.stable
40: *
41: **************************************************************************************************************************************************************/
42: @FunctionalInterface
43: public interface Identifiable
44: {
45: public static final Class<Identifiable> _Identifiable_ = Identifiable.class;
46:
47: /***********************************************************************************************************************************************************
48: * {@return the identifier}.
49: **********************************************************************************************************************************************************/
50: @Nonnull
51: public Id getId();
52:
53: /***********************************************************************************************************************************************************
54: * {@return a default instance which returns the given id}.
55: * @param id the id
56: * @since 3.2-ALPHA-6
57: **********************************************************************************************************************************************************/
58: @Nonnull
59: public static Identifiable of (@Nonnull final Id id)
60: {
61: return new DefaultIdentifiable(id);
62: }
63: }