<commit_before>/**
 * Copyright 2010 CosmoCode GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.cosmocode.rendering;

/**
 * Custom object may implement this interface to change the 
 * default rendering behaviour of {@link Renderer}s when
 * attempting to render instances of that type.
 *
 * @author <NAME>
 */
public interface Renderable {

    /**
     * Renders this instance using the specified renderer. The implementation
     * may decide to make use of the supplied level which allows
     * providing different behaviours when rendering this object.
     * 
     * @param renderer the renderer being used
     * @param level the current level
     * @throws RenderingException if any method on renderer failed
     */
    void render(Renderer renderer, RenderingLevel level) throws RenderingException;
    
}
<commit_msg>added javadoc paragraph to ensure key-value rendering of renderables<commit_after>/**
 * Copyright 2010 CosmoCode GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package de.cosmocode.rendering;

/**
 * Custom object may implement this interface to change the 
 * default rendering behaviour of {@link Renderer}s when
 * attempting to render instances of that type.
 *
 * @author <NAME>
 */
public interface Renderable {

    /**
     * Renders this instance using the specified renderer. The implementation
     * may decide to make use of the supplied level which allows
     * providing different behaviours when rendering this object.
     * 
     * <p>
     *   <strong>Note</strong>: Renderables are only allowed to render themselves
     *   as key-value pairs.
     * </p>
     * 
     * @param renderer the renderer being used
     * @param level the current level
     * @throws RenderingException if any method on renderer failed
     */
    void render(Renderer renderer, RenderingLevel level) throws RenderingException;
    
}

{'fraction_non_alphanumeric': 0.06675795960287573, 'fraction_numerical': 0.005477576172543649, 'mean_word_length': 3.374251497005988, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4550387', 'n_tokens_mistral': 740, 'n_tokens_neox': 711, 'n_words': 353}