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 * https://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.text.lookup;
19
20 import java.nio.file.Path;
21
22 /**
23 * Abstracts string lookup that guards Path lookups with a fence.
24 */
25 abstract class AbstractPathFencedLookup extends AbstractStringLookup {
26
27 /**
28 * A fence is made of Paths guarding Path resolution.
29 */
30 protected final PathFence fence;
31
32 /**
33 * Constructs a new instance.
34 *
35 * @param paths The fences guarding Path resolution.
36 */
37 AbstractPathFencedLookup(final Path... paths) {
38 this.fence = PathFence.builder().setRoots(paths).get();
39 }
40
41 /**
42 * Gets a Path for the given file name checking that it resolves within our fence.
43 *
44 * @param fileName the file name to resolve.
45 * @return a fenced Path.
46 * @throws IllegalArgumentException if the file name is not without our fence.
47 */
48 protected Path getPath(final String fileName) {
49 return fence.apply(fileName);
50 }
51 }