You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2016/04/14 12:11:26 UTC
[17/31] isis git commit: ISIS-1370: deprecating EventPayload and its
implementations (EventPayloadForActionInvocation,
EventPayloadForObjectChanged).
ISIS-1370: deprecating EventPayload and its implementations (EventPayloadForActionInvocation, EventPayloadForObjectChanged).
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/ed4b76a7
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/ed4b76a7
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/ed4b76a7
Branch: refs/heads/ISIS-1291
Commit: ed4b76a7a046d744647baf5f811c8e38ece0338c
Parents: 999747e
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Tue Apr 12 19:37:14 2016 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Tue Apr 12 19:37:14 2016 +0100
----------------------------------------------------------------------
.../applib/services/publish/EventPayload.java | 21 +----
.../EventPayloadForActionInvocation.java | 83 +++++++++++++++-----
.../publish/EventPayloadForObjectChanged.java | 16 ++--
3 files changed, 76 insertions(+), 44 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/ed4b76a7/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayload.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayload.java b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayload.java
index 4dd96e1..6d03666 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayload.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayload.java
@@ -25,30 +25,15 @@ import org.apache.isis.applib.annotation.Programmatic;
/**
- * The payload of an event, representing the information to be published
- * in some canonicalized form.
- *
- * <p>
- * This should be prepared in a way that can be processed by the {@link EventSerializer}. For example:
- * <ul>
- * <li>The {@link EventSerializer.Simple simple event serializer} simply invokes
- * {@link Object#toString() toString()} on the payload. Use the {@link Default simple} implementation
- * which simply wraps a string.
- * </li>
- * <li>The <tt>RestfulObjectsSpecEventSerializer</tt> event serializer expects a pojo domain object
- * and serializes it out according to the <a href="http://restfulobject.org">Restful Objects spec</a>.
- * Use the {@link EventPayloadForActionInvocation object payload} implementation if you simply wish to reference some
- * persistent domain object.
- * </li>
- * </ul>
- *
- * @see EventMetadata
+ * @deprecated - no longer provided to {@link PublishingService#publish(EventMetadata, EventPayload)} (always <tt>null</tt>).
*/
+@Deprecated
public interface EventPayload {
/**
* Injected by Isis runtime immediately after instantiation.
*/
+ @Deprecated
@Programmatic
void withStringifier(ObjectStringifier stringifier);
http://git-wip-us.apache.org/repos/asf/isis/blob/ed4b76a7/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForActionInvocation.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForActionInvocation.java b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForActionInvocation.java
index b0f4a26..3bafb0f 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForActionInvocation.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForActionInvocation.java
@@ -23,18 +23,14 @@ import java.util.Collections;
import java.util.List;
import org.apache.isis.applib.Identifier;
-import org.apache.isis.applib.annotation.NotPersistable;
import org.apache.isis.applib.annotation.Programmatic;
/**
- * An immutable pojo that captures the information representing an
- * action invocation.
- *
- * <p>
- * This class is annotated as a domain object for the benefit of the
- * <tt>RestfulObjectsSpecEventSerializer</tt>.
+ * No longer in use.
+ *
+ * @deprecated - replaced by {@link EventPayloadForObject}.
*/
-@NotPersistable
+@Deprecated
public class EventPayloadForActionInvocation<T> implements EventPayload {
private final Identifier actionIdentifier;
@@ -53,97 +49,146 @@ public class EventPayloadForActionInvocation<T> implements EventPayload {
/**
* Injected by Isis runtime immediately after instantiation.
*/
+ @Deprecated
@Programmatic
public void withStringifier(ObjectStringifier stringifier) {
this.stringifier = stringifier;
}
+ @Deprecated
@Programmatic
public List<? extends Object> getArguments() {
return arguments;
}
+ @Deprecated
+ @Programmatic
public T getTarget() {
return target;
}
-
+
+ @Deprecated
+ @Programmatic
public String getActionName() {
return actionIdentifier.toFullIdentityString();
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg0() {
return getArg(0);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg0() {
return hideArg(0);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg1() {
return getArg(1);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg1() {
return hideArg(1);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg2() {
return getArg(2);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg2() {
return hideArg(2);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg3() {
return getArg(3);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg3() {
return hideArg(3);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg4() {
return getArg(4);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg4() {
return hideArg(4);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg5() {
return getArg(5);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg5() {
return hideArg(5);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg6() {
return getArg(6);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg6() {
return hideArg(6);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg7() {
return getArg(7);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg7() {
return hideArg(7);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg8() {
return getArg(8);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg8() {
return hideArg(8);
}
-
+
+ @Deprecated
+ @Programmatic
public Object getArg9() {
return getArg(9);
}
+ @Deprecated
+ @Programmatic
public boolean hideArg9() {
return hideArg(9);
}
+ @Deprecated
+ @Programmatic
public Object getResult() {
return result;
}
+
private Object getArg(int paramNum) {
return arguments.size()>paramNum?arguments.get(paramNum):null;
}
http://git-wip-us.apache.org/repos/asf/isis/blob/ed4b76a7/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForObjectChanged.java
----------------------------------------------------------------------
diff --git a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForObjectChanged.java b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForObjectChanged.java
index 38f9c6b..847e88d 100644
--- a/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForObjectChanged.java
+++ b/core/applib/src/main/java/org/apache/isis/applib/services/publish/EventPayloadForObjectChanged.java
@@ -19,17 +19,14 @@
package org.apache.isis.applib.services.publish;
-import org.apache.isis.applib.annotation.NotPersistable;
import org.apache.isis.applib.annotation.Programmatic;
/**
- * An immutable pojo that simply references some other (persistent) object.
- *
- * <p>
- * This class is annotated as a domain object for the benefit of the
- * <tt>RestfulObjectsSpecEventSerializer</tt>.
+ * No longer in use.
+ *
+ * @deprecated - replaced by {@link EventPayloadForObject}.
*/
-@NotPersistable
+@Deprecated
public class EventPayloadForObjectChanged<T> implements EventPayload {
private final T changed;
@@ -42,15 +39,20 @@ public class EventPayloadForObjectChanged<T> implements EventPayload {
/**
* Injected by Isis runtime immediately after instantiation.
*/
+ @Deprecated
@Programmatic
public void withStringifier(ObjectStringifier stringifier) {
this.stringifier = stringifier;
}
+ @Deprecated
+ @Programmatic
public T getChanged() {
return changed;
}
+ @Deprecated
+ @Programmatic
public String getClassName() {
if(stringifier == null) {
throw new IllegalStateException("ObjectStringifier has not been injected");