Coverage Report

Coverage Report - org.naftulin.configmgr.content.AbstractRecordImpl

Classes in this File

Line Coverage

Branch Coverage

Complexity

AbstractRecordImpl

100%

15/15

N/A

 package org.naftulin.configmgr.content;
 
 import org.apache.commons.lang.builder.ToStringBuilder;
 import org.naftulin.configmgr.ConfigurationManagerException;
 import org.naftulin.configmgr.parsers.ConfigEntryParser;
 
 /**
  * Abstract Record implementation combines the most common attributes of the record: file name and key.
  * A record is described in the master configuraion: current implementations include
  * property record, log4j xml or property and external record, all sub-classed from the
  * abstract record.
  * 
  * @author Henry Naftulin
  * @since 1.0
  */
 public abstract class AbstractRecordImpl {
         private String fileName;
         private String key;
 
         /**
          * If configuration is file-base, we need to get the file to be parsed.
          * Most of the configurations are file-based.
          * @return true.
          */
         public boolean isGetUrlForFile() {
                 return true;
         }
 
 
         /**
          * Constructs a record without specifying the key or file name.
          */
         public AbstractRecordImpl() {                
         }
         
         /**
          * Constructs a record with the key and file name specified.
          * @param key the key associated with the record.
          * @param fileName the file name associated with the record.
          */
         public AbstractRecordImpl(String key, String fileName) {
                 this.fileName = fileName;
                 this.key = key;
         }
         
         /**
          * Returns the file name associated with the record.
          * @return the file name associated with the record.
          */
         public String getFileName() {
                 return fileName;
         }
         
         /**
          * Sets the file name for the reoord.
          * @param fileName the file name for the record.
          */
         public void setFileName(final String fileName) {
                 this.fileName = fileName;
         }
         
         /**
          * Returns the key associated with the record. 
          * @return the key associated with the record.
          */
         public String getKey() {
                 return key;
         }
         
         /**
          * Sets the key associated with the record.
          * @param key the key associated with the record.
          */
         public void setKey(final String key) {
                 this.key = key;
         }
         
         /**
          * Returns the parser that can parse the file to extract the configuration.
          * @return the parser that can parse the file to extract the configuration.
          * @throws ConfigurationManagerException if an error occured while instantiating the parser.
          */
         public abstract ConfigEntryParser getParser() throws ConfigurationManagerException;
         /**
          * Returns the string representation of the record.
          * @return the string representation of the record.
          */
         public String toString() {
                 return new ToStringBuilder(this).append("key", this.key).append(
                                 "fileName", this.fileName).toString();
         }
 }

1		package org.naftulin.configmgr.content;
2
3		import org.apache.commons.lang.builder.ToStringBuilder;
4		import org.naftulin.configmgr.ConfigurationManagerException;
5		import org.naftulin.configmgr.parsers.ConfigEntryParser;
6
7		/**
8		* Abstract Record implementation combines the most common attributes of the record: file name and key.
9		* A record is described in the master configuraion: current implementations include
10		* property record, log4j xml or property and external record, all sub-classed from the
11		* abstract record.
12		*
13		* @author Henry Naftulin
14		* @since 1.0
15		*/
16		public abstract class AbstractRecordImpl {
17		private String fileName;
18		private String key;
19
20		/**
21		* If configuration is file-base, we need to get the file to be parsed.
22		* Most of the configurations are file-based.
23		* @return true.
24		*/
25		public boolean isGetUrlForFile() {
26	265	return true;
27		}
28
29
30		/**
31		* Constructs a record without specifying the key or file name.
32		*/
33	435	public AbstractRecordImpl() {
34	435	}
35
36		/**
37		* Constructs a record with the key and file name specified.
38		* @param key the key associated with the record.
39		* @param fileName the file name associated with the record.
40		*/
41	25	public AbstractRecordImpl(String key, String fileName) {
42	25	this.fileName = fileName;
43	25	this.key = key;
44	25	}
45
46		/**
47		* Returns the file name associated with the record.
48		* @return the file name associated with the record.
49		*/
50		public String getFileName() {
51	740	return fileName;
52		}
53
54		/**
55		* Sets the file name for the reoord.
56		* @param fileName the file name for the record.
57		*/
58		public void setFileName(final String fileName) {
59	285	this.fileName = fileName;
60	285	}
61
62		/**
63		* Returns the key associated with the record.
64		* @return the key associated with the record.
65		*/
66		public String getKey() {
67	760	return key;
68		}
69
70		/**
71		* Sets the key associated with the record.
72		* @param key the key associated with the record.
73		*/
74		public void setKey(final String key) {
75	435	this.key = key;
76	435	}
77
78		/**
79		* Returns the parser that can parse the file to extract the configuration.
80		* @return the parser that can parse the file to extract the configuration.
81		* @throws ConfigurationManagerException if an error occured while instantiating the parser.
82		*/
83		public abstract ConfigEntryParser getParser() throws ConfigurationManagerException;
84		/**
85		* Returns the string representation of the record.
86		* @return the string representation of the record.
87		*/
88		public String toString() {
89	780	return new ToStringBuilder(this).append("key", this.key).append(
90	520	"fileName", this.fileName).toString();
91		}
92		}