Package: IdFactory

IdFactory

name	instruction	branch	complexity	line	method
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:
32: /***********************************************************************************************************************
33: *
34: * A factory for creating a new, unique {@code Id} for an object.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: * @it.tidalwave.javadoc.stable
40: *
41: **********************************************************************************************************************/
42: public interface IdFactory
43: {
44: public static final Class<IdFactory> _IdFactory_ = IdFactory.class;
45:
46: /*******************************************************************************************************************
47: *
48: * Creates a new id.
49: *
50: * @return the new id
51: *
52: ******************************************************************************************************************/
53: @Nonnull
54: public Id createId();
55:
56: /*******************************************************************************************************************
57: *
58: * Creates a new id for an object of the given class.
59: *
60: * @param objectClass the class of the object for which the {@code Id} is created
61: * @return the new id
62: *
63: ******************************************************************************************************************/
64: @Nonnull
65: public Id createId (@Nonnull Class<?> objectClass);
66:
67: /*******************************************************************************************************************
68: *
69: * Creates a new id for the given object of the given class. This method allows to explicitly pass a {@code Class}
70: * for cases in which the {@code object} implements multiple interfaces and one wants to specify the referenced one.
71: *
72: * @param object the object for which the {@code Id}
73: * @param objectClass the class of the object for which the {@code Id} is created
74: * @return the new id
75: *
76: ******************************************************************************************************************/
77: @Nonnull
78: public Id createId (@Nonnull Class<?> objectClass, @Nonnull Object object);
79: }