restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/FilterParam.java

   1 /*
   2  * Copyright (c) 2021 PANTHEON.tech, s.r.o. 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 package org.opendaylight.restconf.nb.rfc8040;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import java.net.URI;
  13 import org.eclipse.jdt.annotation.NonNull;
  14
  15 /**
  16  * This class represents a {@code filter} parameter as defined in
  17  * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.4">RFC8040 section 4.8.4</a>.
  18  */
  19
  20 public final class FilterParam implements RestconfQueryParam<FilterParam> {
  21     // API consistency: must not be confused with enum constants
  22     @SuppressWarnings("checkstyle:ConstantName")
  23     public static final @NonNull String uriName = "filter";
  24
  25     private static final @NonNull URI CAPABILITY = URI.create("urn:ietf:params:restconf:capability:filter:1.0");
  26
  27     // FIXME: can we have a parsed, but not bound version of an XPath, please?
  28     private final @NonNull String value;
  29
  30     private FilterParam(final String value) {
  31         this.value = requireNonNull(value);
  32     }
  33
  34     @Override
  35     public Class<@NonNull FilterParam> javaClass() {
  36         return FilterParam.class;
  37     }
  38
  39     @Override
  40     public String paramName() {
  41         return uriName;
  42     }
  43
  44     @Override
  45     public String paramValue() {
  46         return value;
  47     }
  48
  49     public static @NonNull FilterParam forUriValue(final String uriValue) {
  50         return new FilterParam(uriValue);
  51     }
  52
  53     public static @NonNull URI capabilityUri() {
  54         return CAPABILITY;
  55     }
  56 }