alfresco-community-repo/source/java/org/alfresco/repo/avm/util/VersionPathStuffer.java

/**
 * 
 */
package org.alfresco.repo.avm.util;

import org.alfresco.repo.avm.AVMNodeConverter;
import org.alfresco.service.cmr.repository.NodeRef;
import org.springframework.extensions.surf.util.Pair;

/**
 * A utility to build a (possibly long) String representation of
 * a collection of AVM path,versions. The path,versions can be recovered
 * by VersionPathUnStuffer.
 * @author britt
 */
public final class VersionPathStuffer 
{
    /**
     * The internal buffer.
     */
    private StringBuilder fBuilder;
    
    /**
     * Whether any paths have been added yet.
     */
    private boolean fAnyAdded;
    
    /**
     * Make up one.
     */
    public VersionPathStuffer()
    {
        fBuilder = new StringBuilder();
        fAnyAdded = false;
    }
    
    /**
     * Add a version path expressed by the version and path.
     */
    public VersionPathStuffer add(int version, String path)
    {
        if (fAnyAdded)
        {
            fBuilder.append(';');
        }
        fBuilder.append(path);
        fBuilder.append('@');
        fBuilder.append(version);
        fAnyAdded = true;
        return this;
    }
    
    /**
     * Add a version path expressed as a NodeRef.
     */
    public VersionPathStuffer add(NodeRef nodeRef)
    {
        Pair<Integer, String> versionPath =
            AVMNodeConverter.ToAVMVersionPath(nodeRef);
        add(versionPath.getFirst(), versionPath.getSecond());
        return this;
    }
    
    /**
     * Get the stuffed String version of the Version/Paths contained in this.
     */
    public String toString()
    {
        return fBuilder.toString();
    }
}