View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.io.file;
19  
20  import java.util.stream.Stream;
21  
22  import org.apache.commons.io.IOUtils;
23  
24  /**
25   * Defines the standard delete options.
26   *
27   * @since 2.8.0
28   */
29  public enum StandardDeleteOption implements DeleteOption {
30  
31      /**
32       * Overrides the read-only attribute to allow deletion, on POSIX, this means Write and Execute on the parent.
33       */
34      OVERRIDE_READ_ONLY;
35  
36      /**
37       * Returns true if the given options contain {@link StandardDeleteOption#OVERRIDE_READ_ONLY}.
38       *
39       * For now, assume the array is not sorted.
40       *
41       * @param options the array to test
42       * @return true if the given options contain {@link StandardDeleteOption#OVERRIDE_READ_ONLY}.
43       */
44      public static boolean overrideReadOnly(final DeleteOption[] options) {
45          if (IOUtils.length(options) == 0) {
46              return false;
47          }
48          return Stream.of(options).anyMatch(e -> StandardDeleteOption.OVERRIDE_READ_ONLY == e);
49      }
50  
51  }