org.modeshape.jcr.value.basic.BasicPath Maven / Gradle / Ivy
/*
* ModeShape (http://www.modeshape.org)
* See the COPYRIGHT.txt file distributed with this work for information
* regarding copyright ownership. Some portions may be licensed
* to Red Hat, Inc. under one or more contributor license agreements.
* See the AUTHORS.txt file in the distribution for a full listing of
* individual contributors.
*
* ModeShape is free software. Unless otherwise indicated, all code in ModeShape
* is licensed to you under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* ModeShape is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.modeshape.jcr.value.basic;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import org.modeshape.common.annotation.Immutable;
import org.modeshape.common.text.Inflector;
import org.modeshape.common.util.CheckArg;
import org.modeshape.jcr.GraphI18n;
import org.modeshape.jcr.value.InvalidPathException;
import org.modeshape.jcr.value.Path;
/**
* A basic implementation of {@link Path}.
*/
@Immutable
public class BasicPath extends AbstractPath {
/**
* The initial serializable version. Version {@value}
*/
private static final long serialVersionUID = 1L;
private static final List EMPTY_SEGMENTS = Collections.emptyList();
public static final Path EMPTY_RELATIVE = new BasicPath(EMPTY_SEGMENTS, false);
public static final Path SELF_PATH = new BasicPath(Collections.singletonList(Path.SELF_SEGMENT), false);
public static final Path PARENT_PATH = new BasicPath(Collections.singletonList(Path.PARENT_SEGMENT), false);
private/*final*/List segments;
private/*final*/boolean absolute;
private/*final*/boolean normalized;
/**
* @param segments the segments
* @param absolute true if this path is absolute, or false otherwise
*/
public BasicPath( List segments,
boolean absolute ) {
assert segments != null;
this.segments = Collections.unmodifiableList(segments);
this.absolute = absolute;
this.normalized = isNormalized(this.segments);
}
@Override
public Path getAncestor( int degree ) {
CheckArg.isNonNegative(degree, "degree");
if (degree == 0) return this;
int endIndex = this.segments.size() - degree;
if (endIndex == 0) return this.isAbsolute() ? RootPath.INSTANCE : null;
if (endIndex < 0) {
String msg = GraphI18n.pathAncestorDegreeIsInvalid.text(this.getString(), Inflector.getInstance().ordinalize(degree));
throw new InvalidPathException(msg);
}
return subpath(0, endIndex);
}
@Override
protected Iterator getSegmentsOfParent() {
int size = this.segments.size();
if (size == 1) return EMPTY_PATH_ITERATOR;
return this.segments.subList(0, size - 1).iterator();
}
@Override
public List getSegmentsList() {
return this.segments;
}
@Override
public boolean isAbsolute() {
return this.absolute;
}
@Override
public boolean isNormalized() {
return this.normalized;
}
@Override
public boolean isRoot() {
return false;
}
@Override
public int size() {
return this.segments.size();
}
/**
* Custom deserialization is needed, since the 'segments' list may not be serializable (e.g., java.util.RandomAccessSubList).
*
* @param aStream the input stream to which this object should be serialized; never null
* @throws IOException if there is a problem reading from the stream
* @throws ClassNotFoundException if there is a problem loading any required classes
*/
@SuppressWarnings( "unchecked" )
private void readObject( ObjectInputStream aStream ) throws IOException, ClassNotFoundException {
absolute = aStream.readBoolean();
normalized = aStream.readBoolean();
segments = (List)aStream.readObject();
}
/**
* Custom serialization is needed, since the 'segments' list may not be serializable (e.g., java.util.RandomAccessSubList).
*
* @param aStream the input stream to which this object should be serialized; never null
* @throws IOException if there is a problem writing to the stream
*/
private void writeObject( ObjectOutputStream aStream ) throws IOException {
aStream.writeBoolean(absolute);
aStream.writeBoolean(normalized);
aStream.writeObject(Collections.unmodifiableList(new ArrayList(segments))); // make a copy!
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy