Package: DciRole

DciRole

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.dci.annotation;
27:
28: import java.lang.annotation.Documented;
29: import java.lang.annotation.ElementType;
30: import java.lang.annotation.Retention;
31: import java.lang.annotation.RetentionPolicy;
32: import java.lang.annotation.Target;
33: import javax.annotation.Nonnull;
34: import lombok.AccessLevel;
35: import lombok.NoArgsConstructor;
36:
37: /***************************************************************************************************************************************************************
38: *
39: * Designates a DCI role implementation for a given owner object.
40: *
41: * @author Fabrizio Giudici
42: *
43: **************************************************************************************************************************************************************/
44: @Target(ElementType.TYPE)
45: @Documented
46: @Retention(RetentionPolicy.RUNTIME)
47: public @interface DciRole
48: {
49: @NoArgsConstructor(access = AccessLevel.PRIVATE)
50: public static final class NoContext
51: {
52: }
53:
54: /***********************************************************************************************************************************************************
55: * The datum type to which this role can be associated. Multiple data types can be specified.
56: *
57: * @return the datum type
58: **********************************************************************************************************************************************************/
59: @Nonnull
60: public Class<?>[] datumType();
61:
62: /***********************************************************************************************************************************************************
63: * The context type to which this role is restricted. If no context is specified, this role will always be
64: * associated.
65: *
66: * @return the context type
67: **********************************************************************************************************************************************************/
68: public Class<?> context() default NoContext.class;
69: }