11195997843

Committed 05 Oct 2024 08:11PM UTC coverage: 99.411%. Remained the same

Build # 11195997843

Build Type

Pull #444

github

Committed by

ljacqu

Commit Message

Move channel declaration

Pull Request Pull Request #444: #442 Update Checkstyle version used by CodeClimate

Run Details

528 of 540 branches covered (97.78%)

1520 of 1529 relevant lines covered (99.41%)

4.58 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/src/main/java/ch/jalu/configme/beanmapper/context/ExportContext.java

package ch.jalu.configme.beanmapper.context;

import ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments;
import org.jetbrains.annotations.NotNull;

/**
 * Context used by the bean mapper when a value is exported.
 */
public interface ExportContext {

    /**
     * @return path relative to the bean root that is currently being processed
     */
    @NotNull String getBeanPath();

    /**
     * Creates a child context with the given path as addition to this context's path.
     *
     * @param path the path to add
     * @return child export context
     */
    @NotNull ExportContext createChildContext(@NotNull String path);

    /**
     * Specifies whether the given comments instance should be included in the export in this context. Comments
     * should not be included if they're specified to appear only once and they've already been incorporated.
     *
     * @param comments the comments instance to process
     * @return true if the comments should be included, false if they should be skipped
     */
    boolean shouldInclude(@NotNull BeanPropertyComments comments);

    /**
     * Registers the given comments. Used to keep track of all unique comment's UUIDs that have been processed.
     *
     * @param comments the comments instance to process
     */
    void registerComment(@NotNull BeanPropertyComments comments);

}

1	package ch.jalu.configme.beanmapper.context;
2
3	import ch.jalu.configme.beanmapper.propertydescription.BeanPropertyComments;
4	import org.jetbrains.annotations.NotNull;
5
6	/**
7	* Context used by the bean mapper when a value is exported.
8	*/
9	public interface ExportContext {
10
11	/**
12	* @return path relative to the bean root that is currently being processed
13	*/
14	@NotNull String getBeanPath();
15
16	/**
17	* Creates a child context with the given path as addition to this context's path.
18	*
19	* @param path the path to add
20	* @return child export context
21	*/
22	@NotNull ExportContext createChildContext(@NotNull String path);
23
24	/**
25	* Specifies whether the given comments instance should be included in the export in this context. Comments
26	* should not be included if they're specified to appear only once and they've already been incorporated.
27	*
28	* @param comments the comments instance to process
29	* @return true if the comments should be included, false if they should be skipped
30	*/
31	boolean shouldInclude(@NotNull BeanPropertyComments comments);
32
33	/**
34	* Registers the given comments. Used to keep track of all unique comment's UUIDs that have been processed.
35	*
36	* @param comments the comments instance to process
37	*/
38	void registerComment(@NotNull BeanPropertyComments comments);
39
40	}

AuthMe / ConfigMe / 11195997843

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous