1 /*
2 * Copyright (c) 2022-2023. Roland T. Lichti, Kaiserpfalz EDV-Service.
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18 package de.kaiserpfalzedv.commons.api.resources;
19
20 import org.eclipse.microprofile.openapi.annotations.media.Schema;
21
22 import jakarta.validation.constraints.Pattern;
23 import jakarta.validation.constraints.Size;
24
25 /**
26 * HasDisplayName -- The object has a name to display in UIs.
27 *
28 * The display name can be combined but should not exceed 100 characters.
29 * The method {@link #limitTo100Characters(String)} can be used for implementations to cut of too long display names.
30 *
31 * @author klenkes74 {@literal <rlichti@kaiserpfalz-edv.de>}
32 * @version 2.0.2 2022-01-16
33 * @since 0.1.0 2021-04-18
34 */
35 public interface HasDisplayName extends HasName {
36 /**
37 * Default implementation of getDisplayName().
38 *
39 * @return the result of {@link #getName()}.
40 */
41 @Schema(
42 name = "displayName",
43 description = "The name of a resource to be displayed to human users.",
44 pattern = VALID_NAME_PATTERN,
45 minLength = VALID_NAME_MIN_LENGTH,
46 maxLength = VALID_NAME_MAX_LENGTH
47 )
48 @Size(min = VALID_NAME_MIN_LENGTH, max = VALID_NAME_MAX_LENGTH, message = VALID_NAME_LENGTH_MSG)
49 @Pattern(regexp = VALID_NAME_PATTERN, message = VALID_NAME_PATTERN_MSG)
50 default String getDisplayName() {
51 return limitTo100Characters(getName());
52 }
53
54 /**
55 * Limits the length of the content to 100 by taking at most 97 characters length of the content and then adding 3 dots.
56 *
57 * @param content the content to be cut off.
58 * @return the cut of content.
59 */
60 default String limitTo100Characters(String content) {
61 return content.length() <= 100 ? content : content.substring(0, 96) + "...";
62 }
63 }