This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-vfs.git
The following commit(s) were added to refs/heads/master by this push: new b033da85 Javadoc @see tags do not need to use a FQCN for classes in java.lang new 0f386af2 Merge branch 'master' of https://gitbox.apache.org/repos/asf/commons-vfs b033da85 is described below commit b033da85ae2f786d86524aa9b0a339e556b0dda7 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Mon Aug 29 07:22:09 2022 -0400 Javadoc @see tags do not need to use a FQCN for classes in java.lang --- .../commons/vfs2/provider/hdfs/HdfsFileObject.java | 4 +- .../commons/vfs2/provider/ram/RamFileData.java | 514 ++++++++++----------- .../provider/ram/RamFileRandomAccessContent.java | 6 +- 3 files changed, 262 insertions(+), 262 deletions(-) diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java index 9ad45716..0c74f7e1 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/hdfs/HdfsFileObject.java @@ -258,7 +258,7 @@ public class HdfsFileObject extends AbstractFileObject<HdfsFileSystem> { } /** - * @see org.apache.commons.vfs2.provider.AbstractFileObject#doRemoveAttribute(java.lang.String) + * @see org.apache.commons.vfs2.provider.AbstractFileObject#doRemoveAttribute(String) */ @Override protected void doRemoveAttribute(final String attrName) throws Exception { @@ -275,7 +275,7 @@ public class HdfsFileObject extends AbstractFileObject<HdfsFileSystem> { } /** - * @see org.apache.commons.vfs2.provider.AbstractFileObject#doSetAttribute(java.lang.String, java.lang.Object) + * @see org.apache.commons.vfs2.provider.AbstractFileObject#doSetAttribute(String, Object) */ @Override protected void doSetAttribute(final String attrName, final Object value) throws Exception { diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java index aa3cd6ef..2e1d93e3 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileData.java @@ -1,257 +1,257 @@ -/* - * 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.commons.vfs2.provider.ram; - -import java.io.Serializable; -import java.util.ArrayList; -import java.util.Collection; -import java.util.Collections; - -import org.apache.commons.lang3.ArrayUtils; -import org.apache.commons.vfs2.FileName; -import org.apache.commons.vfs2.FileSystemException; -import org.apache.commons.vfs2.FileType; - -/** - * RAM File Object Data. - */ -final class RamFileData implements Serializable { - - /** - * serialVersionUID format is YYYYMMDD for the date of the last binary change. - */ - private static final long serialVersionUID = 20101208L; - - /** - * File Name. - */ - private FileName name; - - /** - * File Type. - */ - private FileType type; - - /** - * Bytes. - */ - private byte[] content; - - /** - * Last modified time - */ - private long lastModifiedMillis; - - /** - * Children - */ - private final Collection<RamFileData> children; - - /** - * Constructor. - * - * @param name The file name. - */ - RamFileData(final FileName name) { - this.children = Collections.synchronizedCollection(new ArrayList<>()); - this.clear(); - if (name == null) { - throw new IllegalArgumentException("name can not be null"); - } - this.name = name; - } - - /** - * Add a child. - * - * @param data The file data. - * @throws FileSystemException if an error occurs. - */ - void addChild(final RamFileData data) throws FileSystemException { - if (!this.getType().hasChildren()) { - throw new FileSystemException("A child can only be added in a folder"); - } - - FileSystemException.requireNonNull(data, "No child can be null"); - - if (this.children.contains(data)) { - throw new FileSystemException("Child already exists. " + data); - } - - this.children.add(data); - updateLastModified(); - } - - /** - */ - void clear() { - this.content = ArrayUtils.EMPTY_BYTE_ARRAY; - updateLastModified(); - this.type = FileType.IMAGINARY; - this.children.clear(); - this.name = null; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#equals(java.lang.Object) - */ - @Override - public boolean equals(final Object o) { - if (this == o) { - return true; - } - if (!(o instanceof RamFileData)) { - return false; - } - final RamFileData data = (RamFileData) o; - return this.getName().equals(data.getName()); - } - - /** - * @return Returns the children. - */ - Collection<RamFileData> getChildren() { - if (name == null) { - throw new IllegalStateException("Data is clear"); - } - return children; - } - - /** - * @return Returns the buffer. - */ - byte[] getContent() { - return content; - } - - /** - * @return Returns the lastModified. - */ - long getLastModified() { - return lastModifiedMillis; - } - - /** - * @return Returns the name. - */ - FileName getName() { - return name; - } - - /** - * @return Returns the type. - */ - FileType getType() { - return type; - } - - boolean hasChildren(final RamFileData data) { - return this.children.contains(data); - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#hashCode() - */ - @Override - public int hashCode() { - return this.getName().hashCode(); - } - - /** - * Remove a child. - * - * @param data The file data. - * @throws FileSystemException if an error occurs. - */ - void removeChild(final RamFileData data) throws FileSystemException { - if (!this.getType().hasChildren()) { - throw new FileSystemException("A child can only be removed from a folder"); - } - if (!this.children.contains(data)) { - throw new FileSystemException("Child not found. " + data); - } - this.children.remove(data); - updateLastModified(); - } - - /** - * Resize the buffer - * - * @param newSize The new buffer size. - */ - void resize(final long newSize) { - // A future implementation may allow longs/multiple buffer/and so on - if (newSize > Integer.MAX_VALUE) { - throw new IllegalArgumentException( - String.format("newSize(%d) > Integer.MAX_VALUE(%d)", newSize, Integer.MAX_VALUE)); - } - final int resize = (int) newSize; - final int size = this.size(); - final byte[] newBuf = new byte[resize]; - System.arraycopy(this.content, 0, newBuf, 0, Math.min(resize, size)); - this.content = newBuf; - updateLastModified(); - } - - /** - * @param content The buffer. - */ - void setContent(final byte[] content) { - updateLastModified(); - this.content = content; - } - - /** - * @param lastModified The lastModified to set. - */ - void setLastModified(final long lastModified) { - this.lastModifiedMillis = lastModified; - } - - /** - * @param type The type to set. - */ - void setType(final FileType type) { - this.type = type; - } - - /** - * @return Returns the size of the buffer - */ - int size() { - return content.length; - } - - /* - * (non-Javadoc) - * - * @see java.lang.Object#toString() - */ - @Override - public String toString() { - return this.name.toString(); - } - - void updateLastModified() { - this.lastModifiedMillis = System.currentTimeMillis(); - } - -} +/* + * 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.commons.vfs2.provider.ram; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; + +import org.apache.commons.lang3.ArrayUtils; +import org.apache.commons.vfs2.FileName; +import org.apache.commons.vfs2.FileSystemException; +import org.apache.commons.vfs2.FileType; + +/** + * RAM File Object Data. + */ +final class RamFileData implements Serializable { + + /** + * serialVersionUID format is YYYYMMDD for the date of the last binary change. + */ + private static final long serialVersionUID = 20101208L; + + /** + * File Name. + */ + private FileName name; + + /** + * File Type. + */ + private FileType type; + + /** + * Bytes. + */ + private byte[] content; + + /** + * Last modified time + */ + private long lastModifiedMillis; + + /** + * Children + */ + private final Collection<RamFileData> children; + + /** + * Constructor. + * + * @param name The file name. + */ + RamFileData(final FileName name) { + this.children = Collections.synchronizedCollection(new ArrayList<>()); + this.clear(); + if (name == null) { + throw new IllegalArgumentException("name can not be null"); + } + this.name = name; + } + + /** + * Add a child. + * + * @param data The file data. + * @throws FileSystemException if an error occurs. + */ + void addChild(final RamFileData data) throws FileSystemException { + if (!this.getType().hasChildren()) { + throw new FileSystemException("A child can only be added in a folder"); + } + + FileSystemException.requireNonNull(data, "No child can be null"); + + if (this.children.contains(data)) { + throw new FileSystemException("Child already exists. " + data); + } + + this.children.add(data); + updateLastModified(); + } + + /** + */ + void clear() { + this.content = ArrayUtils.EMPTY_BYTE_ARRAY; + updateLastModified(); + this.type = FileType.IMAGINARY; + this.children.clear(); + this.name = null; + } + + /* + * (non-Javadoc) + * + * @see Object#equals(Object) + */ + @Override + public boolean equals(final Object o) { + if (this == o) { + return true; + } + if (!(o instanceof RamFileData)) { + return false; + } + final RamFileData data = (RamFileData) o; + return this.getName().equals(data.getName()); + } + + /** + * @return Returns the children. + */ + Collection<RamFileData> getChildren() { + if (name == null) { + throw new IllegalStateException("Data is clear"); + } + return children; + } + + /** + * @return Returns the buffer. + */ + byte[] getContent() { + return content; + } + + /** + * @return Returns the lastModified. + */ + long getLastModified() { + return lastModifiedMillis; + } + + /** + * @return Returns the name. + */ + FileName getName() { + return name; + } + + /** + * @return Returns the type. + */ + FileType getType() { + return type; + } + + boolean hasChildren(final RamFileData data) { + return this.children.contains(data); + } + + /* + * (non-Javadoc) + * + * @see Object#hashCode() + */ + @Override + public int hashCode() { + return this.getName().hashCode(); + } + + /** + * Remove a child. + * + * @param data The file data. + * @throws FileSystemException if an error occurs. + */ + void removeChild(final RamFileData data) throws FileSystemException { + if (!this.getType().hasChildren()) { + throw new FileSystemException("A child can only be removed from a folder"); + } + if (!this.children.contains(data)) { + throw new FileSystemException("Child not found. " + data); + } + this.children.remove(data); + updateLastModified(); + } + + /** + * Resize the buffer + * + * @param newSize The new buffer size. + */ + void resize(final long newSize) { + // A future implementation may allow longs/multiple buffer/and so on + if (newSize > Integer.MAX_VALUE) { + throw new IllegalArgumentException( + String.format("newSize(%d) > Integer.MAX_VALUE(%d)", newSize, Integer.MAX_VALUE)); + } + final int resize = (int) newSize; + final int size = this.size(); + final byte[] newBuf = new byte[resize]; + System.arraycopy(this.content, 0, newBuf, 0, Math.min(resize, size)); + this.content = newBuf; + updateLastModified(); + } + + /** + * @param content The buffer. + */ + void setContent(final byte[] content) { + updateLastModified(); + this.content = content; + } + + /** + * @param lastModified The lastModified to set. + */ + void setLastModified(final long lastModified) { + this.lastModifiedMillis = lastModified; + } + + /** + * @param type The type to set. + */ + void setType(final FileType type) { + this.type = type; + } + + /** + * @return Returns the size of the buffer + */ + int size() { + return content.length; + } + + /* + * (non-Javadoc) + * + * @see Object#toString() + */ + @Override + public String toString() { + return this.name.toString(); + } + + void updateLastModified() { + this.lastModifiedMillis = System.currentTimeMillis(); + } + +} diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java index 5b0a1978..04ef5652 100644 --- a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java +++ b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/ram/RamFileRandomAccessContent.java @@ -482,7 +482,7 @@ public class RamFileRandomAccessContent implements RandomAccessContent { /* * (non-Javadoc) * - * @see java.io.DataOutput#writeBytes(java.lang.String) + * @see java.io.DataOutput#writeBytes(String) */ @Override public void writeBytes(final String s) throws IOException { @@ -504,7 +504,7 @@ public class RamFileRandomAccessContent implements RandomAccessContent { /* * (non-Javadoc) * - * @see java.io.DataOutput#writeChars(java.lang.String) + * @see java.io.DataOutput#writeChars(String) */ @Override public void writeChars(final String s) throws IOException { @@ -573,7 +573,7 @@ public class RamFileRandomAccessContent implements RandomAccessContent { /* * (non-Javadoc) * - * @see java.io.DataOutput#writeUTF(java.lang.String) + * @see java.io.DataOutput#writeUTF(String) */ @Override public void writeUTF(final String str) throws IOException {