Index.java

Go to the documentation of this file.

/*
 * Gridarta MMORPG map editor for Crossfire, Daimonin and similar games.
 * Copyright (C) 2000-2015 The Gridarta Developers.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

package net.sf.gridarta.model.index;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.Collection;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface Index<V> {

    int size();

    @NotNull
    Collection<V> findPartialName(@NotNull String name);

    void beginUpdate();

    void endUpdate();

    void add(@NotNull V value, long timestamp);

    void remove(@NotNull V value);

    void setPending(@NotNull V value);

    void setName(@NotNull V value, long timestamp, @NotNull String name);

    @Nullable
    String getName(@NotNull V value);

    @Nullable
    V removePending();

    boolean hasPending();

    boolean isModified();

    void addIndexListener(@NotNull IndexListener<V> listener);

    void removeIndexListener(@NotNull IndexListener<V> listener);

    void save(@NotNull ObjectOutputStream objectOutputStream) throws IOException;

    void load(@NotNull ObjectInputStream objectInputStream) throws IOException;

    void clear();

    void indexingFinished();

}