Method: createPresentationModel(Object)

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * SteelBlue: DCI User Interfaces
5: * http://tidalwave.it/projects/steelblue
6: *
7: * Copyright (C) 2015 - 2025 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/steelblue-src
22: * git clone https://github.com/tidalwave-it/steelblue-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.ui.core.role;
27:
28: import jakarta.annotation.Nonnull;
29: import java.util.Collection;
30: import java.util.Collections;
31: import it.tidalwave.util.Parameters;
32: import it.tidalwave.ui.core.role.impl.DefaultPresentable;
33: import static it.tidalwave.util.Parameters.r;
34:
35: /***************************************************************************************************************************************************************
36: *
37: * The role of an object that can be presented on a UI, thus is capable of creating a {@link PresentationModel}.
38: *
39: * @stereotype Role
40: *
41: * @since 2.0-ALPHA-1
42: * @author Fabrizio Giudici
43: *
44: **************************************************************************************************************************************************************/
45: @FunctionalInterface
46: public interface Presentable
47: {
48: public static final Class<Presentable> _Presentable_ = Presentable.class;
49:
50: /***********************************************************************************************************************************************************
51: * Creates a {@link PresentationModel}.
52: *
53: * @return the {@code PresentationModel}
54: * @since 3.2-ALPHA-3 (refactored)
55: **********************************************************************************************************************************************************/
56: public default PresentationModel createPresentationModel()
57: {
58: return createPresentationModel(Collections.emptyList());
59: }
60:
61: /***********************************************************************************************************************************************************
62: * Creates a {@link PresentationModel} with some roles.
63: *
64: * @param instanceRoles the roles
65: * @return the {@code PresentationModel}
66: * @since 3.2-ALPHA-3 (refactored)
67: **********************************************************************************************************************************************************/
68: @Nonnull
69: public PresentationModel createPresentationModel (@Nonnull Collection<Object> instanceRoles);
70:
71: /***********************************************************************************************************************************************************
72: * Creates a {@link PresentationModel} with a single role.
73: *
74: * @param instanceRole the role
75: * @return the {@code PresentationModel}
76: * @since 3.2-ALPHA-3
77: **********************************************************************************************************************************************************/
78: @Nonnull
79: public default PresentationModel createPresentationModel (@Nonnull final Object instanceRole)
80: {
81: Parameters.mustNotBeArrayOrCollection(instanceRole, "instanceRole");
82: return createPresentationModel(r(instanceRole));
83: }
84:
85: /***********************************************************************************************************************************************************
86: * Creates a default {@link Presentable} for the given object.
87: *
88: * @param owner the object
89: * @return the new instance
90: * @since 3.2-ALPHA-2
91: **********************************************************************************************************************************************************/
92: @Nonnull
93: public static Presentable of (@Nonnull final Object owner)
94: {
95: return new DefaultPresentable(owner);
96: }
97: }