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.ui;
27
28 import javax.annotation.Nonnull;
29 import java.util.Collection;
30 import java.util.Collections;
31 import it.tidalwave.util.RoleFactory;
32
33 /***************************************************************************************************************************************************************
34 *
35 * A factory that creates a default {@link PresentationModel}.
36 *
37 * @author Fabrizio Giudici
38 *
39 **************************************************************************************************************************************************************/
40 @FunctionalInterface
41 public interface PresentationModelFactory
42 {
43 public static final Class<PresentationModelFactory> _PresentationModelFactory_ = PresentationModelFactory.class;
44
45 /***********************************************************************************************************************************************************
46 * Creates a new instance of {@link PresentationModel} with some roles or role factories.
47 *
48 * @param datum the related datum
49 * @param roles roles or {@link RoleFactory} instances to put in the presentation model
50 * @return the new instance
51 * @since 3.2-ALPHA-3 (refactored)
52 **********************************************************************************************************************************************************/
53 @Nonnull
54 public PresentationModel createPresentationModel (@Nonnull Object datum, @Nonnull Collection<Object> roles);
55
56 /***********************************************************************************************************************************************************
57 * Creates a new instance of {@link PresentationModel}.
58 *
59 * @param datum the related datum
60 * @return the new instance
61 * @since 3.2-ALPHA-3
62 **********************************************************************************************************************************************************/
63 @Nonnull
64 public default PresentationModel createPresentationModel (@Nonnull final Object datum)
65 {
66 return createPresentationModel(datum, Collections.emptyList());
67 }
68 }