FileComparator.R
FileComparator.R
file1file1
file2file2
file1_contents_listfile1 contents
file2_contents_listfile2 contents
summary_comparisonsummary comparison result
details_comparisondetails comparison result
debuggerdebugger instance
new()Initialize a FileComparator instance
FileComparator$new(file1 = NULL, file2 = NULL)file1First file to compare.
file2Second file to compare.
vrf_summary()Method for comparing the file summary information. This method is intended to be implemented only this class level. For comparator specific rules, the internal method vrf_summary_inner should be customized on lower levels instead.
FileComparator$vrf_summary(config, omit = NULL)configconfiguration values
omitstring pattern to omit from the comparison
vrf_details()Method for comparing the file details information. This method is intended to be implemented only this class level. For comparator specific rules, the internal method vrf_summary_inner should be customized on lower levels instead.
FileComparator$vrf_details(config, omit = NULL)configconfiguration values
omitstring pattern to omit from the comparison
vrf_summary_inner()"Abstract" method for comparing the inner part for the summary. This method has to be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn't be called directly by the user.
FileComparator$vrf_summary_inner(config, omit)configconfiguration values
omitstring pattern to omit from the comparison
vrf_details_inner()"Abstract" method for comparing the inner part for the detailsThis method has to be overwritten by more specialized comparator classes. This method is intended to be called only by the comparator classes in the processing and shouldn't be called directly by the user.
FileComparator$vrf_details_inner(config, omit)configconfiguration values
omitstring pattern to omit from the comparison
vrf_details_supported()Inherited method for indicating whether detailed comparison is available with the current comparator. Returns an empty string if the comparator is is supported, otherwise a string that will be concatenated with the summary string.
FileComparator$vrf_details_supported(config)configconfiguration values
vrf_option_value()Method for getting specific value from the config In the initial version, returns 'NA' if null con is passed.
FileComparator$vrf_option_value(config, key)configconfiguration values
keykey to search from the parameters
vrf_open_debug()Wrapper method for the opening a new debugging instance with Debugger class if debugging is enabled in config class. Creates the used debugger instance if needed.
FileComparator$vrf_open_debug(message, config)messagemessage to debug to console
configconfiguration values
vrf_add_debug()Wrapper method for the adding a new debugging message with Debugger class.
FileComparator$vrf_add_debug(message)messagemessage to debug to console
vrf_add_debug_files()Special method for adding the compared files into debugger stack.
FileComparator$vrf_add_debug_files()
vrf_close_debug()Wrapper method for the stopping (closing) current debugging instance with Debugger class.
FileComparator$vrf_close_debug()
clone()The objects of this class are cloneable with this method.
FileComparator$clone(deep = FALSE)deepWhether to make a deep clone.
Comparator 'abstract' class containing the generic comparison methods and handling for high level checks (like file existence). This class should never be instantiated - doing that and calling the comparison methods will lead to error.