Package: MediaMetadataProvider

MediaMetadataProvider

name	instruction	branch	complexity	line	method
lambda$static$0(Id, String, ResourceProperties)	M: 2 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
static {...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

1: /*
2: * #%L
3: * *********************************************************************************************************************
4: *
5: * NorthernWind - lightweight CMS
6: * http://northernwind.tidalwave.it - git clone https://bitbucket.org/tidalwave/northernwind-src.git
7: * %%
8: * Copyright (C) 2011 - 2023 Tidalwave s.a.s. (http://tidalwave.it)
9: * %%
10: * *********************************************************************************************************************
11: *
12: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
13: * the License. You may obtain a copy of the License at
14: *
15: * http://www.apache.org/licenses/LICENSE-2.0
16: *
17: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
18: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
19: * specific language governing permissions and limitations under the License.
20: *
21: * *********************************************************************************************************************
22: *
23: *
24: * *********************************************************************************************************************
25: * #L%
26: */
27: package it.tidalwave.northernwind.frontend.ui.component.gallery.spi;
28:
29: import javax.annotation.Nonnull;
30: import it.tidalwave.util.Id;
31: import it.tidalwave.northernwind.core.model.ResourceProperties;
32:
33: /***********************************************************************************************************************
34: *
35: * Implementations of this interface provide metadata for media rendering.
36: *
37: * @author Fabrizio Giudici
38: *
39: **********************************************************************************************************************/
40: @FunctionalInterface
41: public interface MediaMetadataProvider
42: {
43: /*******************************************************************************************************************
44: *
45: * A default implementation that always returns an empty string.
46: *
47: ******************************************************************************************************************/
48: public static final MediaMetadataProvider VOID = (id, format, properties) -> format;
49:
50: /*******************************************************************************************************************
51: *
52: * Retrieves metadata items and formats them.
53: *
54: * @param mediaId the id of the media item to retrieve metadata from
55: * @param format the format string for metadata
56: * @param properties some configuration properties
57: * @return the formatted metadata
58: *
59: ******************************************************************************************************************/
60: @Nonnull
61: public String getMetadataString (@Nonnull Id mediaId,
62: @Nonnull String format,
63: @Nonnull ResourceProperties properties);
64: }