io.sarl.lang.core.SRESpecificDataContainer Maven / Gradle / Ivy
Show all versions of core Show documentation
/*
* $Id$
*
* SARL is an general-purpose agent programming language.
* More details on http://www.sarl.io
*
* Copyright (C) 2014-2024 SARL.io, the Original Authors and Main Authors
*
* 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 io.sarl.lang.core;
import org.eclipse.xtext.xbase.lib.Pure;
/** This class defines the protected API of an object that could contains SRE specific data.
*
* Any SRE-specific data into this object is assumed to be transient (not serializable).
*
* @author Stéphane Galland
* @version core 0.14.0 20241106-161406
* @mavengroupid io.sarl.lang
* @mavenartifactid core
* @since 0.6
*/
public abstract class SRESpecificDataContainer {
private transient volatile Object sreSpecificData;
/** Constructor.
*/
public SRESpecificDataContainer() {
//
}
/** Replies the data associated to this agent trait by the SRE.
*
* @param the type of the data.
* @param type the type of the data.
* @return the SRE-specific data.
* @since 0.5
*/
@Pure
S $getSreSpecificData(Class type) {
return type.cast(this.sreSpecificData);
}
/** Change the data associated to this agent trait by the SRE.
*
* @param data the SRE-specific data.
* @since 0.5
*/
void $setSreSpecificData(Object data) {
this.sreSpecificData = data;
}
}