com.hazelcast.vector.VectorDocument Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hazelcast-jdbc Show documentation

Hazelcast JDBC Driver

The newest version!

/*
 * Copyright (c) 2008-2024, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.vector;

import com.hazelcast.spi.annotation.Beta;
import com.hazelcast.vector.impl.VectorDocumentImpl;

import javax.annotation.Nonnull;

/**
 * A {@code VectorDocument} includes a user-supplied {@code V value} and the associated {@link VectorValues}
 * that represent the document.
 * @param 
 *
 * @since 5.5
 */
@Beta
public interface VectorDocument {

    @Nonnull
    V getValue();

    @Nonnull
    VectorValues getVectors();

    static  VectorDocument of(@Nonnull T value, @Nonnull VectorValues vv) {
        return new VectorDocumentImpl<>(value, vv);
    }
}