001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.space;
020
021/**
022 * Used by JDBMSpace to match entries based on its value
023 */
024public interface Template {
025    /**
026     * Returns the key this template matches against.
027     *
028     * @return the entry key
029     */
030    Object getKey();
031    /**
032     * Indicates whether the candidate {@code obj} matches this template.
033     *
034     * @param obj candidate value
035     * @return {@code true} when matched
036     */
037    boolean equals(Object obj);
038}
039