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 */
017
018package org.apache.commons.io.file;
019
020import org.apache.commons.io.IOUtils;
021
022/**
023 * Defines the standard delete options.
024 *
025 * @since 2.8.0
026 */
027public enum StandardDeleteOption implements DeleteOption {
028
029    /**
030     * Overrides the read-only attribute to allow deletion.
031     */
032    OVERRIDE_READ_ONLY;
033
034    /**
035     * Returns true if the given options contain {@link StandardDeleteOption#OVERRIDE_READ_ONLY}.
036     *
037     * For now, assume the array is not sorted.
038     *
039     * @param options the array to test
040     * @return true if the given options contain {@link StandardDeleteOption#OVERRIDE_READ_ONLY}.
041     */
042    public static boolean overrideReadOnly(final DeleteOption[] options) {
043        if (IOUtils.length(options) == 0) {
044            return false;
045        }
046        for (final DeleteOption deleteOption : options) {
047            if (deleteOption == StandardDeleteOption.OVERRIDE_READ_ONLY) {
048                return true;
049            }
050        }
051        return false;
052    }
053
054}