Claudenw commented on code in PR #311: URL: https://github.com/apache/creadur-rat/pull/311#discussion_r1805067095
########## apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentName.java: ########## @@ -0,0 +1,220 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.rat.document.impl; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Objects; + +import org.apache.commons.io.FileUtils; +import org.apache.commons.lang3.StringUtils; + + +/** + * A collection of names for a document. All names in the set are + * either Rat (Linux like) or Native (OS specific). + */ +public final class DocumentName implements Comparable<DocumentName> { + /** True if the file system on which we are operating is case-sensitive */ + public static final boolean FS_IS_CASE_SENSITIVE; + /** The full name for the document */ + private final String name; + /** The name of the base directory for the document */ + private final String baseName; + /** The directory separator for this document. */ + private final String dirSeparator; + /** The case-sensitive flag */ + private final boolean isCaseSensitive; + + static { + boolean fsSensitive = true; + try { + Path p = Files.createTempDirectory("NameSet"); + File f = p.toFile(); + fsSensitive = !new File(f, "a").equals(new File(f, "A")); + FileUtils.deleteDirectory(f); + } catch (IOException e) { + fsSensitive = true; + } + FS_IS_CASE_SENSITIVE = fsSensitive; + } + + /** + * Creates a Dcoument name. + * @param name the name of the document + * @param baseName the base name of the document. + * @param dirSeparator the directory separator used in the name. + * @param isCaseSensitive {@code true} if the name is case-sensitive. + */ + public DocumentName(final String name, final String baseName, final String dirSeparator, final boolean isCaseSensitive) { + this.name = Objects.requireNonNull(name); + this.baseName = Objects.requireNonNull(StringUtils.defaultIfEmpty(baseName, null)); + this.dirSeparator = Objects.requireNonNull(dirSeparator); + this.isCaseSensitive = isCaseSensitive; + } + + /** + * Creates a document name with the name of the file and the same basename as the baseName document. + * @param file the file to name the document from. + * @param baseName the DocumentName to provide the baseName. + */ + public DocumentName(final File file, final DocumentName baseName) { + this(file.getAbsolutePath(), baseName.baseName, File.separator, FS_IS_CASE_SENSITIVE); + } + + /** + * Creates a document name with the name and basename equal to the file name + * @param file the file name to use. + */ + public DocumentName(final File file) { + this(file.getAbsolutePath(), file.getAbsolutePath(), File.separator, FS_IS_CASE_SENSITIVE); + } + + /** + * Creates a new document name by adding the child to the current name. + * @param child the child to add (must use directory separator from this document name. + * @return the new document name with the same base name, directory separator and case sensitivity as this one. + */ + public DocumentName resolve(final String child) { + List<String> parts = new ArrayList<>(); + parts.addAll(Arrays.asList(tokenize(name))); + parts.addAll(Arrays.asList(tokenize(child))); + String newName = String.join(dirSeparator, parts); + return new DocumentName(newName, baseName, dirSeparator, isCaseSensitive); + } + + /** + * Gets the fully qualified name of the document. + * @return the fully qualified name of the document. + */ + public String name() { Review Comment: ok ########## apache-rat-core/src/main/java/org/apache/rat/document/impl/DocumentName.java: ########## @@ -0,0 +1,220 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.rat.document.impl; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Objects; + +import org.apache.commons.io.FileUtils; +import org.apache.commons.lang3.StringUtils; + + +/** + * A collection of names for a document. All names in the set are + * either Rat (Linux like) or Native (OS specific). + */ +public final class DocumentName implements Comparable<DocumentName> { + /** True if the file system on which we are operating is case-sensitive */ + public static final boolean FS_IS_CASE_SENSITIVE; + /** The full name for the document */ + private final String name; + /** The name of the base directory for the document */ + private final String baseName; + /** The directory separator for this document. */ + private final String dirSeparator; + /** The case-sensitive flag */ + private final boolean isCaseSensitive; + + static { + boolean fsSensitive = true; + try { + Path p = Files.createTempDirectory("NameSet"); + File f = p.toFile(); + fsSensitive = !new File(f, "a").equals(new File(f, "A")); + FileUtils.deleteDirectory(f); + } catch (IOException e) { + fsSensitive = true; + } + FS_IS_CASE_SENSITIVE = fsSensitive; + } + + /** + * Creates a Dcoument name. + * @param name the name of the document + * @param baseName the base name of the document. + * @param dirSeparator the directory separator used in the name. + * @param isCaseSensitive {@code true} if the name is case-sensitive. + */ + public DocumentName(final String name, final String baseName, final String dirSeparator, final boolean isCaseSensitive) { + this.name = Objects.requireNonNull(name); + this.baseName = Objects.requireNonNull(StringUtils.defaultIfEmpty(baseName, null)); + this.dirSeparator = Objects.requireNonNull(dirSeparator); + this.isCaseSensitive = isCaseSensitive; + } + + /** + * Creates a document name with the name of the file and the same basename as the baseName document. + * @param file the file to name the document from. + * @param baseName the DocumentName to provide the baseName. + */ + public DocumentName(final File file, final DocumentName baseName) { + this(file.getAbsolutePath(), baseName.baseName, File.separator, FS_IS_CASE_SENSITIVE); + } + + /** + * Creates a document name with the name and basename equal to the file name + * @param file the file name to use. + */ + public DocumentName(final File file) { + this(file.getAbsolutePath(), file.getAbsolutePath(), File.separator, FS_IS_CASE_SENSITIVE); + } + + /** + * Creates a new document name by adding the child to the current name. + * @param child the child to add (must use directory separator from this document name. + * @return the new document name with the same base name, directory separator and case sensitivity as this one. + */ + public DocumentName resolve(final String child) { + List<String> parts = new ArrayList<>(); + parts.addAll(Arrays.asList(tokenize(name))); + parts.addAll(Arrays.asList(tokenize(child))); + String newName = String.join(dirSeparator, parts); + return new DocumentName(newName, baseName, dirSeparator, isCaseSensitive); + } + + /** + * Gets the fully qualified name of the document. + * @return the fully qualified name of the document. + */ + public String name() { + return name; + } + + /** + * Gets the fully qualified basename of the document. + * @return the fully qualified basename of the document. + */ + public String baseName() { Review Comment: ok -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: dev-unsubscr...@creadur.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
