core/api/src/test/java/org/apache/zest/api/service/DocumentationSupport.java

/*
 * Copyright (c) 2012, Niclas Hedhman. 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.
 */
package org.apache.zest.api.service;

import java.util.List;
import org.apache.zest.api.activation.Activators;
import org.apache.zest.api.injection.scope.Service;
import org.apache.zest.api.mixin.Mixins;
import org.apache.zest.api.service.qualifier.ServiceTags;
import org.apache.zest.bootstrap.Assembler;
import org.apache.zest.bootstrap.AssemblyException;
import org.apache.zest.bootstrap.ModuleAssembly;
import org.apache.zest.bootstrap.ServiceDeclaration;

public class DocumentationSupport
    implements Assembler
{
    // START SNIPPET: tag
    // START SNIPPET: instantiateOnStartup
    @Override
    public void assemble( ModuleAssembly module )
        throws AssemblyException
    {
        ServiceDeclaration service = module.addServices( MyDemoService.class );
        // END SNIPPET: tag
        service.instantiateOnStartup();
        // END SNIPPET: instantiateOnStartup
        // START SNIPPET: tag
        service.taggedWith( "Important", "Drain" );
        // END SNIPPET: tag
    }

    private static class MyDemoService
    {
    }

    private static class MyOtherDemoService
    {
        // START SNIPPET: UseTag
        @Service
        private List<ServiceReference<MyDemoService>> services;

        public MyDemoService locateImportantService()
        {
            for( ServiceReference<MyDemoService> ref : services )
            {
                ServiceTags serviceTags = ref.metaInfo( ServiceTags.class );
                if( serviceTags.hasTag( "Important" ) )
                {
                    return ref.get();
                }
            }
            return null;
        }
        // END SNIPPET: UseTag
    }

    // START SNIPPET: activation1
    @Mixins( MyActivationMixin.class )
    public static interface MyActivationDemoService
        extends ServiceComposite, ServiceActivation
    {
    }

    public static class MyActivationMixin
        implements ServiceActivation
    {
        @Override
        public void activateService()
            throws Exception
        {
            // Activation code
        }

        @Override
        public void passivateService()
            throws Exception
        {
            // Passivation code
        }
    }
    // END SNIPPET: activation1

    // START SNIPPET: activation2
    @Activators( MyActivator.class )
    public static interface MyOtherActivationDemoService
        extends ServiceComposite
    {
    }

    public static class MyActivator
        extends ServiceActivatorAdapter<MyOtherActivationDemoService>
    {
        @Override
        public void afterActivation( ServiceReference<MyOtherActivationDemoService> activated )
            throws Exception
        {
            // Activation code
        }

        @Override
        public void beforePassivation( ServiceReference<MyOtherActivationDemoService> passivating )
            throws Exception
        {
            // Passivation code
        }
    }
    // END SNIPPET: activation2

    static class Activation3
        implements Assembler
    {
        // START SNIPPET: activation3
        @Override
        public void assemble( ModuleAssembly module )
        {
            module.services( MyDemoService.class ).withActivators( MyActivator.class );
        }
        // END SNIPPET: activation3
    }

}