org.protempa.backend.BackendSpec Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation
Show all versions of protempa-framework Show documentation
Protempa Framework is the core of Protempa.
/*
* #%L
* Protempa Framework
* %%
* Copyright (C) 2012 - 2013 Emory University
* %%
* 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%
*/
package org.protempa.backend;
import org.apache.commons.lang3.builder.ToStringBuilder;
/**
*
* @author Andrew Post
*/
public final class BackendSpec {
private static final BackendPropertySpec[] EMPTY_BACKEND_PROPERTY_SPEC_ARR = new BackendPropertySpec[0];
private BackendProvider backendProvider;
private String id;
private String displayName;
private final BackendPropertySpec[] propertySpecs;
/**
*
* @param backendProvider
* @param id a unique id, cannot have the | character.
* @param displayName
* @param propertySpecs
*/
public BackendSpec(BackendProvider backendProvider, String id,
String displayName,
BackendPropertySpec[] propertySpecs) {
if (backendProvider == null) {
throw new IllegalArgumentException("backendProvider cannot be null");
}
if (id == null) {
throw new IllegalArgumentException("id cannot be null");
}
if (id.contains("|")) {
throw new IllegalArgumentException("id cannot have the | character");
}
this.id = id;
this.backendProvider = backendProvider;
this.displayName = displayName;
if (propertySpecs != null) {
this.propertySpecs = propertySpecs.clone();
} else {
this.propertySpecs = EMPTY_BACKEND_PROPERTY_SPEC_ARR;
}
}
public String getId() {
return this.id;
}
public BackendProvider getBackendProvider() {
return this.backendProvider;
}
public String getDisplayName() {
return this.displayName;
}
public BackendPropertySpec[] getPropertySpecs() {
return this.propertySpecs.clone();
}
public BackendInstanceSpec newBackendInstanceSpec() {
return new BackendInstanceSpec<>(this);
}
@SuppressWarnings("unchecked")
B newBackendInstance() throws BackendNewInstanceException {
return (B) this.backendProvider.newInstance(id);
}
@Override
public String toString() {
return ToStringBuilder.reflectionToString(this);
}
}