001/*
002    Licensed to the Apache Software Foundation (ASF) under one
003    or more contributor license agreements.  See the NOTICE file
004    distributed with this work for additional information
005    regarding copyright ownership.  The ASF licenses this file
006    to you under the Apache License, Version 2.0 (the
007    "License"); you may not use this file except in compliance
008    with the License.  You may obtain a copy of the License at
009
010       http://www.apache.org/licenses/LICENSE-2.0
011
012    Unless required by applicable law or agreed to in writing,
013    software distributed under the License is distributed on an
014    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015    KIND, either express or implied.  See the License for the
016    specific language governing permissions and limitations
017    under the License.     
018 */
019package org.apache.wiki;
020
021import org.apache.wiki.api.core.Context;
022
023
024/**
025 *  Defines an interface for transforming strings within a Wiki context.
026 *
027 *  @since 1.6.4
028 */
029public interface StringTransmutator {
030    
031    /**
032     *  Returns a changed String, suitable for Wiki context.
033     *  
034     *  @param context WikiContext in which mutation is to be done
035     *  @param source  The source string.
036     *  @return The mutated string.
037     */
038    String mutate( Context context, String source );
039
040}