it.could.util.encoding.Encodable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of webdav Show documentation

A Simple Approach to WebDAV (Servlet Implementation)

The newest version!

/* ========================================================================== *
 *         Copyright (C) 2004-2006, Pier Fumagalli          *
 *                            All rights reserved.                            *
 * ========================================================================== *
 *                                                                            *
 * Licensed 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 .       *
 *                                                                            *
 * 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 it.could.util.encoding;

import java.io.UnsupportedEncodingException;

/**
 * The {@link Encodable} interface describes an {@link Object} whose
 * {@link String} representation can vary depending on the encoding used.
 *
 * @author Pier Fumagalli
 */
public interface Encodable extends EncodingAware {
    
    /**
     * Return the {@link String} representation of this instance.
     * 
     * This method is equivalent to a call to
     * {@link #toString(String) toString}({@link EncodingAware#DEFAULT_ENCODING
     * DEFAULT_ENCODING})
     */
    public String toString();

    /**
     * Return the {@link String} representation of this instance given
     * a specific character encoding.
     * 
     * @throws UnsupportedEncodingException if the specified encoding is not
     *                                      supported by the platform.
     */
    public String toString(String encoding)
    throws UnsupportedEncodingException;

}