Home | History | Annotate | Download | only in repository
      1 /*
      2  * Copyright (C) 2009 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 
     17 package com.android.sdklib.internal.repository;
     18 
     19 /**
     20  * Interface for elements that can provide a description of themselves.
     21  */
     22 public interface IDescription {
     23 
     24     /**
     25      * Returns a description of the given element. Cannot be null.
     26      * <p/>
     27      * A description is a multi-line of text, typically much more
     28      * elaborate than what {@link #toString()} would provide.
     29      */
     30     public abstract String getShortDescription();
     31 
     32     /**
     33      * Returns a description of the given element. Cannot be null.
     34      * <p/>
     35      * A description is a multi-line of text, typically much more
     36      * elaborate than what {@link #toString()} would provide.
     37      */
     38     public abstract String getLongDescription();
     39 
     40 }
     41