1 /*
2 * Copyright 2004 Sun Microsystems, Inc.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *
16 */
17 package com.sun.syndication.common;
18
19 /***
20 * To provide support for contextual toString functionality.
21 * <p>
22 * Classes implementing this interface can collaborate with the caller of the toString method by
23 * prepending a prefix to their toString output.
24 * <p>
25 * @author Alejandro Abdelnur
26 *
27 */
28 public interface ToString {
29
30 /***
31 * Returns the String representation of the object with a prefix.
32 * <p>
33 * @param prefix prefix for the String representation of the object.
34 * @return String representation of the object prepended by the given prefix.
35 *
36 */
37 public String toString(String prefix);
38
39 }