alfresco-community-repo/source/java/org/alfresco/repo/virtual/ref/Encoding.java

/* 
 * Copyright (C) 2005-2015 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco 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 Alfresco. If not, see http://www.gnu.org/licenses/.
 */

package org.alfresco.repo.virtual.ref;

import java.io.Serializable;

/**
 * A {@link Reference} {@link String} encoding definition.<br>
 * 
 * @see ReferenceParser
 * @see Stringifier
 * @author Bogdan Horje
 */
public class Encoding implements Serializable
{

    /**
     * 
     */
    private static final long serialVersionUID = 1L;

    /**
     * String encoding token - signals the beginning of a reference encoded with
     * this encoding in given String.
     */
    public final Character token;

    /**
     * <code>true</code> if {@link Reference}s encoded using this encoding 
     * can be part of URLs.
     */
    public final boolean urlNative;

    public final ReferenceParser parser;

    public final Stringifier stringifier;

    public Encoding(Character token, ReferenceParser parser, Stringifier stringifier, boolean urlNative)
    {
        super();
        this.token = token;
        this.parser = parser;
        this.stringifier = stringifier;
        this.urlNative = urlNative;
    }

}