View Javadoc

1   /*
2    * Copyright 2013 smartics, Kronseder & Reiner GmbH
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  package de.smartics.resteasy.hypermedia.renderer;
17  
18  /**
19   * Renders representation of resources.
20   * <p>
21   * The implementation requires means to get access to the instance of
22   * {@link ResourceContext}. This is usually set by the
23   * {@link AbstractRepresentationBodyWriter} via a constructor call or some form
24   * of post construction ceremony.
25   * </p>
26   *
27   * @param <T> the type of the resource the renderer is rendering representations
28   *          for.
29   */
30  public interface RepresentationRenderer<T>
31  {
32    // ********************************* Fields *********************************
33  
34    // --- constants ------------------------------------------------------------
35  
36    // ****************************** Initializer *******************************
37  
38    // ****************************** Inner Classes *****************************
39  
40    // ********************************* Methods ********************************
41  
42    // --- get&set --------------------------------------------------------------
43  
44    // --- business -------------------------------------------------------------
45  
46    /**
47     * Renders the representation.
48     */
49    void render();
50  
51    // --- object basics --------------------------------------------------------
52  
53  }