001/*
002 * This file is part of Baritone.
003 *
004 * Baritone is free software: you can redistribute it and/or modify
005 * it under the terms of the GNU Lesser General Public License as published by
006 * the Free Software Foundation, either version 3 of the License, or
007 * (at your option) any later version.
008 *
009 * Baritone is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
012 * GNU Lesser General Public License for more details.
013 *
014 * You should have received a copy of the GNU Lesser General Public License
015 * along with Baritone.  If not, see <https://www.gnu.org/licenses/>.
016 */
017
018package baritone.api.cache;
019
020import java.util.Set;
021
022/**
023 * @author Brady
024 * @since 9/24/2018
025 */
026public interface IWaypointCollection {
027
028    /**
029     * Adds a waypoint to this collection
030     *
031     * @param waypoint The waypoint
032     */
033    void addWaypoint(IWaypoint waypoint);
034
035    /**
036     * Removes a waypoint from this collection
037     *
038     * @param waypoint The waypoint
039     */
040    void removeWaypoint(IWaypoint waypoint);
041
042    /**
043     * Gets the most recently created waypoint by the specified {@link IWaypoint.Tag}
044     *
045     * @param tag The tag
046     * @return The most recently created waypoint with the specified tag
047     */
048    IWaypoint getMostRecentByTag(IWaypoint.Tag tag);
049
050    /**
051     * Gets all of the waypoints that have the specified tag
052     *
053     * @param tag The tag
054     * @return All of the waypoints with the specified tag
055     * @see IWaypointCollection#getAllWaypoints()
056     */
057    Set<IWaypoint> getByTag(IWaypoint.Tag tag);
058
059    /**
060     * Gets all of the waypoints in this collection, regardless of the tag.
061     *
062     * @return All of the waypoints in this collection
063     * @see IWaypointCollection#getByTag(IWaypoint.Tag)
064     */
065    Set<IWaypoint> getAllWaypoints();
066}