com.alanbuttars.commons.config.stub.WatchFileYamlImplStub Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-config Show documentation
Commons Config is an API which provides elegant interaction with configuration files.
The newest version!
/*
 * Copyright (C) Alan Buttars
 *
 * 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 com.alanbuttars.commons.config.stub;

import static com.alanbuttars.commons.util.validators.Arguments.verifyNonNull;

import java.io.File;
import java.io.IOException;

import com.alanbuttars.commons.config.ConfigurationYamlCollectionImpl;
import com.alanbuttars.commons.config.ConfigurationYamlImpl;
import com.alanbuttars.commons.config.eventbus.EventBus;
import com.fasterxml.jackson.core.type.TypeReference;

/**
 * Intermediate stub ultimately used to create a {@link ConfigurationYamlImpl}.
 * 
 * @author Alan Buttars
 *
 */
public class WatchFileYamlImplStub {

	protected final String sourceId;
	protected final File file;
	protected final EventBus eventBus;

	WatchFileYamlImplStub(String sourceId, File file, EventBus eventBus) {
		this.sourceId = sourceId;
		this.file = file;
		this.eventBus = eventBus;
	}

	/**
	 * Instructs the configuration object to map the contents of the YAML file to an object of the given type. For
	 * example:
	 * 
	 * 	 * ConfigurationYamlImpl<User> config = Watch.yaml("/path/to/user.yml").mappedTo(User.class);
	 * User user = config.getValue();
	 * 
	 * 
	 * @param clazz
	 *            Non-null type
	 * @throws IOException
	 *             On I/O parsing the YAML file
	 */
	public  ConfigurationYamlImpl mappedTo(Class clazz) throws IOException {
		verifyNonNull(clazz, "Clazz must be non-null");
		return new ConfigurationYamlImpl<>(sourceId, file, eventBus, clazz);
	}

	/**
	 * Instructs the configuration object to map the contents of the YAML file to an object of the given type reference.
	 * This method should be used when the JSON file contains a collection. For example:
	 * 
	 * 	 * ConfigurationYamlImpl<List<User>> config = Watch.yaml("/path/to/users.yml").mappedTo(new TypeReference<List<User>>() {
	 * });
	 * List<User> users = config.getValue();
	 * 
	 * 
	 * @param typeReference
	 *            Non-null type reference
	 * @throws IOException
	 *             On I/O parsing the YAML file
	 */
	public  ConfigurationYamlCollectionImpl mappedTo(TypeReference typeReference) throws IOException {
		verifyNonNull(typeReference, "Type reference must be non-null");
		return new ConfigurationYamlCollectionImpl<>(sourceId, file, eventBus, typeReference);
	}
}