restconf/restconf-nb/src/main/java/org/opendaylight/restconf/nb/rfc8040/PointParam.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 org.eclipse.jdt.annotation.NonNull;
  13
  14 /**
  15  * This class represents a {@code point} parameter as defined in
  16  * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.6">RFC8040 section 4.8.6</a>.
  17  */
  18 public final class PointParam implements RestconfQueryParam<PointParam> {
  19     // API consistency: must not be confused with enum constants
  20     @SuppressWarnings("checkstyle:ConstantName")
  21     public static final @NonNull String uriName = "point";
  22
  23     // FIXME: This should be ApiPath
  24     private final @NonNull String value;
  25
  26     private PointParam(final String value) {
  27         this.value = requireNonNull(value);
  28     }
  29
  30     @Override
  31     public Class<@NonNull PointParam> javaClass() {
  32         return PointParam.class;
  33     }
  34
  35     @Override
  36     public String paramName() {
  37         return uriName;
  38     }
  39
  40     @Override
  41     public String paramValue() {
  42         return value;
  43     }
  44
  45     public static @NonNull PointParam forUriValue(final String uriValue) {
  46         return new PointParam(uriValue);
  47     }
  48
  49     public @NonNull String value() {
  50         return value;
  51     }
  52 }