sxp-mapper/src/main/java/org/opendaylight/groupbasedpolicy/sxp/mapper/api/ReadableByKey.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.groupbasedpolicy.sxp.mapper.api;
  10
  11 import java.util.Collection;
  12 import javax.annotation.Nonnull;
  13
  14 /**
  15  * Purpose: simple search interface allowing for custom key and returning list of values
  16  *
  17  * @param <X> special key type
  18  * @param <V> value type
  19  */
  20 public interface ReadableByKey<X, V> {
  21
  22     /**
  23      * @param specialKey custom key to search by
  24      * @return list of found values
  25      */
  26     Collection<V> readBy(@Nonnull X specialKey);
  27 }