PublishingPayloadFactoryForObject.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.
 */
package org.apache.isis.applib.annotation;

import org.apache.isis.applib.services.publish.EventPayload;
import org.apache.isis.applib.services.publish.PublisherService;
import org.apache.isis.applib.services.publish.PublishingService;

/**
 * @deprecated - supports the deprecated {@link PublishingService}; use instead {@link PublisherService} (which ignores {@link DomainObject#publishingPayloadFactory()} but is otherwise more flexible.
 */
@Deprecated
public interface PublishingPayloadFactoryForObject {

    /**
     * @deprecated - because {@link PublishingService} is deprecated.
     */
    @Deprecated
    @Programmatic
    public EventPayload payloadFor(Object changedObject, PublishingChangeKind publishingChangeKind);

    /**
     * Adapter to subclass if have an existing {@link org.apache.isis.applib.annotation.PublishedObject.PayloadFactory}.
     *
     * @deprecated
     */
    @Deprecated
    public static class Adapter implements PublishingPayloadFactoryForObject {

        private final PublishedObject.PayloadFactory payloadFactory;

        /**
         * @deprecated
         */
        @Deprecated
        public Adapter(final PublishedObject.PayloadFactory payloadFactory) {
            this.payloadFactory = payloadFactory;
        }

        /**
         * @deprecated
         */
        @Deprecated
        @Override
        public EventPayload payloadFor(final Object changedObject, final PublishingChangeKind publishingChangeKind) {
            return payloadFactory.payloadFor(changedObject, PublishingChangeKind.from(publishingChangeKind));
        }

        /**
         * @deprecated
         */
        @Deprecated
        public PublishedObject.PayloadFactory getPayloadFactory() {
            return payloadFactory;
        }
    }
}