org.apache.commons.vfs2.provider.ram.RamFileData Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-vfs2 Show documentation
Show all versions of commons-vfs2 Show documentation
Apache Commons VFS is a Virtual File System library.
/*
* 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.vfs2.FileName;
import org.apache.commons.vfs2.FileSystemException;
import org.apache.commons.vfs2.FileType;
/**
* RAM File Object Data.
*/
class RamFileData implements Serializable {
static final byte[] EMPTY = new byte[0];
/**
* 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 lastModified;
/**
* Children
*/
private final Collection children;
/**
* Constructor.
*
* @param name The file name.
*/
public RamFileData(final FileName name) {
super();
this.children = Collections.synchronizedCollection(new ArrayList());
this.clear();
if (name == null) {
throw new IllegalArgumentException("name can not be null");
}
this.name = name;
}
/**
* @return Returns the buffer.
*/
byte[] getContent() {
return content;
}
/**
* @param content The buffer.
*/
void setContent(final byte[] content) {
updateLastModified();
this.content = content;
}
/**
* @return Returns the lastModified.
*/
long getLastModified() {
return lastModified;
}
/**
* @param lastModified The lastModified to set.
*/
void setLastModified(final long lastModified) {
this.lastModified = lastModified;
}
/**
* @return Returns the type.
*/
FileType getType() {
return type;
}
/**
* @param type The type to set.
*/
void setType(final FileType type) {
this.type = type;
}
/**
*/
void clear() {
this.content = EMPTY;
updateLastModified();
this.type = FileType.IMAGINARY;
this.children.clear();
this.name = null;
}
void updateLastModified() {
this.lastModified = System.currentTimeMillis();
}
/**
* @return Returns the name.
*/
FileName getName() {
return name;
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
return this.name.toString();
}
/**
* 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();
}
/**
* 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();
}
/**
* @return Returns the children.
*/
Collection getChildren() {
if (name == null) {
throw new IllegalStateException("Data is clear");
}
return children;
}
/*
* (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());
}
/*
* (non-Javadoc)
*
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return this.getName().hashCode();
}
boolean hasChildren(final RamFileData data) {
return this.children.contains(data);
}
/**
* @return Returns the size of the buffer
*/
int size() {
return content.length;
}
/**
* 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();
}
}