dev.miku.r2dbc.mysql.message.FieldValue Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2018-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
 *
 *      http://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 dev.miku.r2dbc.mysql.message;

import io.netty.util.ReferenceCounted;

/**
 * A sealed interface for field value, it has 3-implementations: {@link NullFieldValue},
 * {@link NormalFieldValue} and {@link LargeFieldValue}.
 * 
 * WARNING: it is sealed interface, should NEVER extends or implemented by another interface or class.
 */
public interface FieldValue extends ReferenceCounted {

    default boolean isNull() {
        return false;
    }

    static FieldValue nullField() {
        return NullFieldValue.INSTANCE;
    }
}