org.opendaylight.restconf.nb.rfc8040.legacy.QueryParameters Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2021 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.restconf.nb.rfc8040.legacy;

import com.google.common.annotations.Beta;
import java.util.List;
import java.util.Set;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.restconf.api.query.DepthParam;
import org.opendaylight.restconf.api.query.PrettyPrintParam;
import org.opendaylight.restconf.server.api.DataGetParams;
import org.opendaylight.yangtools.yang.common.QName;

/**
 * This holds various options acquired from a requests's query part. This class needs to be further split up to make
 * sense of it, as parts of it pertain to how a {@link NormalizedNodePayload} should be created while others how it
 * needs to be processed (for example filtered).
 */
@Beta
// FIXME: this probably needs to be renamed back to WriterParams, or somesuch
public record QueryParameters(
        @Nullable DepthParam depth,
        @Nullable PrettyPrintParam prettyPrint,
        @Nullable List> fields) {
    public static final @NonNull QueryParameters EMPTY = new QueryParameters(null, null, null);

    public static @NonNull QueryParameters of(final DataGetParams params) {
        final var depth = params.depth();
        final var prettyPrint = params.prettyPrint();
        return depth == null && prettyPrint == null ? EMPTY : new QueryParameters(depth, prettyPrint, null);
    }

    public static @NonNull QueryParameters of(final DataGetParams params, final List> fields) {
        return fields == null ? of(params) : new QueryParameters(params.depth(), params.prettyPrint(), fields);
    }
}