001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.vfs2.util;
018
019/**
020 * An enumerated type representing the modes of a random access content.
021 */
022public enum RandomAccessMode {
023    /**
024     * read.
025     */
026    READ(true, false),
027
028    /**
029     * read/write.
030     */
031    READWRITE(true, true);
032
033    private final boolean read;
034    private final boolean write;
035
036    private RandomAccessMode(final boolean read, final boolean write) {
037        this.read = read;
038        this.write = write;
039    }
040
041    public boolean requestRead() {
042        return read;
043    }
044
045    public boolean requestWrite() {
046        return write;
047    }
048
049    /**
050     * @return The mode String.
051     * @since 2.0
052     */
053    public String getModeString() {
054        if (requestRead()) {
055            if (requestWrite()) {
056                return "rw"; // NON-NLS
057            }
058            return "r"; // NON-NLS
059        } else if (requestWrite()) {
060            return "w"; // NON-NLS
061        }
062
063        return "";
064    }
065}