Package: Area

Area

name	instruction	branch	complexity	line	method
emptyRectangularArea()	M: 0 C: 2 100%	M: 0 C: 0 100%	M: 0 C: 1 100%	M: 0 C: 1 100%	M: 0 C: 1 100%
of(Coordinates, Coordinates)	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 III: Semantic DAM
5: * http://tidalwave.it/projects/bluemarine3
6: *
7: * Copyright (C) 2024 - 2025 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/bluemarine3-src
22: * git clone https://github.com/tidalwave-it/bluemarine3-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.geo;
27:
28: import jakarta.annotation.Nonnull;
29: import java.util.Optional;
30: import it.tidalwave.geo.impl.DefaultRectangularArea;
31: import it.tidalwave.util.As;
32:
33: /***************************************************************************************************************************************************************
34: *
35: * A generic geographic area, of any shape.
36: *
37: * @see RectangularArea
38: * @author Fabrizio Giudici
39: *
40: **************************************************************************************************************************************************************/
41: public interface Area extends As
42: {
43: /***********************************************************************************************************************************************************
44: * {@return a new rectangular area given the north west and south east corners}.
45: * @param northWest the north-west corner
46: * @param southEast the south-east corner
47: **********************************************************************************************************************************************************/
48: @Nonnull
49: public static RectangularArea of (@Nonnull final Coordinates northWest, @Nonnull final Coordinates southEast)
50: {
51: return new DefaultRectangularArea(northWest, southEast);
52: }
53:
54: /***********************************************************************************************************************************************************
55: * {@return an empty rectangular area}.
56: **********************************************************************************************************************************************************/
57: @Nonnull
58: public static RectangularArea emptyRectangularArea()
59: {
60: return DefaultRectangularArea.EMPTY;
61: }
62:
63: /***********************************************************************************************************************************************************
64: * {@return whether the area is empty}.
65: **********************************************************************************************************************************************************/
66: public boolean isEmpty();
67:
68: /***********************************************************************************************************************************************************
69: * {@return the center}.
70: **********************************************************************************************************************************************************/
71: @Nonnull
72: public Optional<Coordinates> getCenter();
73: }
74: