Package: MediaFolder

MediaFolder

name	instruction	branch	complexity	line	method
finderOf(Finder)	M: 6 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%
finderOf(Function)	M: 0 C: 6 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: * blueMarine II: Semantic Media Centre
5: * http://tidalwave.it/projects/bluemarine2
6: *
7: * Copyright (C) 2015 - 2021 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/bluemarine2-src
23: * git clone https://github.com/tidalwave-it/bluemarine2-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.bluemarine2.model;
28:
29: import javax.annotation.Nonnull;
30: import java.util.Collection;
31: import java.util.function.Function;
32: import it.tidalwave.util.Finder;
33: import it.tidalwave.role.SimpleComposite;
34: import it.tidalwave.bluemarine2.model.impl.PathAwareEntityFinderDelegate;
35: import it.tidalwave.bluemarine2.model.spi.PathAwareEntity;
36: import it.tidalwave.bluemarine2.model.spi.PathAwareFinder;
37:
38: /***********************************************************************************************************************
39: *
40: * Represents a folder on a filesystem that contains media items. It is associated with the {@link SimpleComposite}
41: * role. The filesystem can be a physical one (on the disk), or a virtual one (e.g. on a database); the folder concept
42: * is flexible and represents any composite collection of items.
43: *
44: * @stereotype Datum
45: *
46: * @author Fabrizio Giudici
47: *
48: **********************************************************************************************************************/
49: public interface MediaFolder extends PathAwareEntity, SimpleComposite<PathAwareEntity>
50: {
51: /*******************************************************************************************************************
52: *
53: * Returns a {@link PathAwareFinder} for retrieving children.
54: *
55: * @return the {@code PathAwareFinder}
56: *
57: ******************************************************************************************************************/
58: @Override @Nonnull
59: public PathAwareFinder findChildren();
60:
61: /*******************************************************************************************************************
62: *
63: * Decorates an existing {@link Finder}{@code <PathAwareEntity>} with a {@link PathAwareFinder}.
64: *
65: * @param delegate the {@code Finder} to decorate
66: * @return the {@code PathAwareFinder}
67: *
68: ******************************************************************************************************************/
69: @Nonnull
70: public default PathAwareFinder finderOf (@Nonnull final Finder<PathAwareEntity> delegate)
71: {
72: return new PathAwareEntityFinderDelegate(this, delegate);
73: }
74:
75: /*******************************************************************************************************************
76: *
77: * Creates a {@link PathAwareFinder} that operates on a collection of {@link PathAwareEntity} items.
78: *
79: * @param function the provider of items
80: * @return the {@code PathAwareFinder}
81: *
82: ******************************************************************************************************************/
83: @Nonnull
84: public default PathAwareFinder finderOf (@Nonnull final Function<MediaFolder, Collection<? extends PathAwareEntity>> function)
85: {
86: return new PathAwareEntityFinderDelegate(this, function);
87: }
88: }