/*
 * 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;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.common.annotations.Beta;
import java.net.URI;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;

/**
 * This class represents a {@code depth} parameter as defined in
 * <a href="https://datatracker.ietf.org/doc/html/rfc8040#section-4.8.2">RFC8040 section 4.8.2</a>.
 */
public final class DepthParam implements RestconfQueryParam<DepthParam> {
    // API consistency: must not be confused with enum constants
    @SuppressWarnings("checkstyle:ConstantName")
    public static final @NonNull String uriName = "depth";

    private static final @NonNull URI CAPABILITY = URI.create("urn:ietf:params:restconf:capability:depth:1.0");
    private static final @NonNull DepthParam MIN = of(1);
    private static final @NonNull DepthParam MAX = of(65535);

    private final int value;

    private DepthParam(final int value) {
        this.value = value;
        checkArgument(value >= 1 && value <= 65535);
    }

    public static @NonNull DepthParam of(final int value) {
        return new DepthParam(value);
    }

    @Override
    public Class<@NonNull DepthParam> javaClass() {
        return DepthParam.class;
    }

    @Override
    public String paramName() {
        return uriName;
    }

    @Override
    public String paramValue() {
        return String.valueOf(value);
    }

    @Beta
    public static @NonNull DepthParam min() {
        return MIN;
    }

    @Beta
    public static @NonNull DepthParam max() {
        return MAX;
    }

    public static @Nullable DepthParam forUriValue(final String uriValue) {
        return "unbounded".equals(uriValue) ? null : of(Integer.parseUnsignedInt(uriValue, 10));
    }

    public int value() {
        return value;
    }

    public static @NonNull URI capabilityUri() {
        return CAPABILITY;
    }
}