plugins/org.eclipse.objectteams.otredyn/src/org/eclipse/objectteams/otredyn/bytecode/AbstractTeam.java

/**********************************************************************
 * This file is part of "Object Teams Dynamic Runtime Environment"
 * 
 * Copyright 2009, 2014 Oliver Frank and others.
 * 
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0 * 
 * Please visit http://www.eclipse.org/objectteams for updates and contact.
 * 
 * Contributors:
 *		Oliver Frank - Initial API and implementation
 *		Stephan Herrmann - Initial API and implementation
 **********************************************************************/
package org.eclipse.objectteams.otredyn.bytecode;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.objectteams.otredyn.runtime.IBinding;
import org.eclipse.objectteams.otredyn.runtime.IBoundClass;
import org.eclipse.objectteams.otredyn.runtime.IBoundTeam;
import org.eclipse.objectteams.otredyn.runtime.IClassIdentifierProvider;
import org.eclipse.objectteams.otredyn.runtime.IClassRepository;

/**
 * Represents a team class and stores the bindings this team has got.
 */
public abstract class AbstractTeam extends AbstractBoundClass implements IBoundTeam {
	/**
	 * All relevant bindings (callin and decapsulation) of this team.
	 * By internally using a TreeSet the set of bindings is naturally sorted 
	 * based on {@link Binding#compareTo(Binding)} (see there).
	 */
	private Set<IBinding> bindings;
	/**
	 * The highest perTeamAccessId that has been read from an OTSpecialAccess attribute
	 */
	private int highestAccessId;

	protected AbstractTeam(@NonNull String name, String id, ClassLoader loader) {
		super(name, id, loader);
		bindings = new TreeSet<IBinding>();
	}

	/**
	 * Adds a binding to the team.
	 * This method is intended to be called, 
	 * while parsing the bytecode
	 * @param binding
	 */
	public void addBinding(Binding binding) {
		bindings.add(binding);
	}

	public Collection<IBinding> getBindings() {
		parseBytecode();
		return bindings;
	}
	
	/**
	 * Returns the superclass of this team as AbstractTeam
	 */
	@Override
	public AbstractTeam getSuperclass() {
		return (AbstractTeam) super.getSuperclass();
	}
	
	/**
	 * Record that this team uses the given accessId.
	 * @param accessId
	 */
	public void recordAccessId(int accessId) {
		this.highestAccessId = Math.max(this.highestAccessId, accessId);
	}

	public int getHighestAccessId() {
		return highestAccessId;
	}

	/** Answer known tsub-versions of the given role. */
	private List<String> getTSubRoles(String simpleRoleName) {
		List<String> result = new ArrayList<String>();
		for (AbstractBoundClass subTeam : this.subclasses.keySet()) {
			if (!subTeam.isAnonymous())
				result.add(subTeam.getName()+'$'+simpleRoleName);
		}
		return result;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public List<IBoundClass> getTSubsOfThis(IClassRepository classRepository, IClassIdentifierProvider idProvider) {
		String name = this.getName();
		int dollar = name.lastIndexOf('$');
		if (dollar == -1)
			return Collections.emptyList();
		String teamName = name.substring(0, dollar);
		// FIXME: use the idProvider, but: we don't yet have that team class :(
		IBoundTeam myTeam = classRepository.getTeam(teamName.replace('/', '.'), teamName.replace('.', '/'), this.loader);
		List<String> tsubRoleNames = ((AbstractTeam)myTeam).getTSubRoles(name.substring(dollar+1));
		List<IBoundClass> tsubBases = new ArrayList<IBoundClass>();
		for  (String tsubRoleName : tsubRoleNames)
			tsubBases.add(classRepository.getBoundClass(tsubRoleName.replace('/', '.'), tsubRoleName.replace('.', '/'), this.loader));
		return tsubBases;
	}

	protected abstract void setBytecode(byte[] classBytes);
}