001/*
002 *  Copyright 2026 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.util;
017
018/**
019 * Interface representing an object that can hold a Point of Interest (POI).
020 * A POI is defined by a 2D point with x and y coordinates.
021 */
022public interface POIHolder
023{
024    /**
025     * Returns the Point of Interest (POI) associated with this object.
026     * @return the {@link Point} representing the POI, or {@code null} if none is defined
027     */
028    public Point getPOI();
029    
030    /**
031     * Represents a 2D point with integer coordinates, used to define a Point of Interest.
032     * @param x the x coordinate
033     * @param y the y coordinate
034     */
035    public record Point(int x, int y) { /* empty */ }
036}