org.dizitart.no2.tool.ExportOptions Maven / Gradle / Ivy
/*
*
* Copyright 2017-2018 Nitrite 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 org.dizitart.no2.tool;
import lombok.Getter;
import lombok.Setter;
import org.dizitart.no2.*;
import java.util.ArrayList;
import java.util.List;
/**
* Represents export options.
*
* @since 1.0
* @author Anindya Chatterjee
* @see Exporter
*/
@Getter @Setter
public class ExportOptions {
/**
* Indicates if the export operation exports indices information.
*
* [icon="{@docRoot}/note.png"]
* NOTE: Default value is `true`.
*
* @param exportIndices a value indicating if indices information will be exported.
* @return `true` if indices information is exported; otherwise, `false`.
* */
private boolean exportIndices = true;
/**
* Indicates if the export operation exports collection data.
*
* [icon="{@docRoot}/note.png"]
* NOTE: Default value is `true`.
*
* @param exportData a value indicating if collection data will be exported.
* @return `true` if collection data is exported; otherwise, `false`.
* */
private boolean exportData = true;
/**
* Specifies a list of {@link PersistentCollection}s to be exported.
*
* [icon="{@docRoot}/note.png"]
* NOTE: If empty, all collections will be exported.
*
* @param collections list of all collections to be exported.
* @return list of collections.
* */
private List> collections = new ArrayList<>();
}