tika-parsers/tika-parsers-standard/tika-parsers-standard-modules/tika-parser-text-module/src/main/java/org/apache/tika/parser/strings/StringsConfig.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.tika.parser.strings;

import java.io.Serializable;

/**
 * Configuration for the "strings" (or strings-alternative) command.
 */
public class StringsConfig implements Serializable {
    /**
     * Serial version UID
     */
    private static final long serialVersionUID = -1465227101645003594L;

    private String stringsPath = "";

    // Minimum sequence length (characters) to print
    private int minLength = 4;

    // Character encoding of the strings that are to be found
    private StringsEncoding encoding = StringsEncoding.SINGLE_7_BIT;

    // Maximum time (seconds) to wait for the strings process termination
    private int timeoutSeconds = 120;

    /**
     * Returns the minimum sequence length (characters) to print.
     *
     * @return the minimum sequence length (characters) to print.
     */
    public int getMinLength() {
        return this.minLength;
    }

    /**
     * Sets the minimum sequence length (characters) to print.
     *
     * @param minLength the minimum sequence length (characters) to print.
     */
    public void setMinLength(int minLength) {
        if (minLength < 1) {
            throw new IllegalArgumentException("Invalid minimum length");
        }
        this.minLength = minLength;
    }

    /**
     * Returns the character encoding of the strings that are to be found.
     *
     * @return {@link StringsEncoding} enum that represents the character
     * encoding of the strings that are to be found.
     */
    public StringsEncoding getEncoding() {
        return this.encoding;
    }

    /**
     * Sets the character encoding of the strings that are to be found.
     *
     * @param encoding {@link StringsEncoding} enum that represents the character
     *                 encoding of the strings that are to be found.
     */
    public void setEncoding(StringsEncoding encoding) {
        this.encoding = encoding;
    }

    /**
     * Returns the maximum time (in seconds) to wait for the "strings" command
     * to terminate.
     *
     * @return the maximum time (in seconds) to wait for the "strings" command
     * to terminate.
     */
    public int getTimeoutSeconds() {
        return this.timeoutSeconds;
    }

    /**
     * Sets the maximum time (in seconds) to wait for the "strings" command to
     * terminate.
     *
     * @param timeoutSeconds the maximum time (in seconds) to wait for the "strings"
     *                       command to terminate.
     */
    public void setTimeoutSeconds(int timeoutSeconds) {
        if (timeoutSeconds < 1) {
            throw new IllegalArgumentException("Invalid timeout");
        }
        this.timeoutSeconds = timeoutSeconds;
    }
}