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 package org.apache.commons.vfs2.provider;
18
19 import org.apache.commons.vfs2.FileName;
20 import org.apache.commons.vfs2.FileType;
21
22 /**
23 * A file name for layered files.
24 */
25 public class LayeredFileName extends AbstractFileName {
26
27 /**
28 * The layer separator character '{@value #LAYER_SEPARATOR}'.
29 *
30 * @since 2.10.0
31 */
32 public static final char LAYER_SEPARATOR = '!';
33
34 static final char SCHEME_SEPARATOR = ':';
35
36 private final FileName outerUri;
37
38 /**
39 * Constructs a new instance.
40 *
41 * @param scheme The scheme.
42 * @param outerUri outer file name.
43 * @param path the absolute path, maybe empty or null.
44 * @param type the file type.
45 */
46 public LayeredFileName(final String scheme, final FileName outerUri, final String path, final FileType type) {
47 super(scheme, path, type);
48 this.outerUri = outerUri;
49 }
50
51 @Override
52 protected void appendRootUri(final StringBuilder buffer, final boolean addPassword) {
53 buffer.append(getScheme());
54 buffer.append(SCHEME_SEPARATOR);
55 buffer.append(getOuterName().getURI());
56 buffer.append(LAYER_SEPARATOR);
57 }
58
59 /**
60 * Creates a FileName.
61 *
62 * @param path The file URI.
63 * @param type The FileType.
64 * @return The FileName.
65 */
66 @Override
67 public FileName createName(final String path, final FileType type) {
68 return new LayeredFileName(getScheme(), getOuterName(), path, type);
69 }
70
71 /**
72 * Returns the URI of the outer file.
73 *
74 * @return The FileName.
75 */
76 public FileName getOuterName() {
77 return outerUri;
78 }
79 }