ToHuman.java revision 579d7739c53a2707ad711a2d2cae46d7d782f061 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
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
17package com.android.dx.util;
18
19/**
20 * Simple interface for objects that can return a "human" (as opposed to
21 * a complete but often hard to read) string form.
22 */
23public interface ToHuman {
24    /**
25     * Return the "human" string form of this instance.  This is
26     * generally less "debuggy" than {@code toString()}.
27     *
28     * @return {@code non-null;} the human string form
29     */
30    public String toHuman();
31}
32