org.productivity.java.habitat4j.common.interfaces
Interface DecoderIF

All Known Implementing Classes:

SampleBase64EncoderDecoder

public interface DecoderIF

Interface used to implement a property value decoder.

## LICENSE INFORMATION ##

This library 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 2.1 of the License, or (at your option) any later version.

This library 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 library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version:

$Id: DecoderIF.html,v 1.2 2008/11/24 15:15:20 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

Method Summary

java.lang.String	decode(java.lang.String propertyListName, java.lang.String name, java.lang.String value)
void	initialize(java.lang.String appName, java.lang.String propertyListName)

Method Detail

initialize

void initialize(java.lang.String appName,
                java.lang.String propertyListName)
                throws DecoderException

Parameters:

appName - - the name of the calling application (use is optional)

propertyListName - - the name of the PropertyList that's calling this method (use is optional)

Throws:

DecoderException

decode

java.lang.String decode(java.lang.String propertyListName,
                        java.lang.String name,
                        java.lang.String value)
                        throws DecoderException

Parameters:

propertyListName - - the name of the PropertyList that's calling this method (use is optional)

name - - the Property name (use is optional)

value - - the String value to decode

Returns:

Returns a decoded String from parameter "value"

Throws:

DecoderException