com.arangodb.entity.arangosearch.StoredValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core module for ArangoDB Java Driver
There is a newer version: 7.16.0
/*
 * DISCLAIMER
 *
 * Copyright 2016 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb.entity.arangosearch;


import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.List;
import java.util.Objects;

/**
 * @author Michele Rastelli
 * @see API Documentation
 * @since ArangoDB 3.7
 */
public final class StoredValue {

    private final List fields;
    private final ArangoSearchCompression compression;
    private final Boolean cache;

    /**
     * @param fields      A list of attribute paths. The . character denotes sub-attributes.
     * @param compression Defines how to compress the attribute values.
     * @param cache       Whether to cache stored values in memory. (Since ArangoDB 3.9.5, Enterprise Edition only)
     */
    @JsonCreator
    public StoredValue(@JsonProperty("fields") List fields,
                       @JsonProperty("compression") ArangoSearchCompression compression,
                       @JsonProperty("cache") Boolean cache) {
        this.fields = fields;
        this.compression = compression;
        this.cache = cache;
    }

    public StoredValue(List fields, ArangoSearchCompression compression) {
        this(fields, compression, null);
    }

    public StoredValue(List fields) {
        this(fields, null);
    }

    public List getFields() {
        return fields;
    }

    public ArangoSearchCompression getCompression() {
        return compression;
    }

    public Boolean getCache() {
        return cache;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        StoredValue that = (StoredValue) o;
        return Objects.equals(fields, that.fields) && compression == that.compression && Objects.equals(cache, that.cache);
    }

    @Override
    public int hashCode() {
        return Objects.hash(fields, compression, cache);
    }
}