src/org/mxchange/jcore/criteria/Criteria.java

   1 /*
   2  * Copyright (C) 2015 Roland Haeder
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcore.criteria;
  18
  19 import java.util.Map;
  20 import java.util.Set;
  21 import org.mxchange.jcore.FrameworkInterface;
  22
  23 /**
  24  * A general interface for criteria
  25  *
  26  * @author Roland Haeder
  27  */
  28 public interface Criteria extends FrameworkInterface {
  29         /**
  30          * Adds a boolean criteria
  31          *
  32          * @param key Key of criteria
  33          * @param value Value of criteria
  34          */
  35         public void addCriteria (final String key, final boolean value);
  36
  37         /**
  38          * Adds a string criteria
  39          *
  40          * @param key Key of criteria
  41          * @param value Value of criteria
  42          */
  43         public void addCriteria (final String key, final String value);
  44
  45         /**
  46          * Gets all values from underlaying map in an iterator.
  47          *
  48          * @return Values iteratable
  49          */
  50         public Iterable<Object> values ();
  51
  52         /**
  53          * Gets all entries as a key-value pair
  54          *
  55          * @return Key-value paira of all entries
  56          */
  57         public Set<Map.Entry<String, Object>> entrySet ();
  58 }