aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java
diff options
context:
space:
mode:
authorPamela Dragosh <pdragosh@research.att.com>2020-02-03 12:22:59 +0000
committerGerrit Code Review <gerrit@onap.org>2020-02-03 12:22:59 +0000
commit8d1bac4f46bde92d76468a9e89a9a4fc52562663 (patch)
tree7ba950c7d755285aa18f41029bc44f0f6eec49b8 /utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java
parent658471f126a11954b20249cbd9b0ecd97f14091e (diff)
parent4f909d754b638ab4563eb9466836cc2d7a184d63 (diff)
Merge "Add pretty() method to Coder"
Diffstat (limited to 'utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java')
-rw-r--r--utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java14
1 files changed, 12 insertions, 2 deletions
diff --git a/utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java b/utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java
index bb51f2b9..ec0e5e42 100644
--- a/utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java
+++ b/utils/src/main/java/org/onap/policy/common/utils/coder/Coder.java
@@ -1,8 +1,8 @@
/*
* ============LICENSE_START=======================================================
- * ONAP PAP
+ * ONAP
* ================================================================================
- * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2020 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.
@@ -41,6 +41,16 @@ public interface Coder {
String encode(Object object) throws CoderException;
/**
+ * Encodes an object into json, optionally making it "pretty".
+ *
+ * @param object object to be encoded
+ * @param pretty {@code true} if it should be encoded as "pretty" json, {@code false} otherwise
+ * @return a json string representing the object
+ * @throws CoderException if an error occurs
+ */
+ String encode(Object object, boolean pretty) throws CoderException;
+
+ /**
* Encodes an object into json, writing to the given target.
*
* @param target target to which to write the encoded json