Package: Content$Builder

Content$Builder

name	instruction	branch	complexity	line	method
build()	M: 0 C: 5 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 1 100%	M: 0 C: 1 100%

Coverage

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * NorthernWind - lightweight CMS
5: * http://tidalwave.it/projects/northernwind
6: *
7: * Copyright (C) 2011 - 2025 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/northernwind-src
22: * git clone https://github.com/tidalwave-it/northernwind-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.northernwind.core.model;
27:
28: import javax.annotation.Nonnull;
29: import java.time.ZonedDateTime;
30: import java.util.List;
31: import java.util.Optional;
32: import it.tidalwave.util.Key;
33: import it.tidalwave.role.SimpleComposite;
34: import lombok.AccessLevel;
35: import lombok.AllArgsConstructor;
36: import lombok.Getter;
37: import lombok.RequiredArgsConstructor;
38: import lombok.ToString;
39: import lombok.With;
40:
41: /***************************************************************************************************************************************************************
42: *
43: * A piece of content to be used by something.
44: *
45: * @author Fabrizio Giudici
46: *
47: **************************************************************************************************************************************************************/
48: public interface Content extends Resource, SimpleComposite<Content>
49: {
50: @SuppressWarnings("squid:S1700")
51: public static final Class<Content> _Content_ = Content.class;
52:
53: /** The title of this {@code Content}. */
54: public static final Key<String> P_TITLE = Key.of("title", String.class);
55:
56: /** The unique id of this {@code Content}. */
57: public static final Key<String> P_ID = Key.of("id", String.class);
58:
59: /** The full text contained in this {@code Content}. */
60: public static final Key<String> P_FULL_TEXT = Key.of("fullText", String.class);
61:
62: /** A shortened text contained in this {@code Content}. */
63: public static final Key<String> P_LEADIN_TEXT = Key.of("leadinText", String.class);
64:
65: /** A description this {@code Content}. */
66: public static final Key<String> P_DESCRIPTION = Key.of("description", String.class);
67:
68: /** A contained that works as a template for something. */
69: public static final Key<String> P_TEMPLATE = Key.of("template", String.class);
70:
71: /** The creation date of this {@code Content}. */
72: public static final Key<ZonedDateTime> P_CREATION_DATE = Key.of("creationDateTime", ZonedDateTime.class);
73:
74: /** The latest modification date of this {@code Content}. */
75: public static final Key<ZonedDateTime> P_LATEST_MODIFICATION_DATE = Key.of("latestModificationDateTime", ZonedDateTime.class);
76:
77: /** The publishing date of this {@code Content}. */
78: public static final Key<ZonedDateTime> P_PUBLISHING_DATE = Key.of("publishingDateTime", ZonedDateTime.class);
79:
80: /** A collection of tags associated with this {@code Content}. */
81: public static final Key<List<String>> P_TAGS = new Key<>("tags") {};
82:
83: /***********************************************************************************************************************************************************
84: * A builder of a {@link Content}.
85: **********************************************************************************************************************************************************/
86: @AllArgsConstructor(access = AccessLevel.PRIVATE) @RequiredArgsConstructor
87: @Getter @ToString(exclude = "callBack")
88: public final class Builder
89: {
90: // Workaround for a Lombok limitation with Wither and subclasses
91: @FunctionalInterface
92: public static interface CallBack
93: {
94: @Nonnull
95: public Content build (@Nonnull Builder builder);
96: }
97:
98: @Nonnull
99: private final ModelFactory modelFactory;
100:
101: @Nonnull
102: private final CallBack callBack;
103:
104: @With
105: private ResourceFile folder;
106:
107: @Nonnull
108: public Content build()
109: {
110: return callBack.build(this);
111: }
112: }
113:
114: /***********************************************************************************************************************************************************
115: * Returns the exposed URI mapped to this resource.
116: *
117: * @return the exposed URI
118: **********************************************************************************************************************************************************/
119: @Nonnull
120: public Optional<ResourcePath> getExposedUri();
121: }