#396 Add ReportData class #401
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2017-2019 Yegor Bugayenko | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included | ||
| * in all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
| package org.jpeek; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Report data holder. | ||
| * | ||
| * @since 0.30.9 | ||
| */ | ||
| final class ReportData { | ||
| /** | ||
| * Default mean. | ||
| */ | ||
| private static final double DEFAULT_MEAN = 0.5d; | ||
|
|
||
| /** | ||
| * Default sigma. | ||
| */ | ||
| private static final double DEFAULT_SIGMA = 0.1d; | ||
|
|
||
| /** | ||
| * The metric. | ||
| */ | ||
| private final String metr; | ||
|
|
||
| /** | ||
| * Mean. | ||
| */ | ||
| private final double man; | ||
|
|
||
| /** | ||
| * Sigma. | ||
| */ | ||
| private final double sig; | ||
|
|
||
| /** | ||
| * XSL params. | ||
| */ | ||
| private final Map<String, Object> args; | ||
|
|
||
| /** | ||
| * Ctor. | ||
| * @param name Name of the metric | ||
| */ | ||
| ReportData(final String name) { | ||
| this( | ||
| name, new HashMap<>(0), ReportData.DEFAULT_MEAN, ReportData.DEFAULT_SIGMA | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Ctor. | ||
| * @param name Name of metric | ||
| * @param args Params for XSL | ||
| */ | ||
| ReportData(final String name, final Map<String, Object> args) { | ||
| this( | ||
| name, args, ReportData.DEFAULT_MEAN, ReportData.DEFAULT_SIGMA | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Ctor. | ||
| * @param name Name of the metric | ||
| * @param args Params for XSL | ||
| * @param mean Mean | ||
| * @param sigma Sigma | ||
| * @checkstyle ParameterNumberCheck (10 lines) | ||
| */ | ||
| ReportData(final String name, final Map<String, Object> args, final double mean, | ||
| final double sigma) { | ||
| this.metr = name; | ||
| this.args = new HashMap<>(args); | ||
| this.man = mean; | ||
| this.sig = sigma; | ||
| } | ||
|
|
||
| /** | ||
| * Metric name accessor. | ||
| * @return The metric | ||
| */ | ||
| public String metric() { | ||
| return this.metr; | ||
| } | ||
|
|
||
| /** | ||
| * Mean accessor. | ||
| * @return The mean | ||
| */ | ||
| public double mean() { | ||
| return this.man; | ||
| } | ||
|
|
||
| /** | ||
| * Sigma accessor. | ||
| * @return Sigma | ||
| */ | ||
| public double sigma() { | ||
| return this.sig; | ||
| } | ||
|
|
||
| /** | ||
| * Params accessor. | ||
| * @return Params | ||
| */ | ||
| public Map<String, Object> params() { | ||
| return new HashMap<>(this.args); | ||
|
There was a problem hiding this comment. @HDouss Just returning unmodifiable map would sufficient There was a problem hiding this comment. @fanifieiev Ok. but I think I should remove the test for immutability or change it to expect Exceptions. There was a problem hiding this comment. @HDouss I would personally not create a test for There was a problem hiding this comment. @fanifieiev it does not harm to have such tests, especially for immutability. |
||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@HDouss It is better to use unmodifiable map here