Package: RectangularArea

RectangularArea

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:
31: /***************************************************************************************************************************************************************
32: *
33: * A rectangular geographic area, that is a region with a north, south, west and east delimiters.
34: *
35: * @see Area
36: * @author Fabrizio Giudici
37: *
38: **************************************************************************************************************************************************************/
39: public interface RectangularArea extends Area
40: {
41: /***********************************************************************************************************************************************************
42: * {@return the north-west corner}.
43: **********************************************************************************************************************************************************/
44: @Nonnull
45: public Optional<Coordinates> getNorthWest();
46:
47: /***********************************************************************************************************************************************************
48: * {@return the south-east corner}.
49: **********************************************************************************************************************************************************/
50: @Nonnull
51: public Optional<Coordinates> getSouthEast();
52:
53: /***********************************************************************************************************************************************************
54: * {@return a new, possibly larger rectangular area including the given point}.
55: * @param point the point
56: **********************************************************************************************************************************************************/
57: @Nonnull
58: public RectangularArea including (@Nonnull Coordinates point);
59:
60: /***********************************************************************************************************************************************************
61: * {@return a new, possibly larger rectangular area including the given area}.
62: * @param area the area
63: **********************************************************************************************************************************************************/
64: @Nonnull
65: public RectangularArea including (@Nonnull Area area);
66: }
67: