org.apache.commons.vfs2.provider.ram.RamFileSystemConfigBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-vfs2 Show documentation
Apache Commons VFS is a Virtual File System library.
There is a newer version: 2.9.0
/*
 * 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.commons.vfs2.provider.ram;

import org.apache.commons.vfs2.FileSystem;
import org.apache.commons.vfs2.FileSystemConfigBuilder;
import org.apache.commons.vfs2.FileSystemOptions;

/**
 * Config Builder for the RAM file system.
 */
public final class RamFileSystemConfigBuilder extends FileSystemConfigBuilder {

    /** max size key. */
    private static final String MAX_SIZE_KEY = "maxsize";

    /** config builder SINGLETON. */
    private static final RamFileSystemConfigBuilder SINGLETON = new RamFileSystemConfigBuilder();

    /**
     * Constructor
     */
    private RamFileSystemConfigBuilder() {
        super("ram.");
    }

    /**
     * Gets the singleton builder.
     *
     * @return the singleton builder.
     */
    public static RamFileSystemConfigBuilder getInstance() {
        return SINGLETON;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected Class getConfigClass() {
        return RamFileSystem.class;
    }

    /**
     * Defaults to {@link Integer#MAX_VALUE}.
     *
     * @param opts The FileSystem options.
     * @return The maximum size of the file.
     * @see #setMaxSize(FileSystemOptions, long)
     * @since 2.1
     */
    public long getLongMaxSize(final FileSystemOptions opts) {
        return getLong(opts, MAX_SIZE_KEY, Long.MAX_VALUE);
    }

    /**
     * Defaults to {@link Integer#MAX_VALUE}.
     *
     * @param opts The FileSystem options.
     * @return The maximum size of the file. The next major version will change the return type to a long.
     * @see #setMaxSize(FileSystemOptions, int)
     */
    public int getMaxSize(final FileSystemOptions opts) {
        return getLong(opts, MAX_SIZE_KEY, Long.valueOf(Integer.MAX_VALUE)).intValue();
    }

    /**
     * Sets the maximum size of the file system.
     *
     * @param opts The FileSystem options.
     * @param sizeInBytes The maximum file size.
     * @deprecated Use {@link #setMaxSize(FileSystemOptions, long)}
     */
    @Deprecated
    public void setMaxSize(final FileSystemOptions opts, final int sizeInBytes) {
        setParam(opts, MAX_SIZE_KEY, Long.valueOf(sizeInBytes));
    }

    /**
     * Sets the maximum size of the file system.
     *
     * @param opts The FileSystem options.
     * @param sizeInBytes The maximum file size.
     */
    public void setMaxSize(final FileSystemOptions opts, final long sizeInBytes) {
        setParam(opts, MAX_SIZE_KEY, Long.valueOf(sizeInBytes));
    }

}