com.cognifide.slice.commons.module.ContextScopeModule Maven / Gradle / Ivy
package com.cognifide.slice.commons.module;
/*
* #%L
* Slice - Core
* $Id:$
* $HeadURL:$
* %%
* Copyright (C) 2012 Cognifide Limited
* %%
* 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.
* #L%
*/
import com.cognifide.slice.api.context.ContextScope;
import com.cognifide.slice.core.internal.provider.DirectContextScopeProvider;
import com.google.inject.AbstractModule;
import com.google.inject.Key;
// @formatter:off
/**
* @author Rafał Malinowski
* @class ScopedModule
*
* Module that allows binding classes to ContextScope with ease.
*/
// @formatter:on
public abstract class ContextScopeModule extends AbstractModule {
private final ContextScope contextScope;
/**
* Create new instance of ContextScopeModule.
*
* All classes bound by bindToContextScope() will be bound to contextScope instance.
*/
public ContextScopeModule(final ContextScope contextScope) {
this.contextScope = contextScope;
}
protected ContextScope getContextScope() {
return contextScope;
}
/**
* @param key eky to bind to ContextScope
*
* Binds class to ContextScope. Instances of binded class must be manually set in Context instance to be
* available in Injector.
*/
protected void bindToContextScope(final Key key) {
bind(key).toProvider(new DirectContextScopeProvider(contextScope, key));
}
}