io.r2dbc.postgresql.message.backend.ParameterStatus Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.r2dbc.postgresql.message.backend;

import io.netty.buffer.ByteBuf;
import io.r2dbc.postgresql.util.Assert;

import java.util.Objects;

import static io.r2dbc.postgresql.message.backend.BackendMessageUtils.readCStringUTF8;

/**
 * The ParameterStatus message.
 */
public final class ParameterStatus implements BackendMessage {

    private final String name;

    private final String value;

    /**
     * Creates a new message.
     *
     * @param name  the name of the run-time parameter being reported
     * @param value the current value of the parameter
     * @throws IllegalArgumentException if {@code status} or {@code value} is {@code null}
     */
    public ParameterStatus(String name, String value) {
        this.name = Assert.requireNonNull(name, "name must not be null");
        this.value = Assert.requireNonNull(value, "value must not be null");
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        ParameterStatus that = (ParameterStatus) o;
        return Objects.equals(this.name, that.name) &&
            Objects.equals(this.value, that.value);
    }

    /**
     * Returns the name of the run-time parameter being reported.
     *
     * @return the name of the run-time parameter being reported
     */
    public String getName() {
        return this.name;
    }

    /**
     * Returns the current value of the parameter.
     *
     * @return the current value of the parameter
     */
    public String getValue() {
        return this.value;
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.name, this.value);
    }

    @Override
    public String toString() {
        return "ParameterStatus{" +
            "name='" + this.name + '\'' +
            ", value='" + this.value + '\'' +
            '}';
    }

    static ParameterStatus decode(ByteBuf in) {
        Assert.requireNonNull(in, "in must not be null");

        return new ParameterStatus(readCStringUTF8(in), readCStringUTF8(in));
    }

}