restconf/restconf-nb-rfc8040/src/main/java/org/opendaylight/restconf/nb/rfc8040/legacy/QueryParameters.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.legacy;
   9
  10 import static java.util.Objects.requireNonNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import java.util.List;
  14 import java.util.Set;
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.Nullable;
  17 import org.opendaylight.restconf.nb.rfc8040.DepthParam;
  18 import org.opendaylight.restconf.nb.rfc8040.PrettyPrintParam;
  19 import org.opendaylight.restconf.nb.rfc8040.ReadDataParams;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22
  23 /**
  24  * This holds various options acquired from a requests's query part. This class needs to be further split up to make
  25  * sense of it, as parts of it pertain to how a {@link NormalizedNodePayload} should be created while others how it
  26  * needs to be processed (for example filtered).
  27  */
  28 @Beta
  29 // FIXME: this probably needs to be renamed back to WriterParams, or somesuch
  30 public final class QueryParameters {
  31     private static final @NonNull QueryParameters EMPTY = of(ReadDataParams.empty());
  32
  33     private final @NonNull ReadDataParams params;
  34     private final List<YangInstanceIdentifier> fieldPaths;
  35     private final List<Set<QName>> fields;
  36
  37     private QueryParameters(final ReadDataParams params, final List<Set<QName>> fields,
  38             final List<YangInstanceIdentifier> fieldPaths) {
  39         this.params = requireNonNull(params);
  40         this.fields = fields;
  41         this.fieldPaths = fieldPaths;
  42     }
  43
  44     public static @NonNull QueryParameters empty() {
  45         return EMPTY;
  46     }
  47
  48     public static @NonNull QueryParameters of(final ReadDataParams params) {
  49         return new QueryParameters(params, null, null);
  50     }
  51
  52     public static @NonNull QueryParameters ofFields(final ReadDataParams params, final List<Set<QName>> fields) {
  53         return new QueryParameters(params, fields, null);
  54     }
  55
  56     public static @NonNull QueryParameters ofFieldPaths(final ReadDataParams params,
  57             final List<YangInstanceIdentifier> fieldPaths) {
  58         return new QueryParameters(params, null, fieldPaths);
  59     }
  60
  61     public @NonNull ReadDataParams params() {
  62         return params;
  63     }
  64
  65     public @Nullable DepthParam depth() {
  66         return params.depth();
  67     }
  68
  69     public @Nullable PrettyPrintParam prettyPrint() {
  70         return params.prettyPrint();
  71     }
  72
  73     public @Nullable List<Set<QName>> fields() {
  74         return fields;
  75     }
  76
  77     public @Nullable List<YangInstanceIdentifier> fieldPaths() {
  78         return fieldPaths;
  79     }
  80 }