org.eclipse.rdf4j.rio.helpers.BinaryRDFWriterSettings Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2021 Eclipse RDF4J contributors.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Distribution License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*******************************************************************************/
package org.eclipse.rdf4j.rio.helpers;
import java.nio.charset.StandardCharsets;
import org.eclipse.rdf4j.rio.RioSetting;
/**
* WriterSettings for the binary RDF writer.
*
* @author Frens Jan Rumph
*/
public class BinaryRDFWriterSettings {
/**
* Setting for the binary RDF format to use.
*
* Defaults to {@code 2}.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.binary.format_version}
*
* @deprecated Use {@link org.eclipse.rdf4j.rio.binary.BinaryRDFWriterSettings#VERSION} instead.
*/
@Deprecated(since = "4.3.0", forRemoval = true)
public static final LongRioSetting VERSION = new LongRioSetting(
"org.eclipse.rdf4j.rio.binary.format_version", "Binary RDF format", 2L);
/**
* Setting for the number of statements to consider while analyzing duplicate RDF terms. Terms that occur twice or
* more within the buffer of statements are written out (starting from the second occurrence) as identifiers.
*
* Defaults to {@code 8192}.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.binary.buffer_size}
*
* @deprecated Use {@link org.eclipse.rdf4j.rio.binary.BinaryRDFWriterSettings#BUFFER_SIZE} instead.
*/
@Deprecated(since = "4.3.0", forRemoval = true)
public static final LongRioSetting BUFFER_SIZE = new LongRioSetting(
"org.eclipse.rdf4j.rio.binary.buffer_size", "Buffer size", 8192L);
/**
* Setting for the character set to use for encoding strings (only applicable to version 2 of the binary RDF
* format).
*
* Defaults to {@code "UTF-8"}.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.binary.charset}
*
* @deprecated Use {@link org.eclipse.rdf4j.rio.binary.BinaryRDFWriterSettings#CHARSET} instead.
*/
@Deprecated(since = "4.3.0", forRemoval = true)
public static final StringRioSetting CHARSET = new StringRioSetting(
"org.eclipse.rdf4j.rio.binary.charset", "Charset", StandardCharsets.UTF_8.name());
/**
* Setting for whether to recycle IDs while writing binary RDF files. (only applicable to version 2 of the binary
* RDF format).
*
* If enabled (the default), once an RDF term is no longer referenced in the buffer of statements (see also
* {@link #BUFFER_SIZE}), the ID of that term can be reused and any in memory reference to that term is released. If
* disabled, once an RDF term is assigned an ID it is never released and an in-memory reference to that term is
* maintained in memory. Note that disabling this setting may decrease file size, but also may result
* in an {@link OutOfMemoryError} because heap memory used is for every term that is ever assigned an ID.
*
*
* Defaults to {@code true}.
*
* Can be overridden by setting system property {@code org.eclipse.rdf4j.rio.binary.recycle_ids}
*
* @deprecated Use {@link org.eclipse.rdf4j.rio.binary.BinaryRDFWriterSettings#RECYCLE_IDS} instead.
*/
@Deprecated(since = "4.3.0", forRemoval = true)
public static final BooleanRioSetting RECYCLE_IDS = new BooleanRioSetting(
"org.eclipse.rdf4j.rio.binary.recycle_ids", "Charset", true);
/**
* Private constructor
*/
private BinaryRDFWriterSettings() {
}
}