-/**
- * ============LICENSE_START====================================================
- * org.onap.aaf
- * ===========================================================================
- * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
- * ===========================================================================
- * 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.
- * ============LICENSE_END====================================================
- *
- */
-
-package org.onap.aaf.misc.env;
-
-/**
- * <h1>TimeTaken</h1>
- * This simple interface allows for many different kinds of
- * Audit Logs to be accomplished, by assuming that the creation
- * of this object indicates "start", and the calling of "done"
- * ends.
- *
- * The implementor of this class can easily be stored in efficient
- * mechanisms to minimize impact of Auditing on performance.
- *
- * @author Jonathan
- *
- */
-public abstract class TimeTaken {
- public final long start;
- protected long end, size;
- public final int flag;
- public final String name;
-
- /**
- * The name is as it will appear when written to output (abstract method)
- *
- * The flag is an integer which can be System type (XML, REMOTE, etc), or End User defined for reporting purposes
- *
- * @param name
- * @param flag
- */
- public TimeTaken(String name, int flag) {
- start = System.nanoTime();
- this.flag = flag;
- this.name = name;
- size = -1;
- }
-
-
- /**
- * Call this when process is done to state ending time.<p>
- *
- * It is <i>exceedingly prudent</i> to wrap the process called with a try-finally:<p>
- *
- * <pre>
- * TimeTaken tt = env.startSubTime();
- * try {
- * process.me(); // code to be timed.
- * } finally {
- * tt.done();
- * }
- * </pre>
- */
- public void done() {
- end = System.nanoTime();
- }
-
-
- /**
- * For sizable contents, set the size. Implementations can simply write a no-op if they don't wish to
- * store the size.
- *
- * @param size
- */
- public void size(long theSize) {
- size = theSize;
- }
-
- /**
- * Give readonly access to End, which isn't final
- * @return
- */
- public long end() {
- return end;
- }
-
- /**
- * Time is taken in NanoSeconds. This method converts to decimals of Milliseconds
- * @return
- */
- public float millis() {
- return (end-start)/1000000f;
- }
- /**
- * Write self to a String Builder (for making Audits)
- * @param sb
- */
- public abstract void output(StringBuilder sb);
-
- /**
- * For Debugging
- */
- public String toString() {
- return name + ' ' + millis() + "ms " + (size>0?Long.toString(size):"");
- }
-
-}
+/**\r
+ * ============LICENSE_START====================================================\r
+ * org.onap.aaf\r
+ * ===========================================================================\r
+ * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.\r
+ * ===========================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ============LICENSE_END====================================================\r
+ *\r
+ */\r
+\r
+package org.onap.aaf.misc.env;\r
+\r
+/**\r
+ * <h1>TimeTaken</h1>\r
+ * This simple interface allows for many different kinds of \r
+ * Audit Logs to be accomplished, by assuming that the creation\r
+ * of this object indicates "start", and the calling of "done" \r
+ * ends.\r
+ * \r
+ * The implementor of this class can easily be stored in efficient\r
+ * mechanisms to minimize impact of Auditing on performance.\r
+ * \r
+ * @author Jonathan\r
+ *\r
+ */\r
+public abstract class TimeTaken {\r
+ public final long start;\r
+ protected long end, size;\r
+ public final int flag;\r
+ public final String name;\r
+ public final Object[] values;\r
+ \r
+ /**\r
+ * The name is as it will appear when written to output (abstract method)\r
+ * \r
+ * The flag is an integer which can be System type (XML, REMOTE, etc), or End User defined for reporting purposes \r
+ * \r
+ * @param name\r
+ * @param flag\r
+ * @param values \r
+ */\r
+ public TimeTaken(String name, int flag, Object ... values) {\r
+ start = System.nanoTime();\r
+ this.flag = flag;\r
+ this.name = name;\r
+ this.values = values;\r
+ size = -1;\r
+ }\r
+\r
+\r
+ /**\r
+ * Call this when process is done to state ending time.<p>\r
+ * \r
+ * It is <i>exceedingly prudent</i> to wrap the process called with a try-finally:<p>\r
+ * \r
+ * <pre>\r
+ * TimeTaken tt = env.startSubTime();\r
+ * try {\r
+ * process.me(); // code to be timed.\r
+ * } finally {\r
+ * tt.done();\r
+ * }\r
+ * </pre>\r
+ */\r
+ public void done() {\r
+ end = System.nanoTime();\r
+ }\r
+ \r
+ \r
+ /**\r
+ * For sizable contents, set the size. Implementations can simply write a no-op if they don't wish to \r
+ * store the size. \r
+ * \r
+ * @param size\r
+ */\r
+ public void size(long theSize) {\r
+ size = theSize;\r
+ }\r
+ \r
+ /**\r
+ * Give readonly access to End, which isn't final\r
+ * @return\r
+ */\r
+ public long end() {\r
+ return end;\r
+ }\r
+ \r
+ /**\r
+ * Time is taken in NanoSeconds. This method converts to decimals of Milliseconds\r
+ * @return\r
+ */\r
+ public float millis() {\r
+ return (end-start)/1000000f;\r
+ }\r
+ /**\r
+ * Write self to a String Builder (for making Audits)\r
+ * @param sb\r
+ */\r
+ public abstract void output(StringBuilder sb);\r
+ \r
+ /**\r
+ * For Debugging\r
+ */\r
+ public String toString() {\r
+ return name + ' ' + millis() + "ms " + (size>0?Long.toString(size):"");\r
+ }\r
+ \r
+} \r
Code Review / aaf / authz.git / blobdiff