lang
stringclasses 2
values | license
stringclasses 13
values | stderr
stringlengths 0
343
| commit
stringlengths 40
40
| returncode
int64 0
128
| repos
stringlengths 6
87.7k
| new_contents
stringlengths 0
6.23M
| new_file
stringlengths 3
311
| old_contents
stringlengths 0
6.23M
| message
stringlengths 6
9.1k
| old_file
stringlengths 3
311
| subject
stringlengths 0
4k
| git_diff
stringlengths 0
6.31M
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
Java | apache-2.0 | 971941f55832969cec8e88a2b773ffa3c818e1c7 | 0 | dylanht/titan,CYPP/titan,amcp/titan,jamestyack/titan,jankotek/titan,elubow/titan,evanv/titan,wangbf/titan,xlcupid/titan,amcp/titan,samanalysis/titan,anvie/titan,qiuqiyuan/titan,fengshao0907/titan,tomersagi/titan,mbrukman/titan,mbrukman/titan,qiuqiyuan/titan,kangkot/titan,anvie/titan,kangkot/titan,wangbf/titan,kalatestimine/titan,anuragkh/titan,qiuqiyuan/titan,elkingtonmcb/titan,banjiewen/titan,anuragkh/titan,nvoron23/titan,anvie/titan,graben1437/titan,dylanht/titan,mwpnava/titan,anvie/titan,hortonworks/titan,thinkaurelius/titan,mwpnava/titan,anuragkh/titan,qiuqiyuan/titan,ThiagoGarciaAlves/titan,samanalysis/titan,boorad/titan,jamestyack/titan,tomersagi/titan,mwpnava/titan,elkingtonmcb/titan,mbrukman/titan,nvoron23/titan,jankotek/titan,samanalysis/titan,xlcupid/titan,thinkaurelius/titan,anuragkh/titan,infochimps-forks/titan,infochimps-forks/titan,jankotek/titan,elkingtonmcb/titan,nvoron23/titan,boorad/titan,infochimps-forks/titan,samanalysis/titan,anvie/titan,CYPP/titan,englishtown/titan,CYPP/titan,twilmes/titan,englishtown/titan,tomersagi/titan,elubow/titan,fengshao0907/titan,hortonworks/titan,pluradj/titan,ThiagoGarciaAlves/titan,jamestyack/titan,twilmes/titan,mwpnava/titan,jamestyack/titan,infochimps-forks/titan,mbrukman/titan,thinkaurelius/titan,tomersagi/titan,englishtown/titan,evanv/titan,fengshao0907/titan,hortonworks/titan,englishtown/titan,pluradj/titan,boorad/titan,banjiewen/titan,graben1437/titan,kalatestimine/titan,kangkot/titan,tomersagi/titan,kangkot/titan,evanv/titan,elubow/titan,hortonworks/titan,amcp/titan,twilmes/titan,xlcupid/titan,kalatestimine/titan,wangbf/titan,qiuqiyuan/titan,amcp/titan,graben1437/titan,wangbf/titan,xlcupid/titan,thinkaurelius/titan,ThiagoGarciaAlves/titan,fengshao0907/titan,ThiagoGarciaAlves/titan,CYPP/titan,twilmes/titan,jankotek/titan,elubow/titan,kalatestimine/titan,pluradj/titan,hortonworks/titan,twilmes/titan,banjiewen/titan,fengshao0907/titan,elkingtonmcb/titan,dylanht/titan,dylanht/titan,kangkot/titan,evanv/titan,jamestyack/titan,elkingtonmcb/titan,wangbf/titan,infochimps-forks/titan,ThiagoGarciaAlves/titan,pluradj/titan,banjiewen/titan,mwpnava/titan,kalatestimine/titan,jankotek/titan,mbrukman/titan,anuragkh/titan,boorad/titan,graben1437/titan,xlcupid/titan,evanv/titan,nvoron23/titan | package com.thinkaurelius.titan.tinkerpop.rexster;
import com.thinkaurelius.titan.core.TitanException;
import com.thinkaurelius.titan.core.TitanVertex;
import com.thinkaurelius.titan.graphdb.TitanGraphTestCommon;
import com.tinkerpop.blueprints.Vertex;
import com.tinkerpop.rexster.server.RexsterSettings;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.XMLConfiguration;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static junit.framework.Assert.*;
/**
* (c) Matthias Broecheler ([email protected])
*/
public abstract class RexsterServerClientTest extends TitanGraphTestCommon {
public final XMLConfiguration rexsterConfig;
public RexsterTitanServer server;
public RexsterTitanClient client;
public RexsterServerClientTest(Configuration config) {
super(config);
rexsterConfig = new XMLConfiguration();
}
@Before
public void setUp() throws Exception {
super.setUp();
//Populate graph
tx.createKeyIndex("name",Vertex.class);
TitanVertex v1 = tx.addVertex(), v2 = tx.addVertex(), v3=tx.addVertex();
v1.setProperty("name","v1");
v2.setProperty("name","v2");
v3.setProperty("name","v3");
tx.addEdge(v1,v2, "knows");
tx.addEdge(v1,v3,"knows");
close();
server = new RexsterTitanServer(rexsterConfig,config);
server.start();
client = new RexsterTitanClient("127.0.0.1", RexsterSettings.DEFAULT_REXPRO_PORT);
}
@After
public void tearDown() throws Exception {
client.close();
server.stop();
super.tearDown();
}
@Test
public void simpleQuerying() throws Exception {
List<Map<String,Object>> result;
// result = client.query("g.V");
// assertEquals(3,result.size());
result = client.query("g.V('name','v1').out('knows').map");
assertEquals(2,result.size());
for (Map<String,Object> map : result) {
assertTrue(map.containsKey("name"));
}
Map<String,Object> paras = new HashMap<String,Object>();
paras.put("name","v1");
result = client.query("g.V('name',name).out('knows').map",paras);
assertEquals(2,result.size());
for (Map<String,Object> map : result) {
assertTrue(map.containsKey("name"));
}
result = client.query("g.V('name','v1').out.map");
assertEquals(2,result.size());
result = client.query("g.V('name','v1').outE.map");
assertEquals(2,result.size());
try {
result = client.query("1/0");
fail();
} catch (TitanException e) {
}
}
}
| src/test/java/com/thinkaurelius/titan/tinkerpop/rexster/RexsterServerClientTest.java | package com.thinkaurelius.titan.tinkerpop.rexster;
import com.thinkaurelius.titan.core.TitanException;
import com.thinkaurelius.titan.core.TitanVertex;
import com.thinkaurelius.titan.graphdb.TitanGraphTestCommon;
import com.tinkerpop.blueprints.Vertex;
import com.tinkerpop.rexster.server.RexsterSettings;
import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.XMLConfiguration;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import java.util.List;
import java.util.Map;
import static junit.framework.Assert.*;
/**
* (c) Matthias Broecheler ([email protected])
*/
public abstract class RexsterServerClientTest extends TitanGraphTestCommon {
public final XMLConfiguration rexsterConfig;
public RexsterTitanServer server;
public RexsterTitanClient client;
public RexsterServerClientTest(Configuration config) {
super(config);
rexsterConfig = new XMLConfiguration();
}
@Before
public void setUp() throws Exception {
super.setUp();
//Populate graph
tx.createKeyIndex("name",Vertex.class);
TitanVertex v1 = tx.addVertex(), v2 = tx.addVertex(), v3=tx.addVertex();
v1.setProperty("name","v1");
v2.setProperty("name","v2");
v3.setProperty("name","v3");
tx.addEdge(v1,v2, "knows");
tx.addEdge(v1,v3,"knows");
close();
server = new RexsterTitanServer(rexsterConfig,config);
server.start();
client = new RexsterTitanClient("127.0.0.1", RexsterSettings.DEFAULT_REXPRO_PORT);
}
@After
public void tearDown() throws Exception {
client.close();
server.stop();
super.tearDown();
}
@Test
public void simpleQuerying() throws Exception {
List<Map<String,Object>> result;
// result = client.query("g.V");
// assertEquals(3,result.size());
result = client.query("g.V('name','v1').out('knows').map");
assertEquals(2,result.size());
for (Map<String,Object> map : result) {
assertTrue(map.containsKey("name"));
}
result = client.query("g.V('name','v1').out.map");
assertEquals(2,result.size());
result = client.query("g.V('name','v1').outE.map");
assertEquals(2,result.size());
try {
result = client.query("1/0");
fail();
} catch (TitanException e) {
}
}
}
| Extended the client test case to use parameters
| src/test/java/com/thinkaurelius/titan/tinkerpop/rexster/RexsterServerClientTest.java | Extended the client test case to use parameters | <ide><path>rc/test/java/com/thinkaurelius/titan/tinkerpop/rexster/RexsterServerClientTest.java
<ide> import org.junit.Before;
<ide> import org.junit.Test;
<ide>
<add>import java.util.HashMap;
<ide> import java.util.List;
<ide> import java.util.Map;
<ide>
<ide> for (Map<String,Object> map : result) {
<ide> assertTrue(map.containsKey("name"));
<ide> }
<add> Map<String,Object> paras = new HashMap<String,Object>();
<add> paras.put("name","v1");
<add> result = client.query("g.V('name',name).out('knows').map",paras);
<add> assertEquals(2,result.size());
<add> for (Map<String,Object> map : result) {
<add> assertTrue(map.containsKey("name"));
<add> }
<ide> result = client.query("g.V('name','v1').out.map");
<ide> assertEquals(2,result.size());
<ide> result = client.query("g.V('name','v1').outE.map"); |
|
Java | mit | 2a6dd06623758de9b0d3d8c16e2324c0878fa577 | 0 | mcasperson/IridiumApplicationTesting,mcasperson/IridiumApplicationTesting,mcasperson/IridiumApplicationTesting | package au.com.agic.apptesting.utils.impl;
import au.com.agic.apptesting.constants.Constants;
import au.com.agic.apptesting.exception.ConfigurationException;
import au.com.agic.apptesting.exception.DriverException;
import au.com.agic.apptesting.profiles.FileProfileAccess;
import au.com.agic.apptesting.profiles.configuration.Configuration;
import au.com.agic.apptesting.profiles.configuration.UrlMapping;
import au.com.agic.apptesting.utils.FeatureState;
import au.com.agic.apptesting.utils.ProxyDetails;
import au.com.agic.apptesting.utils.SystemPropertyUtils;
import au.com.agic.apptesting.utils.ThreadWebDriverMap;
import org.apache.commons.lang3.StringUtils;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.validation.constraints.NotNull;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;
import static com.google.common.base.Preconditions.checkArgument;
public class RemoteThreadWebDriverMapImpl implements ThreadWebDriverMap {
/**
* The end of the URL we use to connect remotely to browserstack
*/
private static final String URL = "@hub.browserstack.com/wd/hub";
private static final Logger LOGGER = LoggerFactory.getLogger(RemoteThreadWebDriverMapImpl.class);
private static final SystemPropertyUtils SYSTEM_PROPERTY_UTILS = new SystemPropertyUtilsImpl();
private static final FileProfileAccess<Configuration> PROFILE_ACCESS = new FileProfileAccess<>(
SYSTEM_PROPERTY_UTILS.getProperty(Constants.CONFIGURATION),
Configuration.class);
/**
* The mapping between thread ids and the webdrivers that they use for the tests
*/
private final Map<String, FeatureState> threadIdToCapMap = new HashMap<>();
/**
* The mapping between thread ids and the webdrivers that they use for the tests
*/
private final Map<String, WebDriver> threadIdToDriverMap = new HashMap<>();
/**
* The browser stack username loaded from configuration
*/
private String browserStackUsername;
/**
* The browser stack access token loaded from configuration
*/
private String browserStackAccessToken;
/**
* The index of the data set we are going to be testing
*/
private int currentDataset;
/**
* The index of the Url we are going to be testing
*/
private int currentUrl;
/**
* The index of the capability we are going to be testing
*/
private int currentCapability;
/**
* The original list of configurations
*/
private List<DesiredCapabilities> originalDesiredCapabilities;
/**
* The list of URLs associated with the application we are testing
*/
private List<UrlMapping> originalApplicationUrls;
/**
* The values that can be input into the app
*/
private Map<Integer, Map<String, String>> originalDataSets;
private String reportDirectory;
public RemoteThreadWebDriverMapImpl() {
loadBrowserStackSettings();
}
/**
* Load the browserstack details from configuration
*/
private void loadBrowserStackSettings() {
/*
System properties take precedence
*/
if (!loadDetailsFromSysProps()) {
/*
Fall back to using the info in the profile
*/
if (!loadDetailsFromProfile()) {
/*
Log an error because there were no details
*/
LOGGER.error("Could not load browserstack config");
}
}
}
private boolean loadDetailsFromProfile() {
final Optional<Configuration> profile = PROFILE_ACCESS.getProfile();
if (profile.isPresent()) {
browserStackUsername = profile.get().getBrowserstack().getUsername();
browserStackAccessToken = profile.get().getBrowserstack().getAccessToken();
return true;
}
return false;
}
private boolean loadDetailsFromSysProps() {
final Optional<String> borwserStackUsername =
Optional.ofNullable(SYSTEM_PROPERTY_UTILS.getPropertyEmptyAsNull(Constants.BROWSER_STACK_USERNAME));
final Optional<String> borwserStackAccessToken =
Optional.ofNullable(SYSTEM_PROPERTY_UTILS.getPropertyEmptyAsNull(Constants.BROWSER_STACK_ACCESS_TOKEN));
if (borwserStackUsername.isPresent() && borwserStackAccessToken.isPresent()) {
browserStackUsername = borwserStackUsername.get();
browserStackAccessToken = borwserStackAccessToken.get();
return true;
}
return false;
}
@Override
public void initialise(
@NotNull final List<DesiredCapabilities> desiredCapabilities,
@NotNull final List<UrlMapping> applicationUrls,
@NotNull final Map<Integer, Map<String, String>> datasets,
@NotNull final String myReportDirectory,
@NotNull final List<File> myTempFolders,
@NotNull final List<ProxyDetails<?>> myProxies) {
originalDesiredCapabilities = new ArrayList<>(desiredCapabilities);
originalApplicationUrls = new ArrayList<>(applicationUrls);
originalDataSets = new HashMap<>(datasets);
reportDirectory = myReportDirectory;
/*
myProxyPort is ignored, because we can't setup proxies when running in browserstack
*/
}
@NotNull
@Override
public synchronized FeatureState getDesiredCapabilitiesForThread(@NotNull final String name) {
try {
/*
Return the previous generated details if they exist
*/
if (threadIdToCapMap.containsKey(name)) {
return threadIdToCapMap.get(name);
}
/*
Some validation checking
*/
if (originalDesiredCapabilities.isEmpty()) {
throw new ConfigurationException("There are no desired capabilities defined. "
+ "Check the configuration profiles have the required information in them");
}
/*
We have allocated our available configurations
*/
final int urlCount = Math.max(originalApplicationUrls.size(), 1);
if (currentUrl >= urlCount) {
throw new ConfigurationException("Configuration pool has been exhausted!");
}
/*
Get the details that the requesting thread will need
*/
final DesiredCapabilities desiredCapabilities =
originalDesiredCapabilities.get(currentCapability);
final UrlMapping url = originalApplicationUrls.get(currentUrl);
final Map<String, String> dataSet = originalDataSets.containsKey(currentDataset)
? new HashMap<>(originalDataSets.get(currentDataset)) : new HashMap<>();
/*
Tick over to the next url when all the capabilities have been consumed
*/
++currentCapability;
if (currentCapability >= originalDesiredCapabilities.size()) {
++currentDataset;
if (currentDataset >= getMaxDataSets()) {
currentDataset = 0;
currentCapability = 0;
++currentUrl;
}
}
/*
Associate the new details with the thread
*/
final String remoteAddress =
"http://" + browserStackUsername + ":" + browserStackAccessToken + URL;
final WebDriver webDriver = new RemoteWebDriver(new URL(remoteAddress), desiredCapabilities);
threadIdToDriverMap.put(name, webDriver);
final FeatureState featureState = new FeatureStateImpl(
url, dataSet, reportDirectory, new ArrayList<>());
threadIdToCapMap.put(name, featureState);
return featureState;
} catch (final MalformedURLException ex) {
/*
This shouldn't happen
*/
throw new ConfigurationException(
"The url that was built to contact BrowserStack was invalid", ex);
}
}
@NotNull
public synchronized WebDriver getWebDriverForThread(@NotNull final String name, final boolean createIfMissing) {
checkArgument(StringUtils.isNotEmpty(name));
if (threadIdToDriverMap.containsKey(name)) {
return threadIdToDriverMap.get(name);
}
throw new DriverException("Could not find the web driver for the thread " + name);
}
@Override
public synchronized void clearWebDriverForThread(@NotNull final String name, final boolean quitDriver) {
checkArgument(StringUtils.isNotEmpty(name));
if (threadIdToDriverMap.containsKey(name)) {
if (quitDriver) {
threadIdToDriverMap.get(name).quit();
}
threadIdToDriverMap.remove(name);
}
}
@Override
public synchronized int getNumberCapabilities() {
/*
Each application is run against each capability
*/
return originalDesiredCapabilities.size()
* Math.max(1, originalApplicationUrls.size())
* Math.max(1, getMaxDataSets());
}
@Override
public List<File> getTempFolders() {
return null;
}
private Integer getMaxDataSets() {
try {
final String maxDataSets = SYSTEM_PROPERTY_UTILS.getProperty(
Constants.NUMBER_DATA_SETS_SYSTEM_PROPERTY);
if (StringUtils.isNotBlank(maxDataSets)) {
final Integer maxDataSetsNumber = Integer.parseInt(
SYSTEM_PROPERTY_UTILS.getProperty(Constants.NUMBER_DATA_SETS_SYSTEM_PROPERTY));
return Math.min(originalDataSets.size(), maxDataSetsNumber);
}
} catch (final NumberFormatException ignored) {
/*
Invalid input that we ignore
*/
}
return originalDataSets.size();
}
@Override
public synchronized void shutdown() {
for (final WebDriver webDriver : threadIdToDriverMap.values()) {
try {
webDriver.quit();
} catch (final Exception ignored) {
// do nothing and continue closing the other webdrivers
}
}
/*
Clear the map
*/
threadIdToCapMap.clear();
/*
Reset the list of available configurations
*/
currentCapability = 0;
currentUrl = 0;
}
@Override
public synchronized void shutdown(@NotNull final String name) {
checkArgument(StringUtils.isNotBlank(name));
if (threadIdToCapMap.containsKey(name)) {
threadIdToCapMap.remove(name);
}
if (threadIdToDriverMap.containsKey(name)) {
try {
threadIdToDriverMap.get(name).quit();
} catch (final Exception ignored) {
// do nothing and continue closing the other webdrivers
}
}
}
}
| src/main/java/au/com/agic/apptesting/utils/impl/RemoteThreadWebDriverMapImpl.java | package au.com.agic.apptesting.utils.impl;
import au.com.agic.apptesting.constants.Constants;
import au.com.agic.apptesting.exception.ConfigurationException;
import au.com.agic.apptesting.exception.DriverException;
import au.com.agic.apptesting.profiles.FileProfileAccess;
import au.com.agic.apptesting.profiles.configuration.Configuration;
import au.com.agic.apptesting.profiles.configuration.UrlMapping;
import au.com.agic.apptesting.utils.FeatureState;
import au.com.agic.apptesting.utils.ProxyDetails;
import au.com.agic.apptesting.utils.SystemPropertyUtils;
import au.com.agic.apptesting.utils.ThreadWebDriverMap;
import org.apache.commons.lang3.StringUtils;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.validation.constraints.NotNull;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;
import static com.google.common.base.Preconditions.checkArgument;
public class RemoteThreadWebDriverMapImpl implements ThreadWebDriverMap {
/**
* The end of the URL we use to connect remotely to browserstack
*/
private static final String URL = "@hub.browserstack.com/wd/hub";
private static final Logger LOGGER = LoggerFactory.getLogger(RemoteThreadWebDriverMapImpl.class);
private static final SystemPropertyUtils SYSTEM_PROPERTY_UTILS = new SystemPropertyUtilsImpl();
private static final FileProfileAccess<Configuration> PROFILE_ACCESS = new FileProfileAccess<>(
SYSTEM_PROPERTY_UTILS.getProperty(Constants.CONFIGURATION),
Configuration.class);
/**
* The mapping between thread ids and the webdrivers that they use for the tests
*/
private final Map<String, FeatureState> threadIdToCapMap = new HashMap<>();
/**
* The mapping between thread ids and the webdrivers that they use for the tests
*/
private final Map<String, WebDriver> threadIdToDriverMap = new HashMap<>();
/**
* The browser stack username loaded from configuration
*/
private String browserStackUsername;
/**
* The browser stack access token loaded from configuration
*/
private String browserStackAccessToken;
/**
* The index of the data set we are going to be testing
*/
private int currentDataset;
/**
* The index of the Url we are going to be testing
*/
private int currentUrl;
/**
* The index of the capability we are going to be testing
*/
private int currentCapability;
/**
* The original list of configurations
*/
private List<DesiredCapabilities> originalDesiredCapabilities;
/**
* The list of URLs associated with the application we are testing
*/
private List<UrlMapping> originalApplicationUrls;
/**
* The values that can be input into the app
*/
private Map<Integer, Map<String, String>> originalDataSets;
private String reportDirectory;
public RemoteThreadWebDriverMapImpl() {
loadBrowserStackSettings();
}
/**
* Load the browserstack details from configuration
*/
private void loadBrowserStackSettings() {
/*
System properties take precedence
*/
if (!loadDetailsFromSysProps()) {
/*
Fall back to using the info in the profile
*/
if (!loadDetailsFromProfile()) {
/*
Log an error because there were no details
*/
LOGGER.error("Could not load browserstack config");
}
}
}
private boolean loadDetailsFromProfile() {
final Optional<Configuration> profile = PROFILE_ACCESS.getProfile();
if (profile.isPresent()) {
browserStackUsername = profile.get().getBrowserstack().getUsername();
browserStackAccessToken = profile.get().getBrowserstack().getAccessToken();
return true;
}
return false;
}
private boolean loadDetailsFromSysProps() {
final Optional<String> borwserStackUsername =
Optional.ofNullable(SYSTEM_PROPERTY_UTILS.getPropertyEmptyAsNull(Constants.BROWSER_STACK_USERNAME));
final Optional<String> borwserStackAccessToken =
Optional.ofNullable(SYSTEM_PROPERTY_UTILS.getPropertyEmptyAsNull(Constants.BROWSER_STACK_ACCESS_TOKEN));
if (borwserStackUsername.isPresent() && borwserStackAccessToken.isPresent()) {
browserStackUsername = borwserStackUsername.get();
browserStackAccessToken = borwserStackAccessToken.get();
return true;
}
return false;
}
@Override
public void initialise(
@NotNull final List<DesiredCapabilities> desiredCapabilities,
@NotNull final List<UrlMapping> applicationUrls,
@NotNull final Map<Integer, Map<String, String>> datasets,
@NotNull final String myReportDirectory,
@NotNull final List<File> myTempFolders,
@NotNull final List<ProxyDetails<?>> myProxies) {
originalDesiredCapabilities = new ArrayList<>(desiredCapabilities);
originalApplicationUrls = new ArrayList<>(applicationUrls);
originalDataSets = new HashMap<>(datasets);
reportDirectory = myReportDirectory;
/*
myProxyPort is ignored, because we can setup proxys when running in browserstack
*/
}
@NotNull
@Override
public synchronized FeatureState getDesiredCapabilitiesForThread(@NotNull final String name) {
try {
if (threadIdToCapMap.containsKey(name)) {
return threadIdToCapMap.get(name);
}
/*
Some validation checking
*/
if (originalDesiredCapabilities.isEmpty()) {
throw new ConfigurationException("There are no desired capabilities defined. "
+ "Check the configuration profiles have the required information in them");
}
/*
We have allocated our available configurations
*/
final int urlCount = Math.max(originalApplicationUrls.size(), 1);
if (currentUrl >= urlCount) {
throw new ConfigurationException("Configuration pool has been exhausted!");
}
/*
Get the details that the requesting thread will need
*/
final DesiredCapabilities desiredCapabilities =
originalDesiredCapabilities.get(currentCapability);
final UrlMapping url = originalApplicationUrls.get(currentUrl);
final Map<String, String> dataSet = originalDataSets.containsKey(currentDataset)
? new HashMap<>(originalDataSets.get(currentDataset)) : new HashMap<>();
/*
Tick over to the next url when all the capabilities have been consumed
*/
++currentCapability;
if (currentCapability >= originalDesiredCapabilities.size()) {
++currentDataset;
if (currentDataset >= getMaxDataSets()) {
currentDataset = 0;
currentCapability = 0;
++currentUrl;
}
}
/*
Associate the new details with the thread
*/
final String remoteAddress =
"http://" + browserStackUsername + ":" + browserStackAccessToken + URL;
final WebDriver webDriver = new RemoteWebDriver(new URL(remoteAddress), desiredCapabilities);
threadIdToDriverMap.put(name, webDriver);
final FeatureState featureState = new FeatureStateImpl(
url, dataSet, reportDirectory, new ArrayList<>());
threadIdToCapMap.put(name, featureState);
return featureState;
} catch (final MalformedURLException ex) {
/*
This shouldn't happen
*/
throw new ConfigurationException(
"The url that was built to contact BrowserStack was invalid", ex);
}
}
@NotNull
public synchronized WebDriver getWebDriverForThread(@NotNull final String name, final boolean createIfMissing) {
checkArgument(StringUtils.isNotEmpty(name));
if (threadIdToDriverMap.containsKey(name)) {
return threadIdToDriverMap.get(name);
}
throw new DriverException("Could not find the web driver for the thread " + name);
}
@Override
public synchronized void clearWebDriverForThread(@NotNull final String name, final boolean quitDriver) {
checkArgument(StringUtils.isNotEmpty(name));
if (threadIdToDriverMap.containsKey(name)) {
if (quitDriver) {
threadIdToDriverMap.get(name).quit();
}
threadIdToDriverMap.remove(name);
}
}
@Override
public synchronized int getNumberCapabilities() {
/*
Each application is run against each capability
*/
return originalDesiredCapabilities.size()
* Math.max(1, originalApplicationUrls.size())
* Math.max(1, getMaxDataSets());
}
@Override
public List<File> getTempFolders() {
return null;
}
private Integer getMaxDataSets() {
try {
final String maxDataSets = SYSTEM_PROPERTY_UTILS.getProperty(
Constants.NUMBER_DATA_SETS_SYSTEM_PROPERTY);
if (StringUtils.isNotBlank(maxDataSets)) {
final Integer maxDataSetsNumber = Integer.parseInt(
SYSTEM_PROPERTY_UTILS.getProperty(Constants.NUMBER_DATA_SETS_SYSTEM_PROPERTY));
return Math.min(originalDataSets.size(), maxDataSetsNumber);
}
} catch (final NumberFormatException ignored) {
/*
Invalid input that we ignore
*/
}
return originalDataSets.size();
}
@Override
public synchronized void shutdown() {
for (final WebDriver webDriver : threadIdToDriverMap.values()) {
try {
webDriver.quit();
} catch (final Exception ignored) {
// do nothing and continue closing the other webdrivers
}
}
/*
Clear the map
*/
threadIdToCapMap.clear();
/*
Reset the list of available configurations
*/
currentCapability = 0;
currentUrl = 0;
}
@Override
public synchronized void shutdown(@NotNull final String name) {
checkArgument(StringUtils.isNotBlank(name));
if (threadIdToCapMap.containsKey(name)) {
threadIdToCapMap.remove(name);
}
if (threadIdToDriverMap.containsKey(name)) {
try {
threadIdToDriverMap.get(name).quit();
} catch (final Exception ignored) {
// do nothing and continue closing the other webdrivers
}
}
}
}
| Added some comments
| src/main/java/au/com/agic/apptesting/utils/impl/RemoteThreadWebDriverMapImpl.java | Added some comments | <ide><path>rc/main/java/au/com/agic/apptesting/utils/impl/RemoteThreadWebDriverMapImpl.java
<ide> reportDirectory = myReportDirectory;
<ide>
<ide> /*
<del> myProxyPort is ignored, because we can setup proxys when running in browserstack
<add> myProxyPort is ignored, because we can't setup proxies when running in browserstack
<ide> */
<ide> }
<ide>
<ide> @Override
<ide> public synchronized FeatureState getDesiredCapabilitiesForThread(@NotNull final String name) {
<ide> try {
<add> /*
<add> Return the previous generated details if they exist
<add> */
<ide> if (threadIdToCapMap.containsKey(name)) {
<ide> return threadIdToCapMap.get(name);
<ide> } |
|
JavaScript | mit | 1bde0f3555c22b5f96757c16a8dca84909d902b9 | 0 | siudev/chat-service | #!/bin/env node
var PORT = 5015;
var server = require("http").createServer(),
io = require('socket.io').listen(server, {"log level" : 1});
server.listen(PORT, function(){
console.log("Chat server is listening on " + server.address().address + ":" + server.address().port);
});
server.on('error', function(e) {
if (e.code == 'EADDRINUSE') {
console.log('Chat server port is already used.');
process.exit(1);
}
});
var conn_count = 0;
var dicSocketName = {};
io.sockets.on('connection', function(socket) {
socket.on('req_login', function(data) {
login(socket, data.name);
});
socket.on('req_chat', function(data) {
chat(socket, data.message);
});
socket.on('req_logout', function(data) {
logout(socket);
});
socket.on('disconnect', function() {
logout(socket);
});
});
var login = function(socket, name) {
if(dicSocketName[socket.id] != null) {
return;
}
dicSocketName[socket.id] = { name:name };
conn_count++;
io.sockets.emit('ntf_login', { name:name });
socket.emit('res_login', { name:name });
console.log(name + ' has been connected. currently ' + conn_count + ' users are online.');
}
var logout = function(socket) {
if(dicSocketName[socket.id] == null) {
return;
}
var name = dicSocketName[socket.id].name;
dicSocketName[socket.id] = null;
conn_count--;
io.sockets.emit('ntf_logout', { name:name });
console.log(name + ' has been disconnected.');
}
var chat = function(socket, message) {
if(dicSocketName[socket.id] == null) {
return;
}
var name = dicSocketName[socket.id].name;
io.sockets.emit('ntf_chat', { name:name, message:message });
console.log('transmitted message \'' + name + ': ' + message + '\'');
}
| server/chat-server.js | #!/bin/env node
var PORT = 5015;
var server = require("http").createServer(),
io = require('socket.io').listen(server, {"log level" : 1});
server.listen(PORT, function(){
console.log("Chat server is listening on " + server.address().address + ":" + server.address().port);
});
server.on('error', function(e) {
if (e.code == 'EADDRINUSE') {
console.log('Chat server port is already used.');
process.exit(1);
}
});
var conn_count = 0;
io.sockets.on('connection', function(socket) {
socket.on('req_login', function(data) {
conn_count++;
login(socket, data.name);
});
socket.on('req_chat', function(data) {
chat(socket, data.name, data.message);
});
socket.on('req_logout', function(data) {
conn_count--;
logout(socket, data.name);
});
});
var login = function(socket, name) {
io.sockets.emit('ntf_login', { name:name });
socket.emit('res_login', { name:name });
console.log(name + ' has been connected. currently ' + conn_count + ' users are online.');
}
var logout = function(socket, name) {
io.sockets.emit('ntf_logout', { name:name });
console.log(name + ' has been disconnected.');
}
var chat = function(socket, name, message) {
io.sockets.emit('ntf_chat', { name:name, message:message });
console.log('transmitted message \'' + name + ': ' + message + '\'');
}
| Socket disconection bacame noticeable to the server now
| server/chat-server.js | Socket disconection bacame noticeable to the server now | <ide><path>erver/chat-server.js
<ide>
<ide>
<ide> var conn_count = 0;
<add>var dicSocketName = {};
<ide>
<ide> io.sockets.on('connection', function(socket) {
<ide> socket.on('req_login', function(data) {
<del> conn_count++;
<ide> login(socket, data.name);
<ide> });
<ide>
<ide> socket.on('req_chat', function(data) {
<del> chat(socket, data.name, data.message);
<add> chat(socket, data.message);
<ide> });
<ide>
<ide> socket.on('req_logout', function(data) {
<del> conn_count--;
<del> logout(socket, data.name);
<add> logout(socket);
<add> });
<add> socket.on('disconnect', function() {
<add> logout(socket);
<ide> });
<ide> });
<ide>
<ide> var login = function(socket, name) {
<add> if(dicSocketName[socket.id] != null) {
<add> return;
<add> }
<add> dicSocketName[socket.id] = { name:name };
<add> conn_count++;
<add>
<ide> io.sockets.emit('ntf_login', { name:name });
<ide> socket.emit('res_login', { name:name });
<ide> console.log(name + ' has been connected. currently ' + conn_count + ' users are online.');
<ide> }
<ide>
<del>var logout = function(socket, name) {
<add>var logout = function(socket) {
<add> if(dicSocketName[socket.id] == null) {
<add> return;
<add> }
<add> var name = dicSocketName[socket.id].name;
<add> dicSocketName[socket.id] = null;
<add> conn_count--;
<add>
<ide> io.sockets.emit('ntf_logout', { name:name });
<ide> console.log(name + ' has been disconnected.');
<ide> }
<ide>
<del>var chat = function(socket, name, message) {
<add>var chat = function(socket, message) {
<add> if(dicSocketName[socket.id] == null) {
<add> return;
<add> }
<add> var name = dicSocketName[socket.id].name;
<add>
<ide> io.sockets.emit('ntf_chat', { name:name, message:message });
<ide> console.log('transmitted message \'' + name + ': ' + message + '\'');
<ide> } |
|
JavaScript | mit | c44e4e80c21e985b7a55266188ce5e552de7eeee | 0 | chuckrector/mappo,chuckrector/mappo,chuckrector/mappo | "use strict"
const expect = require(`expect`)
const deepFreeze = require(`deep-freeze`)
const filler = require(`../filler`)
const {createStore} = require(`redux`)
const mappoApp = require(`./mappoApp`)
{
// can set map
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP`, map: {tileLayers: []}})
expect(store.getState().map).toEqual({tileLayers: []})
}
{
// setting map marks tileset image bitmap as needing rebuilt
const store = createStore(mappoApp)
expect(store.getState().isDirtyTilesetImageBitmap).toBe(undefined)
store.dispatch({type: `SET_MAP`, map: {tileLayers: []}})
expect(store.getState().isDirtyTilesetImageBitmap).toBe(true)
}
{
// can mark tileset image bitmap as built
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP`, map: {}})
store.dispatch({type: `BUILT_TILESET_IMAGE_BITMAP`})
expect(store.getState().isDirtyTilesetImageBitmap).toBe(false)
}
{
// SET_MAP holds a direct reference to the map
const store = createStore(mappoApp)
const map = {tileLayers: []}
store.dispatch({type: `SET_MAP`, map})
expect(store.getState().map).toBe(map)
}
{
// can plot a tile
const store = createStore(mappoApp)
const tileLayers = [{width: 2, height: 2, tileIndexGrid: filler(2 * 2, 77)}]
deepFreeze(tileLayers)
store.dispatch({type: `SET_MAP`, map: {tileLayers}})
expect(store.getState().map.tileLayers[0].tileIndexGrid).toEqual(filler(2 * 2, 77))
const plotInfo = {
x: 0,
y: 1,
tileLayerIndex: 0,
tileLayers,
tileIndexToPlot: 99,
}
store.dispatch(Object.assign({type: `PLOT_TILE`}, plotInfo))
expect(store.getState().map.tileLayers[0].tileIndexGrid).toEqual([77, 77, 99, 77])
const {plotHistory, undoIndex} = store.getState().plots
expect(plotHistory[undoIndex - 1]).toEqual({
x: 0,
y: 1,
l: 0,
v: 99,
o: 77,
})
expect(store.getState().isMapDirty).toBe(true)
}
{
// can set editor window size
const store = createStore(mappoApp)
store.dispatch({type: `SET_EDITOR_WINDOW_SIZE`, width: 200, height: 300})
expect(store.getState().editor.width).toEqual(200)
expect(store.getState().editor.height).toEqual(300)
}
{
// can set map dirty state
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP_DIRTY`, isMapDirty: true})
expect(store.getState().isMapDirty).toEqual(true)
store.dispatch({type: `SET_MAP_DIRTY`, isMapDirty: false})
expect(store.getState().isMapDirty).toEqual(false)
}
| src/reducers/mappoApp.test.js | "use strict"
const expect = require(`expect`)
const deepFreeze = require(`deep-freeze`)
const filler = require(`../filler`)
const {createStore} = require(`redux`)
const mappoApp = require(`./mappoApp`)
{
// can set map
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP`, map: {tileLayers: []}})
expect(store.getState().map).toEqual({tileLayers: []})
}
{
// setting map marks tileset image bitmap as needing rebuilt
const store = createStore(mappoApp)
expect(store.getState().isDirtyTilesetImageBitmap).toBe(undefined)
store.dispatch({type: `SET_MAP`, map: {tileLayers: []}})
expect(store.getState().isDirtyTilesetImageBitmap).toBe(true)
}
{
// can mark tileset image bitmap as built
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP`, map: {}})
store.dispatch({type: `BUILT_TILESET_IMAGE_BITMAP`})
expect(store.getState().isDirtyTilesetImageBitmap).toBe(false)
}
{
// SET_MAP holds a direct reference to the map
const store = createStore(mappoApp)
const map = {tileLayers: []}
store.dispatch({type: `SET_MAP`, map})
expect(store.getState().map).toBe(map)
}
{
// can plot a tile
const store = createStore(mappoApp)
const tileLayers = [{width: 2, height: 2, tileIndexGrid: filler(2 * 2, 77)}]
deepFreeze(tileLayers)
store.dispatch({type: `SET_MAP`, map: {tileLayers}})
expect(store.getState().map.tileLayers[0].tileIndexGrid).toEqual(filler(2 * 2, 77))
const plotInfo = {
x: 0,
y: 1,
tileLayerIndex: 0,
tileLayers,
tileIndexToPlot: 99,
}
store.dispatch(Object.assign({type: `PLOT_TILE`}, plotInfo))
expect(store.getState().map.tileLayers[0].tileIndexGrid).toEqual([77, 77, 99, 77])
const {plotHistory, undoIndex} = store.getState().plots
expect(plotHistory[undoIndex - 1]).toEqual({
x: 0,
y: 1,
l: 0,
v: 99,
o: 77,
})
expect(store.getState().isMapDirty).toBe(true)
}
{
// can set editor window size
const store = createStore(mappoApp)
store.dispatch({type: `SET_EDITOR_WINDOW_SIZE`, width: 200, height: 300})
expect(store.getState().editor.width).toEqual(200)
expect(store.getState().editor.height).toEqual(300)
}
{
// can load state
const store = createStore(mappoApp)
store.dispatch({type: `RELOAD_STORE`, state: {herp: `derp`}})
expect(store.getState().herp).toEqual(`derp`)
}
{
// can set map dirty state
const store = createStore(mappoApp)
store.dispatch({type: `SET_MAP_DIRTY`, isMapDirty: true})
expect(store.getState().isMapDirty).toEqual(true)
store.dispatch({type: `SET_MAP_DIRTY`, isMapDirty: false})
expect(store.getState().isMapDirty).toEqual(false)
}
| dead code
| src/reducers/mappoApp.test.js | dead code | <ide><path>rc/reducers/mappoApp.test.js
<ide> }
<ide>
<ide> {
<del> // can load state
<del> const store = createStore(mappoApp)
<del>
<del> store.dispatch({type: `RELOAD_STORE`, state: {herp: `derp`}})
<del> expect(store.getState().herp).toEqual(`derp`)
<del>}
<del>
<del>{
<ide> // can set map dirty state
<ide> const store = createStore(mappoApp)
<ide> |
|
Java | mit | ab355a537039c0b022795846fe5677809e6ff655 | 0 | ratson/cordova-plugin-admob-free,ratson/cordova-plugin-admob-free,vintage/cordova-plugin-admob-free,vintage/cordova-plugin-admob-free | package name.ratson.cordova.admob;
import android.os.Bundle;
import android.provider.Settings;
import android.util.Log;
import android.view.View;
import android.view.ViewGroup;
import android.widget.LinearLayout;
import android.widget.RelativeLayout;
import com.google.ads.mediation.admob.AdMobAdapter;
import com.google.android.gms.ads.AdRequest;
import com.google.android.gms.ads.AdView;
import com.google.android.gms.ads.InterstitialAd;
import com.google.android.gms.common.ConnectionResult;
import com.google.android.gms.common.GoogleApiAvailability;
import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaInterface;
import org.apache.cordova.CordovaPlugin;
import org.apache.cordova.CordovaWebView;
import org.apache.cordova.PluginResult;
import org.apache.cordova.PluginResult.Status;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Iterator;
import name.ratson.cordova.admob.adlistener.BannerListener;
import name.ratson.cordova.admob.adlistener.InterstitialListener;
/**
* This class represents the native implementation for the AdMob Cordova plugin.
* This plugin can be used to request AdMob ads natively via the Google AdMob SDK.
* The Google AdMob SDK is a dependency for this plugin.
*/
public class AdMob extends CordovaPlugin {
/**
* Common tag used for logging statements.
*/
private static final String TAG = "AdMob";
private static final AdMobConfig config = new AdMobConfig();
/**
* Cordova Actions.
*/
private static final String ACTION_SET_OPTIONS = "setOptions";
private static final String ACTION_CREATE_BANNER_VIEW = "createBannerView";
private static final String ACTION_DESTROY_BANNER_VIEW = "destroyBannerView";
private static final String ACTION_REQUEST_AD = "requestAd";
private static final String ACTION_SHOW_AD = "showAd";
private static final String ACTION_CREATE_INTERSTITIAL_VIEW = "createInterstitialView";
private static final String ACTION_REQUEST_INTERSTITIAL_AD = "requestInterstitialAd";
private static final String ACTION_SHOW_INTERSTITIAL_AD = "showInterstitialAd";
private ViewGroup parentView;
private boolean bannerShow = true;
/**
* The adView to display to the user.
*/
private AdView adView;
/**
* if want banner view overlap webview, we will need this layout
*/
private RelativeLayout adViewLayout = null;
/**
* The interstitial ad to display to the user.
*/
private InterstitialAd interstitialAd;
public boolean autoShowBanner = true;
public boolean autoShowInterstitial = true;
public boolean bannerVisible = false;
private boolean isGpsAvailable = false;
@Override
public void initialize(CordovaInterface cordova, CordovaWebView webView) {
super.initialize(cordova, webView);
isGpsAvailable = (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(cordova.getActivity()) == ConnectionResult.SUCCESS);
Log.w(TAG, String.format("isGooglePlayServicesAvailable: %s", isGpsAvailable ? "true" : "false"));
}
/**
* This is the main method for the AdMob plugin. All API calls go through here.
* This method determines the action, and executes the appropriate call.
*
* @param action The action that the plugin should execute.
* @param inputs The input parameters for the action.
* @param callbackContext The callback context.
* @return A PluginResult representing the result of the provided action. A
* status of INVALID_ACTION is returned if the action is not recognized.
*/
@Override
public boolean execute(String action, JSONArray inputs, CallbackContext callbackContext) throws JSONException {
PluginResult result = null;
if (ACTION_SET_OPTIONS.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeSetOptions(options, callbackContext);
} else if (ACTION_CREATE_BANNER_VIEW.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeCreateBannerView(options, callbackContext);
} else if (ACTION_CREATE_INTERSTITIAL_VIEW.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeCreateInterstitialView(options, callbackContext);
} else if (ACTION_DESTROY_BANNER_VIEW.equals(action)) {
result = executeDestroyBannerView(callbackContext);
} else if (ACTION_REQUEST_INTERSTITIAL_AD.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeRequestInterstitialAd(options, callbackContext);
} else if (ACTION_REQUEST_AD.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeRequestAd(options, callbackContext);
} else if (ACTION_SHOW_AD.equals(action)) {
boolean show = inputs.optBoolean(0);
result = executeShowAd(show, callbackContext);
} else if (ACTION_SHOW_INTERSTITIAL_AD.equals(action)) {
boolean show = inputs.optBoolean(0);
result = executeShowInterstitialAd(show, callbackContext);
} else {
Log.d(TAG, String.format("Invalid action passed: %s", action));
result = new PluginResult(Status.INVALID_ACTION);
}
if (result != null) {
callbackContext.sendPluginResult(result);
}
return true;
}
private PluginResult executeSetOptions(JSONObject options, CallbackContext callbackContext) {
Log.w(TAG, "executeSetOptions");
config.setOptions(options);
callbackContext.success();
return null;
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the developer
* should make the requestAd call to request an ad for the banner.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private PluginResult executeCreateBannerView(JSONObject options, final CallbackContext callbackContext) {
config.setOptions(options);
autoShowBanner = config.autoShow;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (adView == null) {
adView = new AdView(cordova.getActivity());
adView.setAdUnitId(config.getBannerAdUnitId());
adView.setAdSize(config.adSize);
adView.setAdListener(new BannerListener(AdMob.this));
}
if (adView.getParent() != null) {
((ViewGroup) adView.getParent()).removeView(adView);
}
bannerVisible = false;
adView.loadAd(buildAdRequest());
//if(autoShowBanner) {
// executeShowAd(true, null);
//}
Log.w("banner", config.getBannerAdUnitId());
callbackContext.success();
}
});
return null;
}
private PluginResult executeDestroyBannerView(CallbackContext callbackContext) {
Log.w(TAG, "executeDestroyBannerView");
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (adView != null) {
ViewGroup parentView = (ViewGroup) adView.getParent();
if (parentView != null) {
parentView.removeView(adView);
}
adView.destroy();
adView = null;
}
bannerVisible = false;
delayCallback.success();
}
});
return null;
}
/**
* Parses the create interstitial view input parameters and runs the create interstitial
* view action on the UI thread. If this request is successful, the developer
* should make the requestAd call to request an ad for the banner.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private PluginResult executeCreateInterstitialView(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
autoShowInterstitial = config.autoShow;
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
clearInterstitial();
interstitialAd = new InterstitialAd(cordova.getActivity());
interstitialAd.setAdUnitId(config.getInterstitialAdUnitId());
interstitialAd.setAdListener(new InterstitialListener(AdMob.this));
Log.w("interstitial", config.getInterstitialAdUnitId());
interstitialAd.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
public void clearInterstitial() {
if (interstitialAd != null) {
interstitialAd.setAdListener(null);
interstitialAd = null;
}
}
private AdRequest buildAdRequest() {
AdRequest.Builder builder = new AdRequest.Builder();
if (config.isTesting) {
// This will request test ads on the emulator and deviceby passing this hashed device ID.
String ANDROID_ID = Settings.Secure.getString(cordova.getActivity().getContentResolver(), android.provider.Settings.Secure.ANDROID_ID);
String deviceId = md5(ANDROID_ID).toUpperCase();
builder = builder.addTestDevice(deviceId).addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
}
if (config.testDeviceList != null) {
Iterator<String> iterator = config.testDeviceList.iterator();
while (iterator.hasNext()) {
builder = builder.addTestDevice(iterator.next());
}
}
Bundle bundle = new Bundle();
bundle.putInt("cordova", 1);
if (config.adExtras != null) {
Iterator<String> it = config.adExtras.keys();
while (it.hasNext()) {
String key = it.next();
try {
bundle.putString(key, config.adExtras.get(key).toString());
} catch (JSONException exception) {
Log.w(TAG, String.format("Caught JSON Exception: %s", exception.getMessage()));
}
}
}
builder = builder.addNetworkExtrasBundle(AdMobAdapter.class, bundle);
if (config.gender != null) {
if ("male".compareToIgnoreCase(config.gender) != 0) {
builder.setGender(AdRequest.GENDER_MALE);
} else if ("female".compareToIgnoreCase(config.gender) != 0) {
builder.setGender(AdRequest.GENDER_FEMALE);
} else {
builder.setGender(AdRequest.GENDER_UNKNOWN);
}
}
if (config.location != null) {
builder.setLocation(config.location);
}
if (config.forFamily != null) {
builder.setIsDesignedForFamilies(true);
}
if (config.forChild != null) {
builder.tagForChildDirectedTreatment(true);
}
if (config.contentURL != null) {
builder.setContentUrl(config.contentURL);
}
return builder.build();
}
/**
* Parses the request ad input parameters and runs the request ad action on
* the UI thread.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
private PluginResult executeRequestAd(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
if (adView == null) {
callbackContext.error("adView is null, call createBannerView first");
return null;
}
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
adView.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
private PluginResult executeRequestInterstitialAd(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
if (adView == null) {
callbackContext.error("interstitialAd is null, call createInterstitialView first");
return null;
}
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
interstitialAd.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
/**
* Parses the show ad input parameters and runs the show ad action on
* the UI thread.
*
* @param show The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
public PluginResult executeShowAd(final boolean show, final CallbackContext callbackContext) {
bannerShow = show;
if (adView == null) {
return new PluginResult(Status.ERROR, "adView is null, call createBannerView first.");
}
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (bannerVisible == bannerShow) {
// no change
} else if (bannerShow) {
if (adView.getParent() != null) {
((ViewGroup) adView.getParent()).removeView(adView);
}
if (config.bannerOverlap) {
RelativeLayout.LayoutParams params2 = new RelativeLayout.LayoutParams(
RelativeLayout.LayoutParams.MATCH_PARENT,
RelativeLayout.LayoutParams.WRAP_CONTENT);
params2.addRule(config.bannerAtTop ? RelativeLayout.ALIGN_PARENT_TOP : RelativeLayout.ALIGN_PARENT_BOTTOM);
if (adViewLayout == null) {
adViewLayout = new RelativeLayout(cordova.getActivity());
RelativeLayout.LayoutParams params = new RelativeLayout.LayoutParams(RelativeLayout.LayoutParams.MATCH_PARENT, RelativeLayout.LayoutParams.MATCH_PARENT);
try {
((ViewGroup) (((View) webView.getClass().getMethod("getView").invoke(webView)).getParent())).addView(adViewLayout, params);
} catch (Exception e) {
((ViewGroup) webView).addView(adViewLayout, params);
}
}
adViewLayout.addView(adView, params2);
adViewLayout.bringToFront();
} else {
ViewGroup wvParentView = (ViewGroup) getWebView().getParent();
if (parentView == null) {
parentView = new LinearLayout(webView.getContext());
}
if (wvParentView != null && wvParentView != parentView) {
wvParentView.removeView(getWebView());
((LinearLayout) parentView).setOrientation(LinearLayout.VERTICAL);
parentView.setLayoutParams(new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, 0.0F));
getWebView().setLayoutParams(new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, 1.0F));
parentView.addView(getWebView());
cordova.getActivity().setContentView(parentView);
}
if (config.bannerAtTop) {
parentView.addView(adView, 0);
} else {
parentView.addView(adView);
}
parentView.bringToFront();
parentView.requestLayout();
parentView.requestFocus();
}
adView.setVisibility(View.VISIBLE);
bannerVisible = true;
} else {
adView.setVisibility(View.GONE);
bannerVisible = false;
}
if (callbackContext != null) {
callbackContext.success();
}
}
});
return null;
}
public PluginResult executeShowInterstitialAd(final boolean show, final CallbackContext callbackContext) {
if (interstitialAd == null) {
return new PluginResult(Status.ERROR, "interstitialAd is null, call createInterstitialView first.");
}
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (interstitialAd.isLoaded()) {
interstitialAd.show();
if (callbackContext != null) {
callbackContext.success();
}
} else if (!autoShowInterstitial) {
if (callbackContext != null) {
callbackContext.error("Interstital not ready yet");
}
}
}
});
return null;
}
@Override
public void onPause(boolean multitasking) {
if (adView != null) {
adView.pause();
}
super.onPause(multitasking);
}
@Override
public void onResume(boolean multitasking) {
super.onResume(multitasking);
isGpsAvailable = (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(cordova.getActivity()) == ConnectionResult.SUCCESS);
if (adView != null) {
adView.resume();
}
}
@Override
public void onDestroy() {
destroyAdView();
clearInterstitial();
if (adViewLayout != null) {
ViewGroup parentView = (ViewGroup) adViewLayout.getParent();
if (parentView != null) {
parentView.removeView(adViewLayout);
}
adViewLayout = null;
}
super.onDestroy();
}
private void destroyAdView() {
if (adView != null) {
adView.destroy();
adView = null;
}
}
private View getWebView() {
try {
return (View) webView.getClass().getMethod("getView").invoke(webView);
} catch (Exception e) {
return (View) webView;
}
}
public static final String md5(final String s) {
try {
MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
digest.update(s.getBytes());
byte messageDigest[] = digest.digest();
StringBuffer hexString = new StringBuffer();
for (int i = 0; i < messageDigest.length; i++) {
String h = Integer.toHexString(0xFF & messageDigest[i]);
while (h.length() < 2)
h = "0" + h;
hexString.append(h);
}
return hexString.toString();
} catch (NoSuchAlgorithmException e) {
}
return "";
}
}
| src/android/AdMob.java | package name.ratson.cordova.admob;
import android.os.Bundle;
import android.provider.Settings;
import android.util.Log;
import android.view.View;
import android.view.ViewGroup;
import android.widget.LinearLayout;
import android.widget.RelativeLayout;
import com.google.ads.mediation.admob.AdMobAdapter;
import com.google.android.gms.ads.AdRequest;
import com.google.android.gms.ads.AdView;
import com.google.android.gms.ads.InterstitialAd;
import com.google.android.gms.common.ConnectionResult;
import com.google.android.gms.common.GoogleApiAvailability;
import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaInterface;
import org.apache.cordova.CordovaPlugin;
import org.apache.cordova.CordovaWebView;
import org.apache.cordova.PluginResult;
import org.apache.cordova.PluginResult.Status;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Iterator;
import name.ratson.cordova.admob.adlistener.BannerListener;
import name.ratson.cordova.admob.adlistener.InterstitialListener;
/**
* This class represents the native implementation for the AdMob Cordova plugin.
* This plugin can be used to request AdMob ads natively via the Google AdMob SDK.
* The Google AdMob SDK is a dependency for this plugin.
*/
public class AdMob extends CordovaPlugin {
/**
* Common tag used for logging statements.
*/
private static final String LOGTAG = "AdMob";
private static final AdMobConfig config = new AdMobConfig();
/**
* Cordova Actions.
*/
private static final String ACTION_SET_OPTIONS = "setOptions";
private static final String ACTION_CREATE_BANNER_VIEW = "createBannerView";
private static final String ACTION_DESTROY_BANNER_VIEW = "destroyBannerView";
private static final String ACTION_REQUEST_AD = "requestAd";
private static final String ACTION_SHOW_AD = "showAd";
private static final String ACTION_CREATE_INTERSTITIAL_VIEW = "createInterstitialView";
private static final String ACTION_REQUEST_INTERSTITIAL_AD = "requestInterstitialAd";
private static final String ACTION_SHOW_INTERSTITIAL_AD = "showInterstitialAd";
private ViewGroup parentView;
private boolean bannerShow = true;
/**
* The adView to display to the user.
*/
private AdView adView;
/**
* if want banner view overlap webview, we will need this layout
*/
private RelativeLayout adViewLayout = null;
/**
* The interstitial ad to display to the user.
*/
private InterstitialAd interstitialAd;
public boolean autoShowBanner = true;
public boolean autoShowInterstitial = true;
public boolean bannerVisible = false;
private boolean isGpsAvailable = false;
@Override
public void initialize(CordovaInterface cordova, CordovaWebView webView) {
super.initialize(cordova, webView);
isGpsAvailable = (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(cordova.getActivity()) == ConnectionResult.SUCCESS);
Log.w(LOGTAG, String.format("isGooglePlayServicesAvailable: %s", isGpsAvailable ? "true" : "false"));
}
/**
* This is the main method for the AdMob plugin. All API calls go through here.
* This method determines the action, and executes the appropriate call.
*
* @param action The action that the plugin should execute.
* @param inputs The input parameters for the action.
* @param callbackContext The callback context.
* @return A PluginResult representing the result of the provided action. A
* status of INVALID_ACTION is returned if the action is not recognized.
*/
@Override
public boolean execute(String action, JSONArray inputs, CallbackContext callbackContext) throws JSONException {
PluginResult result = null;
if (ACTION_SET_OPTIONS.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeSetOptions(options, callbackContext);
} else if (ACTION_CREATE_BANNER_VIEW.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeCreateBannerView(options, callbackContext);
} else if (ACTION_CREATE_INTERSTITIAL_VIEW.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeCreateInterstitialView(options, callbackContext);
} else if (ACTION_DESTROY_BANNER_VIEW.equals(action)) {
result = executeDestroyBannerView(callbackContext);
} else if (ACTION_REQUEST_INTERSTITIAL_AD.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeRequestInterstitialAd(options, callbackContext);
} else if (ACTION_REQUEST_AD.equals(action)) {
JSONObject options = inputs.optJSONObject(0);
result = executeRequestAd(options, callbackContext);
} else if (ACTION_SHOW_AD.equals(action)) {
boolean show = inputs.optBoolean(0);
result = executeShowAd(show, callbackContext);
} else if (ACTION_SHOW_INTERSTITIAL_AD.equals(action)) {
boolean show = inputs.optBoolean(0);
result = executeShowInterstitialAd(show, callbackContext);
} else {
Log.d(LOGTAG, String.format("Invalid action passed: %s", action));
result = new PluginResult(Status.INVALID_ACTION);
}
if (result != null) {
callbackContext.sendPluginResult(result);
}
return true;
}
private PluginResult executeSetOptions(JSONObject options, CallbackContext callbackContext) {
Log.w(LOGTAG, "executeSetOptions");
config.setOptions(options);
callbackContext.success();
return null;
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the developer
* should make the requestAd call to request an ad for the banner.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private PluginResult executeCreateBannerView(JSONObject options, final CallbackContext callbackContext) {
config.setOptions(options);
autoShowBanner = config.autoShow;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (adView == null) {
adView = new AdView(cordova.getActivity());
adView.setAdUnitId(config.getBannerAdUnitId());
adView.setAdSize(config.adSize);
adView.setAdListener(new BannerListener(AdMob.this));
}
if (adView.getParent() != null) {
((ViewGroup) adView.getParent()).removeView(adView);
}
bannerVisible = false;
adView.loadAd(buildAdRequest());
//if(autoShowBanner) {
// executeShowAd(true, null);
//}
Log.w("banner", config.getBannerAdUnitId());
callbackContext.success();
}
});
return null;
}
private PluginResult executeDestroyBannerView(CallbackContext callbackContext) {
Log.w(LOGTAG, "executeDestroyBannerView");
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (adView != null) {
ViewGroup parentView = (ViewGroup) adView.getParent();
if (parentView != null) {
parentView.removeView(adView);
}
adView.destroy();
adView = null;
}
bannerVisible = false;
delayCallback.success();
}
});
return null;
}
/**
* Parses the create interstitial view input parameters and runs the create interstitial
* view action on the UI thread. If this request is successful, the developer
* should make the requestAd call to request an ad for the banner.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private PluginResult executeCreateInterstitialView(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
autoShowInterstitial = config.autoShow;
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
clearInterstitial();
interstitialAd = new InterstitialAd(cordova.getActivity());
interstitialAd.setAdUnitId(config.getInterstitialAdUnitId());
interstitialAd.setAdListener(new InterstitialListener(AdMob.this));
Log.w("interstitial", config.getInterstitialAdUnitId());
interstitialAd.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
public void clearInterstitial() {
if (interstitialAd == null) {
return;
}
interstitialAd.setAdListener(null);
interstitialAd = null;
}
private AdRequest buildAdRequest() {
AdRequest.Builder builder = new AdRequest.Builder();
if (config.isTesting) {
// This will request test ads on the emulator and deviceby passing this hashed device ID.
String ANDROID_ID = Settings.Secure.getString(cordova.getActivity().getContentResolver(), android.provider.Settings.Secure.ANDROID_ID);
String deviceId = md5(ANDROID_ID).toUpperCase();
builder = builder.addTestDevice(deviceId).addTestDevice(AdRequest.DEVICE_ID_EMULATOR);
}
if (config.testDeviceList != null) {
Iterator<String> iterator = config.testDeviceList.iterator();
while (iterator.hasNext()) {
builder = builder.addTestDevice(iterator.next());
}
}
Bundle bundle = new Bundle();
bundle.putInt("cordova", 1);
if (config.adExtras != null) {
Iterator<String> it = config.adExtras.keys();
while (it.hasNext()) {
String key = it.next();
try {
bundle.putString(key, config.adExtras.get(key).toString());
} catch (JSONException exception) {
Log.w(LOGTAG, String.format("Caught JSON Exception: %s", exception.getMessage()));
}
}
}
builder = builder.addNetworkExtrasBundle(AdMobAdapter.class, bundle);
if (config.gender != null) {
if ("male".compareToIgnoreCase(config.gender) != 0) {
builder.setGender(AdRequest.GENDER_MALE);
} else if ("female".compareToIgnoreCase(config.gender) != 0) {
builder.setGender(AdRequest.GENDER_FEMALE);
} else {
builder.setGender(AdRequest.GENDER_UNKNOWN);
}
}
if (config.location != null) {
builder.setLocation(config.location);
}
if (config.forFamily != null) {
builder.setIsDesignedForFamilies(true);
}
if (config.forChild != null) {
builder.tagForChildDirectedTreatment(true);
}
if (config.contentURL != null) {
builder.setContentUrl(config.contentURL);
}
return builder.build();
}
/**
* Parses the request ad input parameters and runs the request ad action on
* the UI thread.
*
* @param options The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
private PluginResult executeRequestAd(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
if (adView == null) {
callbackContext.error("adView is null, call createBannerView first");
return null;
}
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
adView.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
private PluginResult executeRequestInterstitialAd(JSONObject options, CallbackContext callbackContext) {
config.setOptions(options);
if (adView == null) {
callbackContext.error("interstitialAd is null, call createInterstitialView first");
return null;
}
final CallbackContext delayCallback = callbackContext;
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
interstitialAd.loadAd(buildAdRequest());
delayCallback.success();
}
});
return null;
}
/**
* Parses the show ad input parameters and runs the show ad action on
* the UI thread.
*
* @param show The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with the
* input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
public PluginResult executeShowAd(final boolean show, final CallbackContext callbackContext) {
bannerShow = show;
if (adView == null) {
return new PluginResult(Status.ERROR, "adView is null, call createBannerView first.");
}
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (bannerVisible == bannerShow) {
// no change
} else if (bannerShow) {
if (adView.getParent() != null) {
((ViewGroup) adView.getParent()).removeView(adView);
}
if (config.bannerOverlap) {
RelativeLayout.LayoutParams params2 = new RelativeLayout.LayoutParams(
RelativeLayout.LayoutParams.MATCH_PARENT,
RelativeLayout.LayoutParams.WRAP_CONTENT);
params2.addRule(config.bannerAtTop ? RelativeLayout.ALIGN_PARENT_TOP : RelativeLayout.ALIGN_PARENT_BOTTOM);
if (adViewLayout == null) {
adViewLayout = new RelativeLayout(cordova.getActivity());
RelativeLayout.LayoutParams params = new RelativeLayout.LayoutParams(RelativeLayout.LayoutParams.MATCH_PARENT, RelativeLayout.LayoutParams.MATCH_PARENT);
try {
((ViewGroup) (((View) webView.getClass().getMethod("getView").invoke(webView)).getParent())).addView(adViewLayout, params);
} catch (Exception e) {
((ViewGroup) webView).addView(adViewLayout, params);
}
}
adViewLayout.addView(adView, params2);
adViewLayout.bringToFront();
} else {
ViewGroup wvParentView = (ViewGroup) getWebView().getParent();
if (parentView == null) {
parentView = new LinearLayout(webView.getContext());
}
if (wvParentView != null && wvParentView != parentView) {
wvParentView.removeView(getWebView());
((LinearLayout) parentView).setOrientation(LinearLayout.VERTICAL);
parentView.setLayoutParams(new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, 0.0F));
getWebView().setLayoutParams(new LinearLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT, 1.0F));
parentView.addView(getWebView());
cordova.getActivity().setContentView(parentView);
}
if (config.bannerAtTop) {
parentView.addView(adView, 0);
} else {
parentView.addView(adView);
}
parentView.bringToFront();
parentView.requestLayout();
parentView.requestFocus();
}
adView.setVisibility(View.VISIBLE);
bannerVisible = true;
} else {
adView.setVisibility(View.GONE);
bannerVisible = false;
}
if (callbackContext != null) {
callbackContext.success();
}
}
});
return null;
}
public PluginResult executeShowInterstitialAd(final boolean show, final CallbackContext callbackContext) {
if (interstitialAd == null) {
return new PluginResult(Status.ERROR, "interstitialAd is null, call createInterstitialView first.");
}
cordova.getActivity().runOnUiThread(new Runnable() {
@Override
public void run() {
if (interstitialAd.isLoaded()) {
interstitialAd.show();
if (callbackContext != null) {
callbackContext.success();
}
} else if (!autoShowInterstitial) {
if (callbackContext != null) {
callbackContext.error("Interstital not ready yet");
}
}
}
});
return null;
}
@Override
public void onPause(boolean multitasking) {
if (adView != null) {
adView.pause();
}
super.onPause(multitasking);
}
@Override
public void onResume(boolean multitasking) {
super.onResume(multitasking);
isGpsAvailable = (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(cordova.getActivity()) == ConnectionResult.SUCCESS);
if (adView != null) {
adView.resume();
}
}
@Override
public void onDestroy() {
if (adView != null) {
adView.destroy();
adView = null;
}
if (adViewLayout != null) {
ViewGroup parentView = (ViewGroup) adViewLayout.getParent();
if (parentView != null) {
parentView.removeView(adViewLayout);
}
adViewLayout = null;
}
super.onDestroy();
}
private View getWebView() {
try {
return (View) webView.getClass().getMethod("getView").invoke(webView);
} catch (Exception e) {
return (View) webView;
}
}
public static final String md5(final String s) {
try {
MessageDigest digest = java.security.MessageDigest.getInstance("MD5");
digest.update(s.getBytes());
byte messageDigest[] = digest.digest();
StringBuffer hexString = new StringBuffer();
for (int i = 0; i < messageDigest.length; i++) {
String h = Integer.toHexString(0xFF & messageDigest[i]);
while (h.length() < 2)
h = "0" + h;
hexString.append(h);
}
return hexString.toString();
} catch (NoSuchAlgorithmException e) {
}
return "";
}
}
| Refactor onDestroy()
| src/android/AdMob.java | Refactor onDestroy() | <ide><path>rc/android/AdMob.java
<ide> /**
<ide> * Common tag used for logging statements.
<ide> */
<del> private static final String LOGTAG = "AdMob";
<add> private static final String TAG = "AdMob";
<ide>
<ide> private static final AdMobConfig config = new AdMobConfig();
<ide>
<ide> public void initialize(CordovaInterface cordova, CordovaWebView webView) {
<ide> super.initialize(cordova, webView);
<ide> isGpsAvailable = (GoogleApiAvailability.getInstance().isGooglePlayServicesAvailable(cordova.getActivity()) == ConnectionResult.SUCCESS);
<del> Log.w(LOGTAG, String.format("isGooglePlayServicesAvailable: %s", isGpsAvailable ? "true" : "false"));
<add> Log.w(TAG, String.format("isGooglePlayServicesAvailable: %s", isGpsAvailable ? "true" : "false"));
<ide> }
<ide>
<ide> /**
<ide> result = executeShowInterstitialAd(show, callbackContext);
<ide>
<ide> } else {
<del> Log.d(LOGTAG, String.format("Invalid action passed: %s", action));
<add> Log.d(TAG, String.format("Invalid action passed: %s", action));
<ide> result = new PluginResult(Status.INVALID_ACTION);
<ide> }
<ide>
<ide> }
<ide>
<ide> private PluginResult executeSetOptions(JSONObject options, CallbackContext callbackContext) {
<del> Log.w(LOGTAG, "executeSetOptions");
<add> Log.w(TAG, "executeSetOptions");
<ide>
<ide> config.setOptions(options);
<ide>
<ide> }
<ide>
<ide> private PluginResult executeDestroyBannerView(CallbackContext callbackContext) {
<del> Log.w(LOGTAG, "executeDestroyBannerView");
<add> Log.w(TAG, "executeDestroyBannerView");
<ide>
<ide> final CallbackContext delayCallback = callbackContext;
<ide> cordova.getActivity().runOnUiThread(new Runnable() {
<ide> }
<ide>
<ide> public void clearInterstitial() {
<del> if (interstitialAd == null) {
<del> return;
<del> }
<del> interstitialAd.setAdListener(null);
<del> interstitialAd = null;
<add> if (interstitialAd != null) {
<add> interstitialAd.setAdListener(null);
<add> interstitialAd = null;
<add> }
<ide> }
<ide>
<ide> private AdRequest buildAdRequest() {
<ide> try {
<ide> bundle.putString(key, config.adExtras.get(key).toString());
<ide> } catch (JSONException exception) {
<del> Log.w(LOGTAG, String.format("Caught JSON Exception: %s", exception.getMessage()));
<add> Log.w(TAG, String.format("Caught JSON Exception: %s", exception.getMessage()));
<ide> }
<ide> }
<ide> }
<ide>
<ide> @Override
<ide> public void onDestroy() {
<del> if (adView != null) {
<del> adView.destroy();
<del> adView = null;
<del> }
<add> destroyAdView();
<add> clearInterstitial();
<ide> if (adViewLayout != null) {
<ide> ViewGroup parentView = (ViewGroup) adViewLayout.getParent();
<ide> if (parentView != null) {
<ide> adViewLayout = null;
<ide> }
<ide> super.onDestroy();
<add> }
<add>
<add> private void destroyAdView() {
<add> if (adView != null) {
<add> adView.destroy();
<add> adView = null;
<add> }
<ide> }
<ide>
<ide> private View getWebView() { |
|
Java | mit | error: pathspec 'HandPanel.java' did not match any file(s) known to git
| 496e3344cdf6d08ae1c5a87afa9016730fb4976b | 1 | lizzyd710/gif-game-local | import javax.swing.*;
import java.awt.*;
import java.awt.event.*;
import java.awt.image.*;
public class HandPanel extends JPanel
{
public HandPanel()
{
setLayout(new GridLayout(1, 5));
}
}
| HandPanel.java | Create HandPanel.java | HandPanel.java | Create HandPanel.java | <ide><path>andPanel.java
<add>import javax.swing.*;
<add>import java.awt.*;
<add>import java.awt.event.*;
<add>import java.awt.image.*;
<add>
<add>public class HandPanel extends JPanel
<add>{
<add> public HandPanel()
<add> {
<add> setLayout(new GridLayout(1, 5));
<add> }
<add>} |
|
Java | apache-2.0 | 373c279475e0d028369131d976f9b8d03897bb5b | 0 | gradle/gradle,gradle/gradle,gradle/gradle,gradle/gradle,blindpirate/gradle,blindpirate/gradle,gradle/gradle,gradle/gradle,gradle/gradle,gradle/gradle,blindpirate/gradle,blindpirate/gradle,gradle/gradle,gradle/gradle,blindpirate/gradle,blindpirate/gradle,blindpirate/gradle,blindpirate/gradle,blindpirate/gradle,blindpirate/gradle | /*
* Copyright 2010 the original author or 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 org.gradle;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.gradle.api.Incubating;
import org.gradle.api.artifacts.verification.DependencyVerificationMode;
import org.gradle.api.logging.LogLevel;
import org.gradle.api.logging.configuration.ConsoleOutput;
import org.gradle.api.logging.configuration.LoggingConfiguration;
import org.gradle.api.logging.configuration.ShowStacktrace;
import org.gradle.api.logging.configuration.WarningMode;
import org.gradle.concurrent.ParallelismConfiguration;
import org.gradle.initialization.BuildLayoutParameters;
import org.gradle.initialization.CompositeInitScriptFinder;
import org.gradle.initialization.DistributionInitScriptFinder;
import org.gradle.initialization.UserHomeInitScriptFinder;
import org.gradle.internal.DefaultTaskExecutionRequest;
import org.gradle.internal.FileUtils;
import org.gradle.internal.concurrent.DefaultParallelismConfiguration;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.internal.logging.DefaultLoggingConfiguration;
import javax.annotation.Nullable;
import java.io.File;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static java.util.Collections.emptyList;
/**
* <p>{@code StartParameter} defines the configuration used by a Gradle instance to execute a build. The properties of {@code StartParameter} generally correspond to the command-line options of
* Gradle.
*
* <p>You can obtain an instance of a {@code StartParameter} by either creating a new one, or duplicating an existing one using {@link #newInstance} or {@link #newBuild}.</p>
*/
public class StartParameter implements LoggingConfiguration, ParallelismConfiguration, Serializable {
public static final String GRADLE_USER_HOME_PROPERTY_KEY = BuildLayoutParameters.GRADLE_USER_HOME_PROPERTY_KEY;
/**
* The default user home directory.
*/
public static final File DEFAULT_GRADLE_USER_HOME = new BuildLayoutParameters().getGradleUserHomeDir();
private final DefaultLoggingConfiguration loggingConfiguration = new DefaultLoggingConfiguration();
private final DefaultParallelismConfiguration parallelismConfiguration = new DefaultParallelismConfiguration();
private List<TaskExecutionRequest> taskRequests = new ArrayList<>();
private Set<String> excludedTaskNames = new LinkedHashSet<>();
private boolean buildProjectDependencies = true;
private File currentDir;
private File projectDir;
protected boolean searchUpwards;
private Map<String, String> projectProperties = new HashMap<>();
private Map<String, String> systemPropertiesArgs = new HashMap<>();
private File gradleUserHomeDir;
protected File gradleHomeDir;
private File settingsFile;
protected boolean useEmptySettings;
private File buildFile;
private List<File> initScripts = new ArrayList<>();
private boolean dryRun;
private boolean rerunTasks;
private boolean profile;
private boolean continueOnFailure;
private boolean offline;
private File projectCacheDir;
private boolean refreshDependencies;
private boolean buildCacheEnabled;
private boolean buildCacheDebugLogging;
private boolean watchFileSystem;
private boolean configureOnDemand;
private boolean continuous;
private List<File> includedBuilds = new ArrayList<>();
private boolean buildScan;
private boolean noBuildScan;
private boolean writeDependencyLocks;
private List<String> writeDependencyVerifications = emptyList();
private List<String> lockedDependenciesToUpdate = emptyList();
private DependencyVerificationMode verificationMode = DependencyVerificationMode.STRICT;
private boolean isRefreshKeys;
private boolean isExportKeys;
/**
* {@inheritDoc}
*/
@Override
public LogLevel getLogLevel() {
return loggingConfiguration.getLogLevel();
}
/**
* {@inheritDoc}
*/
@Override
public void setLogLevel(LogLevel logLevel) {
loggingConfiguration.setLogLevel(logLevel);
}
/**
* {@inheritDoc}
*/
@Override
public ShowStacktrace getShowStacktrace() {
return loggingConfiguration.getShowStacktrace();
}
/**
* {@inheritDoc}
*/
@Override
public void setShowStacktrace(ShowStacktrace showStacktrace) {
loggingConfiguration.setShowStacktrace(showStacktrace);
}
/**
* {@inheritDoc}
*/
@Override
public ConsoleOutput getConsoleOutput() {
return loggingConfiguration.getConsoleOutput();
}
/**
* {@inheritDoc}
*/
@Override
public void setConsoleOutput(ConsoleOutput consoleOutput) {
loggingConfiguration.setConsoleOutput(consoleOutput);
}
/**
* {@inheritDoc}
*/
@Override
public WarningMode getWarningMode() {
return loggingConfiguration.getWarningMode();
}
/**
* {@inheritDoc}
*/
@Override
public void setWarningMode(WarningMode warningMode) {
loggingConfiguration.setWarningMode(warningMode);
}
/**
* Sets the project's cache location. Set to null to use the default location.
*/
public void setProjectCacheDir(@Nullable File projectCacheDir) {
this.projectCacheDir = projectCacheDir;
}
/**
* Returns the project's cache dir.
*
* @return project's cache dir, or null if the default location is to be used.
*/
@Nullable
public File getProjectCacheDir() {
return projectCacheDir;
}
/**
* Creates a {@code StartParameter} with default values. This is roughly equivalent to running Gradle on the command-line with no arguments.
*/
public StartParameter() {
BuildLayoutParameters layoutParameters = new BuildLayoutParameters();
gradleHomeDir = layoutParameters.getGradleInstallationHomeDir();
searchUpwards = layoutParameters.getSearchUpwards();
currentDir = layoutParameters.getCurrentDir();
projectDir = layoutParameters.getProjectDir();
gradleUserHomeDir = layoutParameters.getGradleUserHomeDir();
}
/**
* Duplicates this {@code StartParameter} instance.
*
* @return the new parameters.
*/
public StartParameter newInstance() {
return prepareNewInstance(new StartParameter());
}
protected StartParameter prepareNewInstance(StartParameter p) {
prepareNewBuild(p);
p.setWarningMode(getWarningMode());
p.buildFile = buildFile;
p.projectDir = projectDir;
p.settingsFile = settingsFile;
p.useEmptySettings = useEmptySettings;
p.taskRequests = new ArrayList<>(taskRequests);
p.excludedTaskNames = new LinkedHashSet<>(excludedTaskNames);
p.buildProjectDependencies = buildProjectDependencies;
p.currentDir = currentDir;
p.searchUpwards = searchUpwards;
p.projectProperties = new HashMap<>(projectProperties);
p.systemPropertiesArgs = new HashMap<>(systemPropertiesArgs);
p.initScripts = new ArrayList<>(initScripts);
p.includedBuilds = new ArrayList<>(includedBuilds);
p.dryRun = dryRun;
p.projectCacheDir = projectCacheDir;
return p;
}
/**
* <p>Creates the parameters for a new build, using these parameters as a template. Copies the environmental properties from this parameter (eg Gradle user home dir, etc), but does not copy the
* build specific properties (eg task names).</p>
*
* @return The new parameters.
*/
public StartParameter newBuild() {
return prepareNewBuild(new StartParameter());
}
protected StartParameter prepareNewBuild(StartParameter p) {
p.gradleUserHomeDir = gradleUserHomeDir;
p.gradleHomeDir = gradleHomeDir;
p.setLogLevel(getLogLevel());
p.setConsoleOutput(getConsoleOutput());
p.setShowStacktrace(getShowStacktrace());
p.setWarningMode(getWarningMode());
p.profile = profile;
p.continueOnFailure = continueOnFailure;
p.offline = offline;
p.rerunTasks = rerunTasks;
p.refreshDependencies = refreshDependencies;
p.setParallelProjectExecutionEnabled(isParallelProjectExecutionEnabled());
p.buildCacheEnabled = buildCacheEnabled;
p.configureOnDemand = configureOnDemand;
p.setMaxWorkerCount(getMaxWorkerCount());
p.systemPropertiesArgs = new HashMap<>(systemPropertiesArgs);
p.writeDependencyLocks = writeDependencyLocks;
p.writeDependencyVerifications = writeDependencyVerifications;
p.lockedDependenciesToUpdate = new ArrayList<>(lockedDependenciesToUpdate);
p.verificationMode = verificationMode;
p.isRefreshKeys = isRefreshKeys;
p.isExportKeys = isExportKeys;
return p;
}
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj);
}
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
/**
* Returns the build file to use to select the default project. Returns null when the build file is not used to select the default project.
*
* @return The build file. May be null.
*/
@Nullable
public File getBuildFile() {
return buildFile;
}
/**
* Sets the build file to use to select the default project. Use null to disable selecting the default project using the build file.
*
* @param buildFile The build file. May be null.
*/
public void setBuildFile(@Nullable File buildFile) {
if (buildFile == null) {
this.buildFile = null;
setCurrentDir(null);
} else {
this.buildFile = FileUtils.canonicalize(buildFile);
setProjectDir(this.buildFile.getParentFile());
}
}
/**
* Specifies that an empty settings script should be used.
*
* This means that even if a settings file exists in the conventional location, or has been previously specified by {@link #setSettingsFile(File)}, it will not be used.
*
* If {@link #setSettingsFile(File)} is called after this, it will supersede calling this method.
*
* @return this
*/
public StartParameter useEmptySettings() {
DeprecationLogger.deprecateMethod(StartParameter.class, "useEmptySettings()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(6, "discontinued_methods")
.nagUser();
doUseEmptySettings();
return this;
}
protected void doUseEmptySettings() {
searchUpwards = false;
useEmptySettings = true;
settingsFile = null;
}
/**
* Returns whether an empty settings script will be used regardless of whether one exists in the default location.
*
* @return Whether to use empty settings or not.
*/
public boolean isUseEmptySettings() {
DeprecationLogger.deprecateMethod(StartParameter.class, "isUseEmptySettings()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(6, "discontinued_methods")
.nagUser();
return useEmptySettings;
}
/**
* Returns the names of the tasks to execute in this build. When empty, the default tasks for the project will be executed. If {@link TaskExecutionRequest}s are set for this build then names from these task parameters are returned.
*
* @return the names of the tasks to execute in this build. Never returns null.
*/
public List<String> getTaskNames() {
List<String> taskNames = Lists.newArrayList();
for (TaskExecutionRequest taskRequest : taskRequests) {
taskNames.addAll(taskRequest.getArgs());
}
return taskNames;
}
/**
* <p>Sets the tasks to execute in this build. Set to an empty list, or null, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency
* between the tasks.</p>
*
* @param taskNames the names of the tasks to execute in this build.
*/
public void setTaskNames(@Nullable Iterable<String> taskNames) {
if (taskNames == null) {
this.taskRequests = emptyList();
} else {
this.taskRequests = Arrays.asList(new DefaultTaskExecutionRequest(taskNames));
}
}
/**
* Returns the tasks to execute in this build. When empty, the default tasks for the project will be executed.
*
* @return the tasks to execute in this build. Never returns null.
*/
public List<TaskExecutionRequest> getTaskRequests() {
return taskRequests;
}
/**
* <p>Sets the task parameters to execute in this build. Set to an empty list, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency
* between the tasks.</p>
*
* @param taskParameters the tasks to execute in this build.
*/
public void setTaskRequests(Iterable<? extends TaskExecutionRequest> taskParameters) {
this.taskRequests = Lists.newArrayList(taskParameters);
}
/**
* Returns the names of the tasks to be excluded from this build. When empty, no tasks are excluded from the build.
*
* @return The names of the excluded tasks. Returns an empty set if there are no such tasks.
*/
public Set<String> getExcludedTaskNames() {
return excludedTaskNames;
}
/**
* Sets the tasks to exclude from this build.
*
* @param excludedTaskNames The task names.
*/
public void setExcludedTaskNames(Iterable<String> excludedTaskNames) {
this.excludedTaskNames = Sets.newLinkedHashSet(excludedTaskNames);
}
/**
* Returns the directory to use to select the default project, and to search for the settings file.
*
* @return The current directory. Never returns null.
*/
public File getCurrentDir() {
return currentDir;
}
/**
* Sets the directory to use to select the default project, and to search for the settings file. Set to null to use the default current directory.
*
* @param currentDir The directory. Set to null to use the default.
*/
public void setCurrentDir(@Nullable File currentDir) {
if (currentDir != null) {
this.currentDir = FileUtils.canonicalize(currentDir);
} else {
this.currentDir = new BuildLayoutParameters().getCurrentDir();
}
}
public boolean isSearchUpwards() {
DeprecationLogger.deprecateMethod(StartParameter.class, "isSearchUpwards()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(5, "search_upwards_related_apis_in_startparameter_have_been_deprecated")
.nagUser();
return searchUpwards;
}
public void setSearchUpwards(boolean searchUpwards) {
DeprecationLogger.deprecateMethod(StartParameter.class, "setSearchUpwards(boolean)")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(5, "search_upwards_related_apis_in_startparameter_have_been_deprecated")
.nagUser();
this.searchUpwards = searchUpwards;
}
public Map<String, String> getProjectProperties() {
return projectProperties;
}
public void setProjectProperties(Map<String, String> projectProperties) {
this.projectProperties = projectProperties;
}
public Map<String, String> getSystemPropertiesArgs() {
return systemPropertiesArgs;
}
public void setSystemPropertiesArgs(Map<String, String> systemPropertiesArgs) {
this.systemPropertiesArgs = systemPropertiesArgs;
}
/**
* Returns the directory to use as the user home directory.
*
* @return The home directory.
*/
public File getGradleUserHomeDir() {
return gradleUserHomeDir;
}
/**
* Sets the directory to use as the user home directory. Set to null to use the default directory.
*
* @param gradleUserHomeDir The home directory. May be null.
*/
public void setGradleUserHomeDir(@Nullable File gradleUserHomeDir) {
this.gradleUserHomeDir = gradleUserHomeDir == null ? new BuildLayoutParameters().getGradleUserHomeDir() : FileUtils.canonicalize(gradleUserHomeDir);
}
/**
* Returns true if project dependencies are to be built, false if they should not be. The default is true.
*/
public boolean isBuildProjectDependencies() {
return buildProjectDependencies;
}
/**
* Specifies whether project dependencies should be built. Defaults to true.
*
* @return this
*/
public StartParameter setBuildProjectDependencies(boolean build) {
this.buildProjectDependencies = build;
return this;
}
public boolean isDryRun() {
return dryRun;
}
public void setDryRun(boolean dryRun) {
this.dryRun = dryRun;
}
/**
* Sets the settings file to use for the build. Use null to use the default settings file.
*
* @param settingsFile The settings file to use. May be null.
*/
public void setSettingsFile(@Nullable File settingsFile) {
if (settingsFile == null) {
this.settingsFile = null;
} else {
this.useEmptySettings = false;
this.settingsFile = FileUtils.canonicalize(settingsFile);
currentDir = this.settingsFile.getParentFile();
}
}
/**
* Returns the explicit settings file to use for the build, or null.
*
* Will return null if the default settings file is to be used. However, if {@link #isUseEmptySettings()} returns true, then no settings file at all will be used.
*
* @return The settings file. May be null.
* @see #isUseEmptySettings()
*/
@Nullable
public File getSettingsFile() {
return settingsFile;
}
/**
* Adds the given file to the list of init scripts that are run before the build starts. This list is in addition to the default init scripts.
*
* @param initScriptFile The init scripts.
*/
public void addInitScript(File initScriptFile) {
initScripts.add(initScriptFile);
}
/**
* Sets the list of init scripts to be run before the build starts. This list is in addition to the default init scripts.
*
* @param initScripts The init scripts.
*/
public void setInitScripts(List<File> initScripts) {
this.initScripts = initScripts;
}
/**
* Returns all explicitly added init scripts that will be run before the build starts. This list does not contain the user init script located in ${user.home}/.gradle/init.gradle, even though
* that init script will also be run.
*
* @return list of all explicitly added init scripts.
*/
public List<File> getInitScripts() {
return Collections.unmodifiableList(initScripts);
}
/**
* Returns all init scripts, including explicit init scripts and implicit init scripts.
*
* @return All init scripts, including explicit init scripts and implicit init scripts.
*/
public List<File> getAllInitScripts() {
CompositeInitScriptFinder initScriptFinder = new CompositeInitScriptFinder(
new UserHomeInitScriptFinder(getGradleUserHomeDir()),
new DistributionInitScriptFinder(gradleHomeDir)
);
List<File> scripts = new ArrayList<>(getInitScripts());
initScriptFinder.findScripts(scripts);
return Collections.unmodifiableList(scripts);
}
/**
* Sets the project directory to use to select the default project. Use null to use the default criteria for selecting the default project.
*
* @param projectDir The project directory. May be null.
*/
public void setProjectDir(@Nullable File projectDir) {
if (projectDir == null) {
setCurrentDir(null);
this.projectDir = null;
} else {
File canonicalFile = FileUtils.canonicalize(projectDir);
currentDir = canonicalFile;
this.projectDir = canonicalFile;
}
}
/**
* Returns the project dir to use to select the default project.
*
* Returns null when the build file is not used to select the default project
*
* @return The project dir. May be null.
*/
@Nullable
public File getProjectDir() {
return projectDir;
}
/**
* Specifies if a profile report should be generated.
*
* @param profile true if a profile report should be generated
*/
public void setProfile(boolean profile) {
this.profile = profile;
}
/**
* Returns true if a profile report will be generated.
*/
public boolean isProfile() {
return profile;
}
/**
* Specifies whether the build should continue on task failure. The default is false.
*/
public boolean isContinueOnFailure() {
return continueOnFailure;
}
/**
* Specifies whether the build should continue on task failure. The default is false.
*/
public void setContinueOnFailure(boolean continueOnFailure) {
this.continueOnFailure = continueOnFailure;
}
/**
* Specifies whether the build should be performed offline (ie without network access).
*/
public boolean isOffline() {
return offline;
}
/**
* Specifies whether the build should be performed offline (ie without network access).
*/
public void setOffline(boolean offline) {
this.offline = offline;
}
/**
* Specifies whether the dependencies should be refreshed..
*/
public boolean isRefreshDependencies() {
return refreshDependencies;
}
/**
* Specifies whether the dependencies should be refreshed..
*/
public void setRefreshDependencies(boolean refreshDependencies) {
this.refreshDependencies = refreshDependencies;
}
/**
* Specifies whether the cached task results should be ignored and each task should be forced to be executed.
*/
public boolean isRerunTasks() {
return rerunTasks;
}
/**
* Specifies whether the cached task results should be ignored and each task should be forced to be executed.
*/
public void setRerunTasks(boolean rerunTasks) {
this.rerunTasks = rerunTasks;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isParallelProjectExecutionEnabled() {
return parallelismConfiguration.isParallelProjectExecutionEnabled();
}
/**
* {@inheritDoc}
*/
@Override
public void setParallelProjectExecutionEnabled(boolean parallelProjectExecution) {
parallelismConfiguration.setParallelProjectExecutionEnabled(parallelProjectExecution);
}
/**
* Returns true if the build cache is enabled.
*
* @since 3.5
*/
public boolean isBuildCacheEnabled() {
return buildCacheEnabled;
}
/**
* Enables/disables the build cache.
*
* @since 3.5
*/
public void setBuildCacheEnabled(boolean buildCacheEnabled) {
this.buildCacheEnabled = buildCacheEnabled;
}
/**
* Whether build cache debug logging is enabled.
*
* @since 4.6
*/
public boolean isBuildCacheDebugLogging() {
return buildCacheDebugLogging;
}
/**
* Whether build cache debug logging is enabled.
*
* @since 4.6
*/
public void setBuildCacheDebugLogging(boolean buildCacheDebugLogging) {
this.buildCacheDebugLogging = buildCacheDebugLogging;
}
/**
* Whether watching the file system for faster up-to-date checking is enabled.
*
* @since 6.5
*/
@Incubating
public boolean isWatchFileSystem() {
return watchFileSystem;
}
/**
* Whether watching the file system for faster up-to-date checking is enabled.
*
* @since 6.5
*/
@Incubating
public void setWatchFileSystem(boolean watchFileSystem) {
this.watchFileSystem = watchFileSystem;
}
/**
* {@inheritDoc}
*/
@Override
public int getMaxWorkerCount() {
return parallelismConfiguration.getMaxWorkerCount();
}
/**
* {@inheritDoc}
*/
@Override
public void setMaxWorkerCount(int maxWorkerCount) {
parallelismConfiguration.setMaxWorkerCount(maxWorkerCount);
}
/**
* If the configure-on-demand mode is active
*/
@Incubating
public boolean isConfigureOnDemand() {
return configureOnDemand;
}
@Override
public String toString() {
return "StartParameter{"
+ "taskRequests=" + taskRequests
+ ", excludedTaskNames=" + excludedTaskNames
+ ", currentDir=" + currentDir
+ ", searchUpwards=" + searchUpwards
+ ", projectProperties=" + projectProperties
+ ", systemPropertiesArgs=" + systemPropertiesArgs
+ ", gradleUserHomeDir=" + gradleUserHomeDir
+ ", gradleHome=" + gradleHomeDir
+ ", logLevel=" + getLogLevel()
+ ", showStacktrace=" + getShowStacktrace()
+ ", buildFile=" + buildFile
+ ", initScripts=" + initScripts
+ ", dryRun=" + dryRun
+ ", rerunTasks=" + rerunTasks
+ ", offline=" + offline
+ ", refreshDependencies=" + refreshDependencies
+ ", parallelProjectExecution=" + isParallelProjectExecutionEnabled()
+ ", configureOnDemand=" + configureOnDemand
+ ", maxWorkerCount=" + getMaxWorkerCount()
+ ", buildCacheEnabled=" + buildCacheEnabled
+ ", writeDependencyLocks=" + writeDependencyLocks
+ ", verificationMode=" + verificationMode
+ ", refreshKeys=" + isRefreshKeys
+ '}';
}
/**
* Package scope for testing purposes.
*/
void setGradleHomeDir(File gradleHomeDir) {
this.gradleHomeDir = gradleHomeDir;
}
@Incubating
public void setConfigureOnDemand(boolean configureOnDemand) {
this.configureOnDemand = configureOnDemand;
}
public boolean isContinuous() {
return continuous;
}
public void setContinuous(boolean enabled) {
this.continuous = enabled;
}
public void includeBuild(File includedBuild) {
includedBuilds.add(includedBuild);
}
public void setIncludedBuilds(List<File> includedBuilds) {
this.includedBuilds = includedBuilds;
}
public List<File> getIncludedBuilds() {
return Collections.unmodifiableList(includedBuilds);
}
/**
* Returns true if build scan should be created.
*
* @since 3.4
*/
public boolean isBuildScan() {
return buildScan;
}
/**
* Specifies whether a build scan should be created.
*
* @since 3.4
*/
public void setBuildScan(boolean buildScan) {
this.buildScan = buildScan;
}
/**
* Returns true when build scan creation is explicitly disabled.
*
* @since 3.4
*/
public boolean isNoBuildScan() {
return noBuildScan;
}
/**
* Specifies whether build scan creation is explicitly disabled.
*
* @since 3.4
*/
public void setNoBuildScan(boolean noBuildScan) {
this.noBuildScan = noBuildScan;
}
/**
* Specifies whether dependency resolution needs to be persisted for locking
*
* @since 4.8
*/
public void setWriteDependencyLocks(boolean writeDependencyLocks) {
this.writeDependencyLocks = writeDependencyLocks;
}
/**
* Returns true when dependency resolution is to be persisted for locking
*
* @since 4.8
*/
public boolean isWriteDependencyLocks() {
return writeDependencyLocks;
}
/**
* Indicates that specified dependencies are to be allowed to update their version.
* Implicitly activates dependency locking persistence.
*
* @param lockedDependenciesToUpdate the modules to update
* @see #isWriteDependencyLocks()
* @since 4.8
*/
public void setLockedDependenciesToUpdate(List<String> lockedDependenciesToUpdate) {
this.lockedDependenciesToUpdate = Lists.newArrayList(lockedDependenciesToUpdate);
this.writeDependencyLocks = true;
}
/**
* Indicates if a dependency verification metadata file should be written at the
* end of this build. If the list is not empty, then it means we need to generate
* or update the dependency verification file with the checksums specified in the
* list.
*
* @since 6.1
*/
@Incubating
public List<String> getWriteDependencyVerifications() {
return writeDependencyVerifications;
}
/**
* Tells if a dependency verification metadata file should be written at the end
* of this build.
*
* @param checksums the list of checksums to generate
* @since 6.1
*/
@Incubating
public void setWriteDependencyVerifications(List<String> checksums) {
this.writeDependencyVerifications = checksums;
}
/**
* Returns the list of modules that are to be allowed to update their version compared to the lockfile.
*
* @return a list of modules allowed to have a version update
* @since 4.8
*/
public List<String> getLockedDependenciesToUpdate() {
return lockedDependenciesToUpdate;
}
/**
* Sets the dependency verification mode. There are three different modes:
* <ul>
* <li><i>strict</i>, the default, verification is enabled as soon as a dependency verification file is present.</li>
* <li><i>lenient</i>, in this mode, failure to verify a checksum, missing checksums or signatures will be logged
* but will not fail the build. This mode should only be used when updating dependencies as it is inherently unsafe.</li>
* <li><i>off</i>, this mode disables all verifications</li>
* </ul>
*
* @param verificationMode if true, enables lenient dependency verification
* @since 6.2
*/
@Incubating
public void setDependencyVerificationMode(DependencyVerificationMode verificationMode) {
this.verificationMode = verificationMode;
}
/**
* Returns the dependency verification mode.
*
* @since 6.2
*/
@Incubating
public DependencyVerificationMode getDependencyVerificationMode() {
return verificationMode;
}
/**
* Sets the key refresh flag.
*
* @param refresh If set to true, missing keys will be checked again. By default missing keys are cached for 24 hours.
* @since 6.2
*/
@Incubating
public void setRefreshKeys(boolean refresh) {
isRefreshKeys = refresh;
}
/**
* If true, Gradle will try to download missing keys again.
*
* @since 6.2
*/
@Incubating
public boolean isRefreshKeys() {
return isRefreshKeys;
}
/**
* If true, after writing the dependency verification file, a public keyring
* file will be generated with all keys seen during generation of the file.
*
* This file can then be used as a source for public keys instead of reaching
* out public key servers.
*
* @return true if keys should be exported
* @since 6.2
*/
@Incubating
public boolean isExportKeys() {
return isExportKeys;
}
/**
* If true, after writing the dependency verification file, a public keyring
* file will be generated with all keys seen during generation of the file.
*
* This file can then be used as a source for public keys instead of reaching
* out public key servers.
*
* @param exportKeys set to true if keys should be exported
* @since 6.2
*/
@Incubating
public void setExportKeys(boolean exportKeys) {
isExportKeys = exportKeys;
}
}
| subprojects/core-api/src/main/java/org/gradle/StartParameter.java | /*
* Copyright 2010 the original author or 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 org.gradle;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.gradle.api.Incubating;
import org.gradle.api.artifacts.verification.DependencyVerificationMode;
import org.gradle.api.logging.LogLevel;
import org.gradle.api.logging.configuration.ConsoleOutput;
import org.gradle.api.logging.configuration.LoggingConfiguration;
import org.gradle.api.logging.configuration.ShowStacktrace;
import org.gradle.api.logging.configuration.WarningMode;
import org.gradle.concurrent.ParallelismConfiguration;
import org.gradle.initialization.BuildLayoutParameters;
import org.gradle.initialization.CompositeInitScriptFinder;
import org.gradle.initialization.DistributionInitScriptFinder;
import org.gradle.initialization.UserHomeInitScriptFinder;
import org.gradle.internal.DefaultTaskExecutionRequest;
import org.gradle.internal.FileUtils;
import org.gradle.internal.concurrent.DefaultParallelismConfiguration;
import org.gradle.internal.deprecation.DeprecationLogger;
import org.gradle.internal.logging.DefaultLoggingConfiguration;
import javax.annotation.Nullable;
import java.io.File;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static java.util.Collections.emptyList;
/**
* <p>{@code StartParameter} defines the configuration used by a Gradle instance to execute a build. The properties of {@code StartParameter} generally correspond to the command-line options of
* Gradle.
*
* <p>You can obtain an instance of a {@code StartParameter} by either creating a new one, or duplicating an existing one using {@link #newInstance} or {@link #newBuild}.</p>
*/
public class StartParameter implements LoggingConfiguration, ParallelismConfiguration, Serializable {
public static final String GRADLE_USER_HOME_PROPERTY_KEY = BuildLayoutParameters.GRADLE_USER_HOME_PROPERTY_KEY;
/**
* The default user home directory.
*/
public static final File DEFAULT_GRADLE_USER_HOME = new BuildLayoutParameters().getGradleUserHomeDir();
private final DefaultLoggingConfiguration loggingConfiguration = new DefaultLoggingConfiguration();
private final DefaultParallelismConfiguration parallelismConfiguration = new DefaultParallelismConfiguration();
private List<TaskExecutionRequest> taskRequests = new ArrayList<>();
private Set<String> excludedTaskNames = new LinkedHashSet<>();
private boolean buildProjectDependencies = true;
private File currentDir;
private File projectDir;
protected boolean searchUpwards;
private Map<String, String> projectProperties = new HashMap<>();
private Map<String, String> systemPropertiesArgs = new HashMap<>();
private File gradleUserHomeDir;
protected File gradleHomeDir;
private File settingsFile;
protected boolean useEmptySettings;
private File buildFile;
private List<File> initScripts = new ArrayList<>();
private boolean dryRun;
private boolean rerunTasks;
private boolean profile;
private boolean continueOnFailure;
private boolean offline;
private File projectCacheDir;
private boolean refreshDependencies;
private boolean buildCacheEnabled;
private boolean buildCacheDebugLogging;
private boolean watchFileSystem;
private boolean configureOnDemand;
private boolean continuous;
private List<File> includedBuilds = new ArrayList<>();
private boolean buildScan;
private boolean noBuildScan;
private boolean writeDependencyLocks;
private List<String> writeDependencyVerifications = emptyList();
private List<String> lockedDependenciesToUpdate = emptyList();
private DependencyVerificationMode verificationMode = DependencyVerificationMode.STRICT;
private boolean isRefreshKeys;
private boolean isExportKeys;
/**
* {@inheritDoc}
*/
@Override
public LogLevel getLogLevel() {
return loggingConfiguration.getLogLevel();
}
/**
* {@inheritDoc}
*/
@Override
public void setLogLevel(LogLevel logLevel) {
loggingConfiguration.setLogLevel(logLevel);
}
/**
* {@inheritDoc}
*/
@Override
public ShowStacktrace getShowStacktrace() {
return loggingConfiguration.getShowStacktrace();
}
/**
* {@inheritDoc}
*/
@Override
public void setShowStacktrace(ShowStacktrace showStacktrace) {
loggingConfiguration.setShowStacktrace(showStacktrace);
}
/**
* {@inheritDoc}
*/
@Override
public ConsoleOutput getConsoleOutput() {
return loggingConfiguration.getConsoleOutput();
}
/**
* {@inheritDoc}
*/
@Override
public void setConsoleOutput(ConsoleOutput consoleOutput) {
loggingConfiguration.setConsoleOutput(consoleOutput);
}
/**
* {@inheritDoc}
*/
@Override
public WarningMode getWarningMode() {
return loggingConfiguration.getWarningMode();
}
/**
* {@inheritDoc}
*/
@Override
public void setWarningMode(WarningMode warningMode) {
loggingConfiguration.setWarningMode(warningMode);
}
/**
* Sets the project's cache location. Set to null to use the default location.
*/
public void setProjectCacheDir(@Nullable File projectCacheDir) {
this.projectCacheDir = projectCacheDir;
}
/**
* Returns the project's cache dir.
*
* @return project's cache dir, or null if the default location is to be used.
*/
@Nullable
public File getProjectCacheDir() {
return projectCacheDir;
}
/**
* Creates a {@code StartParameter} with default values. This is roughly equivalent to running Gradle on the command-line with no arguments.
*/
public StartParameter() {
BuildLayoutParameters layoutParameters = new BuildLayoutParameters();
gradleHomeDir = layoutParameters.getGradleInstallationHomeDir();
searchUpwards = layoutParameters.getSearchUpwards();
currentDir = layoutParameters.getCurrentDir();
projectDir = layoutParameters.getProjectDir();
gradleUserHomeDir = layoutParameters.getGradleUserHomeDir();
}
/**
* Duplicates this {@code StartParameter} instance.
*
* @return the new parameters.
*/
public StartParameter newInstance() {
return prepareNewInstance(new StartParameter());
}
protected StartParameter prepareNewInstance(StartParameter p) {
prepareNewBuild(p);
p.setWarningMode(getWarningMode());
p.buildFile = buildFile;
p.projectDir = projectDir;
p.settingsFile = settingsFile;
p.useEmptySettings = useEmptySettings;
p.taskRequests = new ArrayList<>(taskRequests);
p.excludedTaskNames = new LinkedHashSet<>(excludedTaskNames);
p.buildProjectDependencies = buildProjectDependencies;
p.currentDir = currentDir;
p.searchUpwards = searchUpwards;
p.projectProperties = new HashMap<>(projectProperties);
p.systemPropertiesArgs = new HashMap<>(systemPropertiesArgs);
p.initScripts = new ArrayList<>(initScripts);
p.includedBuilds = new ArrayList<>(includedBuilds);
p.dryRun = dryRun;
p.projectCacheDir = projectCacheDir;
return p;
}
/**
* <p>Creates the parameters for a new build, using these parameters as a template. Copies the environmental properties from this parameter (eg Gradle user home dir, etc), but does not copy the
* build specific properties (eg task names).</p>
*
* @return The new parameters.
*/
public StartParameter newBuild() {
return prepareNewBuild(new StartParameter());
}
protected StartParameter prepareNewBuild(StartParameter p) {
p.gradleUserHomeDir = gradleUserHomeDir;
p.gradleHomeDir = gradleHomeDir;
p.setLogLevel(getLogLevel());
p.setConsoleOutput(getConsoleOutput());
p.setShowStacktrace(getShowStacktrace());
p.setWarningMode(getWarningMode());
p.profile = profile;
p.continueOnFailure = continueOnFailure;
p.offline = offline;
p.rerunTasks = rerunTasks;
p.refreshDependencies = refreshDependencies;
p.setParallelProjectExecutionEnabled(isParallelProjectExecutionEnabled());
p.buildCacheEnabled = buildCacheEnabled;
p.configureOnDemand = configureOnDemand;
p.setMaxWorkerCount(getMaxWorkerCount());
p.systemPropertiesArgs = new HashMap<>(systemPropertiesArgs);
p.writeDependencyLocks = writeDependencyLocks;
p.writeDependencyVerifications = writeDependencyVerifications;
p.lockedDependenciesToUpdate = new ArrayList<>(lockedDependenciesToUpdate);
p.verificationMode = verificationMode;
p.isRefreshKeys = isRefreshKeys;
p.isExportKeys = isExportKeys;
return p;
}
public boolean equals(Object obj) {
return EqualsBuilder.reflectionEquals(this, obj);
}
public int hashCode() {
return HashCodeBuilder.reflectionHashCode(this);
}
/**
* Returns the build file to use to select the default project. Returns null when the build file is not used to select the default project.
*
* @return The build file. May be null.
*/
@Nullable
public File getBuildFile() {
return buildFile;
}
/**
* Sets the build file to use to select the default project. Use null to disable selecting the default project using the build file.
*
* @param buildFile The build file. May be null.
*/
public void setBuildFile(@Nullable File buildFile) {
if (buildFile == null) {
this.buildFile = null;
setCurrentDir(null);
} else {
this.buildFile = FileUtils.canonicalize(buildFile);
setProjectDir(this.buildFile.getParentFile());
}
}
/**
* Specifies that an empty settings script should be used.
*
* This means that even if a settings file exists in the conventional location, or has been previously specified by {@link #setSettingsFile(File)}, it will not be used.
*
* If {@link #setSettingsFile(File)} is called after this, it will supersede calling this method.
*
* @return this
*/
public StartParameter useEmptySettings() {
DeprecationLogger.deprecateMethod(StartParameter.class, "useEmptySettings()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(6, "discontinued_methods")
.nagUser();
doUseEmptySettings();
return this;
}
protected void doUseEmptySettings() {
searchUpwards = false;
useEmptySettings = true;
settingsFile = null;
}
/**
* Returns whether an empty settings script will be used regardless of whether one exists in the default location.
*
* @return Whether to use empty settings or not.
*/
public boolean isUseEmptySettings() {
DeprecationLogger.deprecateMethod(StartParameter.class, "isUseEmptySettings()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(6, "discontinued_methods")
.nagUser();
return useEmptySettings;
}
/**
* Returns the names of the tasks to execute in this build. When empty, the default tasks for the project will be executed. If {@link TaskExecutionRequest}s are set for this build then names from these task parameters are returned.
*
* @return the names of the tasks to execute in this build. Never returns null.
*/
public List<String> getTaskNames() {
List<String> taskNames = Lists.newArrayList();
for (TaskExecutionRequest taskRequest : taskRequests) {
taskNames.addAll(taskRequest.getArgs());
}
return taskNames;
}
/**
* <p>Sets the tasks to execute in this build. Set to an empty list, or null, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency
* between the tasks.</p>
*
* @param taskNames the names of the tasks to execute in this build.
*/
public void setTaskNames(@Nullable Iterable<String> taskNames) {
if (taskNames == null) {
this.taskRequests = emptyList();
} else {
this.taskRequests = Arrays.asList(new DefaultTaskExecutionRequest(taskNames));
}
}
/**
* Returns the tasks to execute in this build. When empty, the default tasks for the project will be executed.
*
* @return the tasks to execute in this build. Never returns null.
*/
public List<TaskExecutionRequest> getTaskRequests() {
return taskRequests;
}
/**
* <p>Sets the task parameters to execute in this build. Set to an empty list, to execute the default tasks for the project. The tasks are executed in the order provided, subject to dependency
* between the tasks.</p>
*
* @param taskParameters the tasks to execute in this build.
*/
public void setTaskRequests(Iterable<? extends TaskExecutionRequest> taskParameters) {
this.taskRequests = Lists.newArrayList(taskParameters);
}
/**
* Returns the names of the tasks to be excluded from this build. When empty, no tasks are excluded from the build.
*
* @return The names of the excluded tasks. Returns an empty set if there are no such tasks.
*/
public Set<String> getExcludedTaskNames() {
return excludedTaskNames;
}
/**
* Sets the tasks to exclude from this build.
*
* @param excludedTaskNames The task names.
*/
public void setExcludedTaskNames(Iterable<String> excludedTaskNames) {
this.excludedTaskNames = Sets.newLinkedHashSet(excludedTaskNames);
}
/**
* Returns the directory to use to select the default project, and to search for the settings file.
*
* @return The current directory. Never returns null.
*/
public File getCurrentDir() {
return currentDir;
}
/**
* Sets the directory to use to select the default project, and to search for the settings file. Set to null to use the default current directory.
*
* @param currentDir The directory. Set to null to use the default.
*/
public void setCurrentDir(@Nullable File currentDir) {
if (currentDir != null) {
this.currentDir = FileUtils.canonicalize(currentDir);
} else {
this.currentDir = new BuildLayoutParameters().getCurrentDir();
}
}
public boolean isSearchUpwards() {
DeprecationLogger.deprecateMethod(StartParameter.class, "isSearchUpwards()")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(5, "search_upwards_related_apis_in_startparameter_have_been_deprecated")
.nagUser();
return searchUpwards;
}
public void setSearchUpwards(boolean searchUpwards) {
DeprecationLogger.deprecateMethod(StartParameter.class, "setSearchUpwards(boolean)")
.willBeRemovedInGradle7()
.withUpgradeGuideSection(5, "search_upwards_related_apis_in_startparameter_have_been_deprecated")
.nagUser();
this.searchUpwards = searchUpwards;
}
public Map<String, String> getProjectProperties() {
return projectProperties;
}
public void setProjectProperties(Map<String, String> projectProperties) {
this.projectProperties = projectProperties;
}
public Map<String, String> getSystemPropertiesArgs() {
return systemPropertiesArgs;
}
public void setSystemPropertiesArgs(Map<String, String> systemPropertiesArgs) {
this.systemPropertiesArgs = systemPropertiesArgs;
}
/**
* Returns the directory to use as the user home directory.
*
* @return The home directory.
*/
public File getGradleUserHomeDir() {
return gradleUserHomeDir;
}
/**
* Sets the directory to use as the user home directory. Set to null to use the default directory.
*
* @param gradleUserHomeDir The home directory. May be null.
*/
public void setGradleUserHomeDir(@Nullable File gradleUserHomeDir) {
this.gradleUserHomeDir = gradleUserHomeDir == null ? new BuildLayoutParameters().getGradleUserHomeDir() : FileUtils.canonicalize(gradleUserHomeDir);
}
/**
* Returns true if project dependencies are to be built, false if they should not be. The default is true.
*/
public boolean isBuildProjectDependencies() {
return buildProjectDependencies;
}
/**
* Specifies whether project dependencies should be built. Defaults to true.
*
* @return this
*/
public StartParameter setBuildProjectDependencies(boolean build) {
this.buildProjectDependencies = build;
return this;
}
public boolean isDryRun() {
return dryRun;
}
public void setDryRun(boolean dryRun) {
this.dryRun = dryRun;
}
/**
* Sets the settings file to use for the build. Use null to use the default settings file.
*
* @param settingsFile The settings file to use. May be null.
*/
public void setSettingsFile(@Nullable File settingsFile) {
if (settingsFile == null) {
this.settingsFile = null;
} else {
this.useEmptySettings = false;
this.settingsFile = FileUtils.canonicalize(settingsFile);
currentDir = this.settingsFile.getParentFile();
}
}
/**
* Returns the explicit settings file to use for the build, or null.
*
* Will return null if the default settings file is to be used. However, if {@link #isUseEmptySettings()} returns true, then no settings file at all will be used.
*
* @return The settings file. May be null.
* @see #isUseEmptySettings()
*/
@Nullable
public File getSettingsFile() {
return settingsFile;
}
/**
* Adds the given file to the list of init scripts that are run before the build starts. This list is in addition to the default init scripts.
*
* @param initScriptFile The init scripts.
*/
public void addInitScript(File initScriptFile) {
initScripts.add(initScriptFile);
}
/**
* Sets the list of init scripts to be run before the build starts. This list is in addition to the default init scripts.
*
* @param initScripts The init scripts.
*/
public void setInitScripts(List<File> initScripts) {
this.initScripts = initScripts;
}
/**
* Returns all explicitly added init scripts that will be run before the build starts. This list does not contain the user init script located in ${user.home}/.gradle/init.gradle, even though
* that init script will also be run.
*
* @return list of all explicitly added init scripts.
*/
public List<File> getInitScripts() {
return Collections.unmodifiableList(initScripts);
}
/**
* Returns all init scripts, including explicit init scripts and implicit init scripts.
*
* @return All init scripts, including explicit init scripts and implicit init scripts.
*/
public List<File> getAllInitScripts() {
CompositeInitScriptFinder initScriptFinder = new CompositeInitScriptFinder(
new UserHomeInitScriptFinder(getGradleUserHomeDir()),
new DistributionInitScriptFinder(gradleHomeDir)
);
List<File> scripts = new ArrayList<>(getInitScripts());
initScriptFinder.findScripts(scripts);
return Collections.unmodifiableList(scripts);
}
/**
* Sets the project directory to use to select the default project. Use null to use the default criteria for selecting the default project.
*
* @param projectDir The project directory. May be null.
*/
public void setProjectDir(@Nullable File projectDir) {
if (projectDir == null) {
setCurrentDir(null);
this.projectDir = null;
} else {
File canonicalFile = FileUtils.canonicalize(projectDir);
currentDir = canonicalFile;
this.projectDir = canonicalFile;
}
}
/**
* Returns the project dir to use to select the default project.
*
* Returns null when the build file is not used to select the default project
*
* @return The project dir. May be null.
*/
@Nullable
public File getProjectDir() {
return projectDir;
}
/**
* Specifies if a profile report should be generated.
*
* @param profile true if a profile report should be generated
*/
public void setProfile(boolean profile) {
this.profile = profile;
}
/**
* Returns true if a profile report will be generated.
*/
public boolean isProfile() {
return profile;
}
/**
* Specifies whether the build should continue on task failure. The default is false.
*/
public boolean isContinueOnFailure() {
return continueOnFailure;
}
/**
* Specifies whether the build should continue on task failure. The default is false.
*/
public void setContinueOnFailure(boolean continueOnFailure) {
this.continueOnFailure = continueOnFailure;
}
/**
* Specifies whether the build should be performed offline (ie without network access).
*/
public boolean isOffline() {
return offline;
}
/**
* Specifies whether the build should be performed offline (ie without network access).
*/
public void setOffline(boolean offline) {
this.offline = offline;
}
/**
* Specifies whether the dependencies should be refreshed..
*/
public boolean isRefreshDependencies() {
return refreshDependencies;
}
/**
* Specifies whether the dependencies should be refreshed..
*/
public void setRefreshDependencies(boolean refreshDependencies) {
this.refreshDependencies = refreshDependencies;
}
/**
* Specifies whether the cached task results should be ignored and each task should be forced to be executed.
*/
public boolean isRerunTasks() {
return rerunTasks;
}
/**
* Specifies whether the cached task results should be ignored and each task should be forced to be executed.
*/
public void setRerunTasks(boolean rerunTasks) {
this.rerunTasks = rerunTasks;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isParallelProjectExecutionEnabled() {
return parallelismConfiguration.isParallelProjectExecutionEnabled();
}
/**
* {@inheritDoc}
*/
@Override
public void setParallelProjectExecutionEnabled(boolean parallelProjectExecution) {
parallelismConfiguration.setParallelProjectExecutionEnabled(parallelProjectExecution);
}
/**
* Returns true if the build cache is enabled.
*
* @since 3.5
*/
public boolean isBuildCacheEnabled() {
return buildCacheEnabled;
}
/**
* Enables/disables the build cache.
*
* @since 3.5
*/
public void setBuildCacheEnabled(boolean buildCacheEnabled) {
this.buildCacheEnabled = buildCacheEnabled;
}
/**
* Whether build cache debug logging is enabled.
*
* @since 4.6
*/
public boolean isBuildCacheDebugLogging() {
return buildCacheDebugLogging;
}
/**
* Whether build cache debug logging is enabled.
*
* @since 4.6
*/
public void setBuildCacheDebugLogging(boolean buildCacheDebugLogging) {
this.buildCacheDebugLogging = buildCacheDebugLogging;
}
/**
* Whether watching the file system for faster up-to-date checking is enabled.
*
* @since 6.5
*/
@Incubating
public void setWatchFileSystem(boolean watchFileSystem) {
this.watchFileSystem = watchFileSystem;
}
/**
* Whether watching the file system for faster up-to-date checking is enabled.
*
* @since 6.5
*/
@Incubating
public boolean isWatchFileSystem() {
return watchFileSystem;
}
/**
* {@inheritDoc}
*/
@Override
public int getMaxWorkerCount() {
return parallelismConfiguration.getMaxWorkerCount();
}
/**
* {@inheritDoc}
*/
@Override
public void setMaxWorkerCount(int maxWorkerCount) {
parallelismConfiguration.setMaxWorkerCount(maxWorkerCount);
}
/**
* If the configure-on-demand mode is active
*/
@Incubating
public boolean isConfigureOnDemand() {
return configureOnDemand;
}
@Override
public String toString() {
return "StartParameter{"
+ "taskRequests=" + taskRequests
+ ", excludedTaskNames=" + excludedTaskNames
+ ", currentDir=" + currentDir
+ ", searchUpwards=" + searchUpwards
+ ", projectProperties=" + projectProperties
+ ", systemPropertiesArgs=" + systemPropertiesArgs
+ ", gradleUserHomeDir=" + gradleUserHomeDir
+ ", gradleHome=" + gradleHomeDir
+ ", logLevel=" + getLogLevel()
+ ", showStacktrace=" + getShowStacktrace()
+ ", buildFile=" + buildFile
+ ", initScripts=" + initScripts
+ ", dryRun=" + dryRun
+ ", rerunTasks=" + rerunTasks
+ ", offline=" + offline
+ ", refreshDependencies=" + refreshDependencies
+ ", parallelProjectExecution=" + isParallelProjectExecutionEnabled()
+ ", configureOnDemand=" + configureOnDemand
+ ", maxWorkerCount=" + getMaxWorkerCount()
+ ", buildCacheEnabled=" + buildCacheEnabled
+ ", writeDependencyLocks=" + writeDependencyLocks
+ ", verificationMode=" + verificationMode
+ ", refreshKeys=" + isRefreshKeys
+ '}';
}
/**
* Package scope for testing purposes.
*/
void setGradleHomeDir(File gradleHomeDir) {
this.gradleHomeDir = gradleHomeDir;
}
@Incubating
public void setConfigureOnDemand(boolean configureOnDemand) {
this.configureOnDemand = configureOnDemand;
}
public boolean isContinuous() {
return continuous;
}
public void setContinuous(boolean enabled) {
this.continuous = enabled;
}
public void includeBuild(File includedBuild) {
includedBuilds.add(includedBuild);
}
public void setIncludedBuilds(List<File> includedBuilds) {
this.includedBuilds = includedBuilds;
}
public List<File> getIncludedBuilds() {
return Collections.unmodifiableList(includedBuilds);
}
/**
* Returns true if build scan should be created.
*
* @since 3.4
*/
public boolean isBuildScan() {
return buildScan;
}
/**
* Specifies whether a build scan should be created.
*
* @since 3.4
*/
public void setBuildScan(boolean buildScan) {
this.buildScan = buildScan;
}
/**
* Returns true when build scan creation is explicitly disabled.
*
* @since 3.4
*/
public boolean isNoBuildScan() {
return noBuildScan;
}
/**
* Specifies whether build scan creation is explicitly disabled.
*
* @since 3.4
*/
public void setNoBuildScan(boolean noBuildScan) {
this.noBuildScan = noBuildScan;
}
/**
* Specifies whether dependency resolution needs to be persisted for locking
*
* @since 4.8
*/
public void setWriteDependencyLocks(boolean writeDependencyLocks) {
this.writeDependencyLocks = writeDependencyLocks;
}
/**
* Returns true when dependency resolution is to be persisted for locking
*
* @since 4.8
*/
public boolean isWriteDependencyLocks() {
return writeDependencyLocks;
}
/**
* Indicates that specified dependencies are to be allowed to update their version.
* Implicitly activates dependency locking persistence.
*
* @param lockedDependenciesToUpdate the modules to update
* @see #isWriteDependencyLocks()
* @since 4.8
*/
public void setLockedDependenciesToUpdate(List<String> lockedDependenciesToUpdate) {
this.lockedDependenciesToUpdate = Lists.newArrayList(lockedDependenciesToUpdate);
this.writeDependencyLocks = true;
}
/**
* Indicates if a dependency verification metadata file should be written at the
* end of this build. If the list is not empty, then it means we need to generate
* or update the dependency verification file with the checksums specified in the
* list.
*
* @since 6.1
*/
@Incubating
public List<String> getWriteDependencyVerifications() {
return writeDependencyVerifications;
}
/**
* Tells if a dependency verification metadata file should be written at the end
* of this build.
*
* @param checksums the list of checksums to generate
* @since 6.1
*/
@Incubating
public void setWriteDependencyVerifications(List<String> checksums) {
this.writeDependencyVerifications = checksums;
}
/**
* Returns the list of modules that are to be allowed to update their version compared to the lockfile.
*
* @return a list of modules allowed to have a version update
* @since 4.8
*/
public List<String> getLockedDependenciesToUpdate() {
return lockedDependenciesToUpdate;
}
/**
* Sets the dependency verification mode. There are three different modes:
* <ul>
* <li><i>strict</i>, the default, verification is enabled as soon as a dependency verification file is present.</li>
* <li><i>lenient</i>, in this mode, failure to verify a checksum, missing checksums or signatures will be logged
* but will not fail the build. This mode should only be used when updating dependencies as it is inherently unsafe.</li>
* <li><i>off</i>, this mode disables all verifications</li>
* </ul>
*
* @param verificationMode if true, enables lenient dependency verification
* @since 6.2
*/
@Incubating
public void setDependencyVerificationMode(DependencyVerificationMode verificationMode) {
this.verificationMode = verificationMode;
}
/**
* Returns the dependency verification mode.
*
* @since 6.2
*/
@Incubating
public DependencyVerificationMode getDependencyVerificationMode() {
return verificationMode;
}
/**
* Sets the key refresh flag.
*
* @param refresh If set to true, missing keys will be checked again. By default missing keys are cached for 24 hours.
* @since 6.2
*/
@Incubating
public void setRefreshKeys(boolean refresh) {
isRefreshKeys = refresh;
}
/**
* If true, Gradle will try to download missing keys again.
*
* @since 6.2
*/
@Incubating
public boolean isRefreshKeys() {
return isRefreshKeys;
}
/**
* If true, after writing the dependency verification file, a public keyring
* file will be generated with all keys seen during generation of the file.
*
* This file can then be used as a source for public keys instead of reaching
* out public key servers.
*
* @return true if keys should be exported
* @since 6.2
*/
@Incubating
public boolean isExportKeys() {
return isExportKeys;
}
/**
* If true, after writing the dependency verification file, a public keyring
* file will be generated with all keys seen during generation of the file.
*
* This file can then be used as a source for public keys instead of reaching
* out public key servers.
*
* @param exportKeys set to true if keys should be exported
* @since 6.2
*/
@Incubating
public void setExportKeys(boolean exportKeys) {
isExportKeys = exportKeys;
}
}
| Address review comment
| subprojects/core-api/src/main/java/org/gradle/StartParameter.java | Address review comment | <ide><path>ubprojects/core-api/src/main/java/org/gradle/StartParameter.java
<ide> * @since 6.5
<ide> */
<ide> @Incubating
<add> public boolean isWatchFileSystem() {
<add> return watchFileSystem;
<add> }
<add>
<add> /**
<add> * Whether watching the file system for faster up-to-date checking is enabled.
<add> *
<add> * @since 6.5
<add> */
<add> @Incubating
<ide> public void setWatchFileSystem(boolean watchFileSystem) {
<ide> this.watchFileSystem = watchFileSystem;
<del> }
<del>
<del> /**
<del> * Whether watching the file system for faster up-to-date checking is enabled.
<del> *
<del> * @since 6.5
<del> */
<del> @Incubating
<del> public boolean isWatchFileSystem() {
<del> return watchFileSystem;
<ide> }
<ide>
<ide> /** |
|
Java | lgpl-2.1 | 8d78409b12bc65ee1cd0140606c0346708f838f3 | 0 | xwiki-contrib/xwiki-restserver,xwiki-contrib/xwiki-restserver | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.contrib.rest.configuration;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import javax.inject.Inject;
import org.jdom2.Document;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.slf4j.Logger;
import org.xwiki.component.phase.Initializable;
import org.xwiki.component.phase.InitializationException;
/**
* @version $Id: $
*/
public abstract class AbstractXMLConfiguration implements XMLConfiguration, Initializable
{
@Inject
protected Logger logger;
protected Document xmlDocument;
private ArrayList<Path> configurationLocations = new ArrayList<>();
@Override
public void initialize() throws InitializationException
{
loadConfiguration();
}
/**
* Add a location where the configuration file could be located.
* @param location the configuration location
*/
protected void addLocation(Path location)
{
configurationLocations.add(location);
}
protected void loadConfiguration()
{
try {
Path location = getConfigurationLocation();
if (location != null) {
xmlDocument = new SAXBuilder().build(location.toFile());
}
} catch (JDOMException | IOException e) {
logger.error("Failed to parse the configuration file.", e);
}
}
private Path getConfigurationLocation()
{
String configuredLocation = System.getProperty("config");
if (configuredLocation != null) {
Path location = Paths.get(configuredLocation);
configurationLocations.add(0, location);
if (Files.notExists(location)) {
logger.warn("No configuration [{}] has been found.", location);
}
}
for (Path location : configurationLocations) {
logger.debug("Try [{}] as configuration.", location);
if (Files.exists(location)) {
logger.info("Using [{}] as configuration.", location);
return location;
}
}
logger.warn("No configuration file found. Use default values instead.");
return null;
}
@Override
public Document getXML()
{
return xmlDocument;
}
@Override
public void reload()
{
loadConfiguration();
}
}
| xwiki-restserver-configuration/xwiki-restserver-configuration-xml/src/main/java/org/xwiki/contrib/rest/configuration/AbstractXMLConfiguration.java | /*
* See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.xwiki.contrib.rest.configuration;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import javax.inject.Inject;
import org.jdom2.Document;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.slf4j.Logger;
import org.xwiki.component.phase.Initializable;
import org.xwiki.component.phase.InitializationException;
/**
* @version $Id: $
*/
public abstract class AbstractXMLConfiguration implements XMLConfiguration, Initializable
{
@Inject
protected Logger logger;
protected Document xmlDocument;
private ArrayList<Path> configurationLocations = new ArrayList<>();
@Override
public void initialize() throws InitializationException
{
loadConfiguration();
}
/**
* Add a location where the configuration file could be located.
* @param location the configuration location
*/
protected void addLocation(Path location)
{
configurationLocations.add(location);
}
protected void loadConfiguration()
{
try {
Path location = getConfigurationLocation();
if (location != null) {
xmlDocument = new SAXBuilder().build(location.toFile());
}
} catch (JDOMException | IOException e) {
logger.error("Failed to parse the configuration file.", e);
}
}
private Path getConfigurationLocation()
{
String configuredLocation = System.getProperty("config");
if (configuredLocation != null) {
Path location = Paths.get(configuredLocation);
configurationLocations.add(0, location);
if (Files.notExists(location)) {
logger.warn("No configuration [{}] has been found.", location);
}
}
for (Path location : configurationLocations) {
if (Files.exists(location)) {
logger.info("Using [{}] as configuration.", location);
return location;
}
}
logger.warn("No configuration file found. Use default values instead.");
return null;
}
@Override
public Document getXML()
{
return xmlDocument;
}
@Override
public void reload()
{
loadConfiguration();
}
}
| [Misc] Adding a log info.
| xwiki-restserver-configuration/xwiki-restserver-configuration-xml/src/main/java/org/xwiki/contrib/rest/configuration/AbstractXMLConfiguration.java | [Misc] Adding a log info. | <ide><path>wiki-restserver-configuration/xwiki-restserver-configuration-xml/src/main/java/org/xwiki/contrib/rest/configuration/AbstractXMLConfiguration.java
<ide> }
<ide>
<ide> for (Path location : configurationLocations) {
<add> logger.debug("Try [{}] as configuration.", location);
<ide> if (Files.exists(location)) {
<ide> logger.info("Using [{}] as configuration.", location);
<ide> return location; |
|
JavaScript | mit | c21cd065d05a8f2802b2befca722279f9cdd04ce | 0 | janko33bd/copay,janko33bd/copay,janko33bd/copay | 'use strict';
angular.module('copayApp.services').factory('fingerprintService', function ($log, gettextCatalog, configService, platformInfo) {
var root = {};
var _isAvailable = false;
if (platformInfo.isCordova && !platformInfo.isWP) {
window.plugins.touchid = window.plugins.touchid || {};
window.plugins.touchid.isAvailable(
function (msg) {
_isAvailable = 'IOS';
},
function (msg) {
FingerprintAuth.isAvailable(function (result) {
if (result.isAvailable)
_isAvailable = 'ANDROID';
}, function () {
_isAvailable = false;
});
});
};
var requestFinger = function (cb) {
try {
FingerprintAuth.encrypt({
clientId: 'Copay'
},
function (result) {
if (result.withFingerprint) {
$log.debug('Finger OK');
return cb();
} else if (result.withPassword) {
$log.debug("Finger: Authenticated with backup password");
return cb();
}
},
function (msg) {
$log.debug('Finger Failed:' + JSON.stringify(msg));
return cb(gettextCatalog.getString('Finger Scan Failed'));
}
);
} catch (e) {
$log.warn('Finger Scan Failed:' + JSON.stringify(e));
return cb(gettextCatalog.getString('Finger Scan Failed'));
};
};
var requestTouchId = function (cb) {
try {
window.plugins.touchid.verifyFingerprint(
gettextCatalog.getString('Scan your fingerprint please'),
function (msg) {
$log.debug('Touch ID OK');
return cb();
},
function (msg) {
$log.debug('Touch ID Failed:' + JSON.stringify(msg));
return cb(gettextCatalog.getString('Touch ID Failed'));
}
);
} catch (e) {
$log.debug('Touch ID Failed:' + JSON.stringify(e));
return cb(gettextCatalog.getString('Touch ID Failed'));
};
};
var isNeeded = function (client) {
if (!_isAvailable) return false;
if (client === 'unlockingApp') return true;
var config = configService.getSync();
config.touchIdFor = config.touchIdFor || {};
return config.touchIdFor[client.credentials.walletId];
};
root.isAvailable = function (client) {
return _isAvailable;
};
root.check = function (client, cb) {
if (isNeeded(client)) {
$log.debug('FingerPrint Service:', _isAvailable);
if (_isAvailable == 'IOS')
return requestTouchId(cb);
else
return requestFinger(cb);
} else {
return cb();
}
};
return root;
});
| src/js/services/fingerprintService.js | 'use strict';
angular.module('copayApp.services').factory('fingerprintService', function($log, gettextCatalog, configService, platformInfo) {
var root = {};
var _isAvailable = false;
if (platformInfo.isCordova && !platformInfo.isWP) {
window.plugins.touchid = window.plugins.touchid || {};
window.plugins.touchid.isAvailable(
function(msg) {
_isAvailable = 'IOS';
},
function(msg) {
FingerprintAuth.isAvailable(function(result) {
if (result.isAvailable)
_isAvailable = 'ANDROID';
}, function() {
_isAvailable = false;
});
});
};
var requestFinger = function(cb) {
try {
FingerprintAuth.show({
clientId: 'Copay',
clientSecret: 'hVu1NvCZOyUuGgr46bFL',
},
function(result) {
if (result.withFingerprint) {
$log.debug('Finger OK');
return cb();
} else if (result.withPassword) {
$log.debug("Finger: Authenticated with backup password");
return cb();
}
},
function(msg) {
$log.debug('Finger Failed:' + JSON.stringify(msg));
return cb(gettextCatalog.getString('Finger Scan Failed'));
}
);
} catch (e) {
$log.warn('Finger Scan Failed:' + JSON.stringify(e));
return cb(gettextCatalog.getString('Finger Scan Failed'));
};
};
var requestTouchId = function(cb) {
try {
window.plugins.touchid.verifyFingerprint(
gettextCatalog.getString('Scan your fingerprint please'),
function(msg) {
$log.debug('Touch ID OK');
return cb();
},
function(msg) {
$log.debug('Touch ID Failed:' + JSON.stringify(msg));
return cb(gettextCatalog.getString('Touch ID Failed'));
}
);
} catch (e) {
$log.debug('Touch ID Failed:' + JSON.stringify(e));
return cb(gettextCatalog.getString('Touch ID Failed'));
};
};
var isNeeded = function(client) {
if (!_isAvailable) return false;
if (client === 'unlockingApp') return true;
var config = configService.getSync();
config.touchIdFor = config.touchIdFor || {};
return config.touchIdFor[client.credentials.walletId];
};
root.isAvailable = function(client) {
return _isAvailable;
};
root.check = function(client, cb) {
if (isNeeded(client)) {
$log.debug('FingerPrint Service:', _isAvailable);
if (_isAvailable == 'IOS')
return requestTouchId(cb);
else
return requestFinger(cb);
} else {
return cb();
}
};
return root;
});
| Fix: fingerprint function updated for android
| src/js/services/fingerprintService.js | Fix: fingerprint function updated for android | <ide><path>rc/js/services/fingerprintService.js
<ide> 'use strict';
<ide>
<del>angular.module('copayApp.services').factory('fingerprintService', function($log, gettextCatalog, configService, platformInfo) {
<add>angular.module('copayApp.services').factory('fingerprintService', function ($log, gettextCatalog, configService, platformInfo) {
<ide> var root = {};
<ide>
<ide> var _isAvailable = false;
<ide> if (platformInfo.isCordova && !platformInfo.isWP) {
<ide> window.plugins.touchid = window.plugins.touchid || {};
<ide> window.plugins.touchid.isAvailable(
<del> function(msg) {
<add> function (msg) {
<ide> _isAvailable = 'IOS';
<ide> },
<del> function(msg) {
<del> FingerprintAuth.isAvailable(function(result) {
<add> function (msg) {
<add> FingerprintAuth.isAvailable(function (result) {
<ide>
<ide> if (result.isAvailable)
<ide> _isAvailable = 'ANDROID';
<ide>
<del> }, function() {
<add> }, function () {
<ide> _isAvailable = false;
<ide> });
<ide> });
<ide> };
<ide>
<del> var requestFinger = function(cb) {
<add> var requestFinger = function (cb) {
<ide> try {
<del> FingerprintAuth.show({
<del> clientId: 'Copay',
<del> clientSecret: 'hVu1NvCZOyUuGgr46bFL',
<del> },
<del> function(result) {
<add> FingerprintAuth.encrypt({
<add> clientId: 'Copay'
<add> },
<add> function (result) {
<ide> if (result.withFingerprint) {
<ide> $log.debug('Finger OK');
<ide> return cb();
<ide> return cb();
<ide> }
<ide> },
<del> function(msg) {
<add> function (msg) {
<ide> $log.debug('Finger Failed:' + JSON.stringify(msg));
<ide> return cb(gettextCatalog.getString('Finger Scan Failed'));
<ide> }
<ide> };
<ide>
<ide>
<del> var requestTouchId = function(cb) {
<add> var requestTouchId = function (cb) {
<ide> try {
<ide> window.plugins.touchid.verifyFingerprint(
<ide> gettextCatalog.getString('Scan your fingerprint please'),
<del> function(msg) {
<add> function (msg) {
<ide> $log.debug('Touch ID OK');
<ide> return cb();
<ide> },
<del> function(msg) {
<add> function (msg) {
<ide> $log.debug('Touch ID Failed:' + JSON.stringify(msg));
<ide> return cb(gettextCatalog.getString('Touch ID Failed'));
<ide> }
<ide> };
<ide> };
<ide>
<del> var isNeeded = function(client) {
<add> var isNeeded = function (client) {
<ide> if (!_isAvailable) return false;
<ide> if (client === 'unlockingApp') return true;
<ide>
<ide> return config.touchIdFor[client.credentials.walletId];
<ide> };
<ide>
<del> root.isAvailable = function(client) {
<add> root.isAvailable = function (client) {
<ide> return _isAvailable;
<ide> };
<ide>
<del> root.check = function(client, cb) {
<add> root.check = function (client, cb) {
<ide> if (isNeeded(client)) {
<ide> $log.debug('FingerPrint Service:', _isAvailable);
<ide> if (_isAvailable == 'IOS') |
|
Java | mit | d6016c62eb6857895f23c0bb3959aa35a1085b37 | 0 | Cornutum/tcases,Cornutum/tcases,Cornutum/tcases | //////////////////////////////////////////////////////////////////////////////
//
// Copyright 2020, Cornutum Project
// www.cornutum.org
//
//////////////////////////////////////////////////////////////////////////////
package org.cornutum.tcases.openapi.moco;
import org.cornutum.tcases.io.IndentedWriter;
import org.cornutum.tcases.openapi.resolver.RequestCase;
import org.cornutum.tcases.openapi.testwriter.JUnitTestWriter;
import org.cornutum.tcases.openapi.testwriter.JavaTestTarget;
import org.cornutum.tcases.openapi.testwriter.TestCaseWriter;
import org.cornutum.tcases.util.ListBuilder;
import org.cornutum.tcases.util.ToString;
import java.net.URI;
import java.util.List;
import java.util.Optional;
import static java.util.stream.Collectors.joining;
/**
* A {@link JUnitTestWriter} for API tests that use a <a href="https://github.com/dreamhead/moco/blob/master/moco-doc/junit.md">Moco server</a>
*/
public abstract class MocoServerTestWriter extends JUnitTestWriter
{
/**
* Creates a new MocoServerTestWriter instance.
*/
protected MocoServerTestWriter( MocoServerConfig serverConfig, CertConfig certConfig, TestCaseWriter testCaseWriter)
{
super( testCaseWriter);
setConfigWriter( writerFor( serverConfig));
getConfigWriter().setCertConfigWriter( writerFor( certConfig));
}
/**
* Returns a URI for the API server used by the given test case. If non-null, this supersedes
* the server URI defined by this {@link RequestCase request case}.
*/
protected URI getTestServer( RequestCase requestCase)
{
return getConfigWriter().getTestServer( requestCase);
}
/**
* Returns the URI scheme used in requests to the Moco server.
*/
public String getServerScheme()
{
// By default, use "http"
return "http";
}
/**
* Returns the Moco server class name for this test writer.
*/
protected abstract String getServerClass();
/**
* Returns the Moco server factory method for this test writer.
*/
protected abstract String getServerFactory();
/**
* Returns the Moco server factory arguments for this test writer.
*/
protected List<String> getServerFactoryArgs()
{
return getConfigWriter().getServerFactoryConfigArgs();
}
/**
* Returns the MocoJunitRunner factory method for this test writer.
*/
protected abstract String getRunnerFactory();
/**
* Returns the MocoJunitRunner factory arguments for this test writer.
*/
protected List<String> getRunnerFactoryArgs()
{
return getConfigWriter().getRunnerFactoryConfigArgs();
}
/**
* Writes the target test dependencies to the given stream.
*/
protected void writeDependencies( JavaTestTarget target, String testName, IndentedWriter targetWriter)
{
super.writeDependencies( target, testName, targetWriter);
targetWriter.println();
targetWriter.println( "import com.github.dreamhead.moco.junit.MocoJunitRunner;");
targetWriter.println( "import static com.github.dreamhead.moco.Moco.*;");
writeConfigDependencies( targetWriter);
}
/**
* Writes the target test dependencies for the POJO server configuration to the given stream.
*/
protected abstract void writePojoDependencies( IndentedWriter targetWriter);
/**
* Writes the target test declarations to the given stream.
*/
protected void writeDeclarations( JavaTestTarget target, String testName, IndentedWriter targetWriter)
{
super.writeDeclarations( target, testName, targetWriter);
writeConfigInit( targetWriter);
writeConfigRule( targetWriter);
}
/**
* Writes server configuration dependencies to the given stream.
*/
protected void writeConfigDependencies( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigDependencies( targetWriter);
}
/**
* Writes server configuration initializations to the given stream.
*/
protected void writeConfigInit( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigInit( targetWriter);
}
/**
* Writes the server configuration TestRule to the given stream.
*/
protected void writeConfigRule( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigRule( targetWriter);
}
/**
* Changes the {@link MocoServerTestWriter.ConfigWriter} for this test writer.
*/
private void setConfigWriter( ConfigWriter<?> configWriter)
{
configWriter_ = configWriter;
}
/**
* Returns the {@link MocoServerTestWriter.ConfigWriter} for this test writer.
*/
protected ConfigWriter<?> getConfigWriter()
{
return configWriter_;
}
private ConfigWriter<?> writerFor( MocoServerConfig config)
{
ConfigWriterVisitor visitor = new ConfigWriterVisitor();
config.accept( visitor);
return visitor.configWriter_;
}
private Optional<CertConfigWriter<?>> writerFor( CertConfig certConfig)
{
return
Optional.ofNullable( certConfig)
.map( config -> {
CertConfigWriterVisitor visitor = new CertConfigWriterVisitor();
config.accept( visitor);
return visitor.certConfigWriter_;
});
}
public String toString()
{
return
ToString.getBuilder( this)
.append( getConfigWriter().getConfig())
.build();
}
private ConfigWriter<?> configWriter_;
/**
* Base class for server configuration writers.
*/
private abstract class ConfigWriter<C extends MocoServerConfig>
{
/**
* Creates a new ConfigWriter instance.
*/
protected ConfigWriter( C config)
{
config_ = config;
}
/**
* Returns the {@link MocoServerConfig} for this test writer.
*/
protected C getConfig()
{
return config_;
}
/**
* Writes server configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
targetWriter.println( String.format( "import org.junit.%s;", getConfig().getRuleType()));
getCertConfigWriter().ifPresent( cert -> cert.writeConfigDependencies( targetWriter));
}
/**
* Writes server configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
getCertConfigWriter().ifPresent( cert -> cert.writeConfigInit( targetWriter));
}
/**
* Writes the server configuration TestRule to the given stream.
*/
public void writeConfigRule( IndentedWriter targetWriter)
{
String ruleType = getConfig().getRuleType();
targetWriter.println();
targetWriter.println( String.format( "@%s", ruleType));
targetWriter.println(
String.format(
"public %sMocoJunitRunner runner = MocoJunitRunner.%s( %s);",
ruleType.equals( "ClassRule")? "static " : "",
getRunnerFactoryConfig(),
getRunnerFactoryArgs().stream().collect( joining( ", "))));
}
/**
* Returns the Moco server factory arguments for this server configuration.
*/
public List<String> getServerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args.add( String.valueOf( getConfig().getPort()));
getCertConfigWriter().ifPresent( cert -> cert.getServerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return getRunnerFactory();
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public abstract List<String> getRunnerFactoryConfigArgs();
/**
* Returns a URI for the API server used by the given test case. If non-null, this supersedes
* the server URI defined by this {@link RequestCase request case}.
*/
public URI getTestServer( RequestCase requestCase)
{
try
{
return new URI( getServerScheme(), null, "localhost", getConfig().getPort(), null, null, null);
}
catch( Exception e)
{
throw new IllegalArgumentException( "Can't define test server URI", e);
}
}
/**
* Changes the {@link HttpsServerTestWriter.CertConfigWriter} for this test writer.
*/
private void setCertConfigWriter( Optional<CertConfigWriter<?>> certConfigWriter)
{
certConfigWriter_ = certConfigWriter;
}
/**
* Returns the {@link HttpsServerTestWriter.CertConfigWriter} for this test writer.
*/
protected Optional<CertConfigWriter<?>> getCertConfigWriter()
{
return certConfigWriter_;
}
private final C config_;
private Optional<CertConfigWriter<?>> certConfigWriter_;
}
/**
* Writes test definitions based on {@link MocoServerConfigFile} configuration.
*/
private class ConfigFileWriter extends ConfigWriter<MocoServerConfigFile>
{
/**
* Creates a new ConfigFileWriter instance.
*/
public ConfigFileWriter( MocoServerConfigFile config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return
String.format(
"json%s%s",
getRunnerFactory().substring( 0, 1).toUpperCase(),
getRunnerFactory().substring( 1));
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.valueOf( getConfig().getPort()))
.add( String.format( "file( \"%s\")", getConfig().getPath()));
getCertConfigWriter().ifPresent( cert -> cert.getRunnerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
}
/**
* Writes test definitions based on {@link MocoServerConfigResource} configuration.
*/
private class ConfigResourceWriter extends ConfigWriter<MocoServerConfigResource>
{
/**
* Creates a new ConfigResourceWriter instance.
*/
public ConfigResourceWriter( MocoServerConfigResource config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return
String.format(
"json%s%s",
getRunnerFactory().substring( 0, 1).toUpperCase(),
getRunnerFactory().substring( 1));
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.valueOf( getConfig().getPort()))
.add( String.format( "pathResource( \"%s\")", getConfig().getPath()));
getCertConfigWriter().ifPresent( cert -> cert.getRunnerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
}
/**
* Writes test definitions based on {@link MocoServerConfigPojo} configuration.
*/
private class ConfigPojoWriter extends ConfigWriter<MocoServerConfigPojo>
{
/**
* Creates a new ConfigPojoWriter instance.
*/
public ConfigPojoWriter( MocoServerConfigPojo config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
/**
* Writes server configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
super.writeConfigDependencies( targetWriter);
writePojoDependencies( targetWriter);
}
/**
* Writes server configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
super.writeConfigInit( targetWriter);
targetWriter.println();
targetWriter.println( String.format( "private static %s %s;", getServerClass(), getConfig().getName()));
targetWriter.println();
targetWriter.println( "static {");
targetWriter.indent();
targetWriter.println(
String.format(
"%s = %s( %s);",
getConfig().getName(),
getServerFactory(),
getServerFactoryArgs().stream().collect( joining( ", "))));
Optional.ofNullable( getConfig().getPojoWriter())
.ifPresent( pojoWriter -> pojoWriter.writePojo( getConfig().getName(), targetWriter));
targetWriter.unindent();
targetWriter.println( "}");
}
}
/**
* Creates a {@link ConfigWriter} for a {@link MocoServerConfig} instance.
*/
private class ConfigWriterVisitor implements ConfigVisitor
{
public void visit( MocoServerConfigFile config)
{
configWriter_ = new ConfigFileWriter( config);
}
public void visit( MocoServerConfigResource config)
{
configWriter_ = new ConfigResourceWriter( config);
}
public void visit( MocoServerConfigPojo config)
{
configWriter_ = new ConfigPojoWriter( config);
}
private ConfigWriter<?> configWriter_;
}
/**
* Base class for certificate configuration writers.
*/
private static abstract class CertConfigWriter<C extends CertConfig>
{
/**
* Creates a new CertConfigWriter instance.
*/
protected CertConfigWriter( C config)
{
config_ = config;
}
/**
* Returns the {@link CertConfig} for this test writer.
*/
protected C getConfig()
{
return config_;
}
/**
* Writes certificate configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
targetWriter.println( "import com.github.dreamhead.moco.HttpsCertificate;");
targetWriter.println( "import static com.github.dreamhead.moco.HttpsCertificate.certificate;");
}
/**
* Writes certificate configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
targetWriter.println(
String.format(
"private static final HttpsCertificate %s = certificate( %s);",
getConfig().getName(),
getCertFactoryConfigArgs().stream().collect( joining( ", "))));
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected abstract List<String> getCertFactoryConfigArgs();
/**
* Returns the server factory arguments for certificate configuration.
*/
public List<String> getServerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
/**
* Returns the MocoJunitRunner factory arguments for certificate configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
private final C config_;
}
/**
* Writes test definitions based on {@link CertConfigFile} configuration.
*/
private static class CertConfigFileWriter extends CertConfigWriter<CertConfigFile>
{
/**
* Creates a new CertConfigFileWriter instance.
*/
public CertConfigFileWriter( CertConfigFile certConfig)
{
super( certConfig);
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected List<String> getCertFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.format( "file( \"%s\")", getConfig().getPath()))
.add( String.format( "\"%s\"", getConfig().getKeyStorePassword()))
.add( String.format( "\"%s\"", getConfig().getCertPassword()));
return args.build();
}
}
/**
* Writes test definitions based on {@link CertConfigResource} configuration.
*/
private static class CertConfigResourceWriter extends CertConfigWriter<CertConfigResource>
{
/**
* Creates a new CertConfigResourceWriter instance.
*/
public CertConfigResourceWriter( CertConfigResource certConfig)
{
super( certConfig);
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected List<String> getCertFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.format( "pathResource( \"%s\")", getConfig().getPath()))
.add( String.format( "\"%s\"", getConfig().getKeyStorePassword()))
.add( String.format( "\"%s\"", getConfig().getCertPassword()));
return args.build();
}
}
/**
* Creates a {@link CertConfigWriter} for a {@link CertConfig} instance.
*/
private static class CertConfigWriterVisitor implements CertConfigVisitor
{
public void visit( CertConfigFile certConfig)
{
certConfigWriter_ = new CertConfigFileWriter( certConfig);
}
public void visit( CertConfigResource certConfig)
{
certConfigWriter_ = new CertConfigResourceWriter( certConfig);
}
private CertConfigWriter<?> certConfigWriter_;
}
}
| tcases-moco/src/main/java/org/cornutum/tcases/openapi/moco/MocoServerTestWriter.java | //////////////////////////////////////////////////////////////////////////////
//
// Copyright 2020, Cornutum Project
// www.cornutum.org
//
//////////////////////////////////////////////////////////////////////////////
package org.cornutum.tcases.openapi.moco;
import org.cornutum.tcases.io.IndentedWriter;
import org.cornutum.tcases.openapi.resolver.RequestCase;
import org.cornutum.tcases.openapi.testwriter.JUnitTestWriter;
import org.cornutum.tcases.openapi.testwriter.JavaTestTarget;
import org.cornutum.tcases.openapi.testwriter.TestCaseWriter;
import org.cornutum.tcases.util.ListBuilder;
import org.cornutum.tcases.util.ToString;
import java.net.URI;
import java.util.List;
import java.util.Optional;
import static java.util.stream.Collectors.joining;
/**
* A {@link JUnitTestWriter} for API tests that use a <a href="https://github.com/dreamhead/moco/blob/master/moco-doc/junit.md">Moco server</a>
*/
public abstract class MocoServerTestWriter extends JUnitTestWriter
{
/**
* Creates a new MocoServerTestWriter instance.
*/
protected MocoServerTestWriter( MocoServerConfig serverConfig, CertConfig certConfig, TestCaseWriter testCaseWriter)
{
super( testCaseWriter);
setConfigWriter( writerFor( serverConfig));
getConfigWriter().setCertConfigWriter( writerFor( certConfig));
}
/**
* Returns a URI for the API server used by the given test case. If non-null, this supersedes
* the server URI defined by this {@link RequestCase request case}.
*/
protected URI getTestServer( RequestCase requestCase)
{
return getConfigWriter().getTestServer( requestCase);
}
/**
* Returns the URI scheme used in requests to the Moco server.
*/
public String getServerScheme()
{
// By default, use "http"
return "http";
}
/**
* Returns the Moco server class name for this test writer.
*/
protected abstract String getServerClass();
/**
* Returns the Moco server factory method for this test writer.
*/
protected abstract String getServerFactory();
/**
* Returns the Moco server factory arguments for this test writer.
*/
protected List<String> getServerFactoryArgs()
{
return getConfigWriter().getServerFactoryConfigArgs();
}
/**
* Returns the MocoJunitRunner factory method for this test writer.
*/
protected abstract String getRunnerFactory();
/**
* Returns the MocoJunitRunner factory arguments for this test writer.
*/
protected List<String> getRunnerFactoryArgs()
{
return getConfigWriter().getRunnerFactoryConfigArgs();
}
/**
* Writes the target test dependencies to the given stream.
*/
protected void writeDependencies( JavaTestTarget target, String testName, IndentedWriter targetWriter)
{
super.writeDependencies( target, testName, targetWriter);
targetWriter.println();
targetWriter.println( "import com.github.dreamhead.moco.junit.MocoJunitRunner;");
targetWriter.println( "import static com.github.dreamhead.moco.Moco.*;");
writeConfigDependencies( targetWriter);
}
/**
* Writes the target test dependencies for the POJO server configuration to the given stream.
*/
protected abstract void writePojoDependencies( IndentedWriter targetWriter);
/**
* Writes the target test declarations to the given stream.
*/
protected void writeDeclarations( JavaTestTarget target, String testName, IndentedWriter targetWriter)
{
super.writeDeclarations( target, testName, targetWriter);
writeConfigInit( targetWriter);
writeConfigRule( targetWriter);
}
/**
* Writes server configuration dependencies to the given stream.
*/
protected void writeConfigDependencies( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigDependencies( targetWriter);
}
/**
* Writes server configuration initializations to the given stream.
*/
protected void writeConfigInit( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigInit( targetWriter);
}
/**
* Writes the server configuration TestRule to the given stream.
*/
protected void writeConfigRule( IndentedWriter targetWriter)
{
getConfigWriter().writeConfigRule( targetWriter);
}
/**
* Changes the {@link MocoServerTestWriter.ConfigWriter} for this test writer.
*/
private void setConfigWriter( ConfigWriter<?> configWriter)
{
configWriter_ = configWriter;
}
/**
* Returns the {@link MocoServerTestWriter.ConfigWriter} for this test writer.
*/
protected ConfigWriter<?> getConfigWriter()
{
return configWriter_;
}
private ConfigWriter<?> writerFor( MocoServerConfig config)
{
ConfigWriterVisitor visitor = new ConfigWriterVisitor();
config.accept( visitor);
return visitor.configWriter_;
}
private Optional<CertConfigWriter<?>> writerFor( CertConfig certConfig)
{
return
Optional.ofNullable( certConfig)
.map( config -> {
CertConfigWriterVisitor visitor = new CertConfigWriterVisitor();
config.accept( visitor);
return visitor.certConfigWriter_;
});
}
public String toString()
{
return
ToString.getBuilder( this)
.append( getConfigWriter().getConfig())
.build();
}
private ConfigWriter<?> configWriter_;
/**
* Base class for server configuration writers.
*/
private abstract class ConfigWriter<C extends MocoServerConfig>
{
/**
* Creates a new ConfigWriter instance.
*/
protected ConfigWriter( C config)
{
config_ = config;
}
/**
* Returns the {@link MocoServerConfig} for this test writer.
*/
protected C getConfig()
{
return config_;
}
/**
* Writes server configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
targetWriter.println( String.format( "import org.junit.%s;", getConfig().getRuleType()));
getCertConfigWriter().ifPresent( cert -> cert.writeConfigDependencies( targetWriter));
}
/**
* Writes server configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
getCertConfigWriter().ifPresent( cert -> cert.writeConfigInit( targetWriter));
}
/**
* Writes the server configuration TestRule to the given stream.
*/
public void writeConfigRule( IndentedWriter targetWriter)
{
String ruleType = getConfig().getRuleType();
targetWriter.println();
targetWriter.println( String.format( "@%s", ruleType));
targetWriter.println(
String.format(
"public %sMocoJunitRunner runner = MocoJunitRunner.%s( %s);",
ruleType.equals( "ClassRule")? "static " : "",
getRunnerFactoryConfig(),
getRunnerFactoryArgs().stream().collect( joining( ", "))));
}
/**
* Returns the Moco server factory arguments for this server configuration.
*/
public List<String> getServerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args.add( String.valueOf( getConfig().getPort()));
getCertConfigWriter().ifPresent( cert -> cert.getServerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return getRunnerFactory();
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public abstract List<String> getRunnerFactoryConfigArgs();
/**
* Returns a URI for the API server used by the given test case. If non-null, this supersedes
* the server URI defined by this {@link RequestCase request case}.
*/
public URI getTestServer( RequestCase requestCase)
{
try
{
return new URI( getServerScheme(), null, "localhost", getConfig().getPort(), null, null, null);
}
catch( Exception e)
{
throw new IllegalArgumentException( "Can't define test server URI", e);
}
}
/**
* Changes the {@link HttpsServerTestWriter.CertConfigWriter} for this test writer.
*/
private void setCertConfigWriter( Optional<CertConfigWriter<?>> certConfigWriter)
{
certConfigWriter_ = certConfigWriter;
}
/**
* Returns the {@link HttpsServerTestWriter.CertConfigWriter} for this test writer.
*/
protected Optional<CertConfigWriter<?>> getCertConfigWriter()
{
return certConfigWriter_;
}
private final C config_;
private Optional<CertConfigWriter<?>> certConfigWriter_;
}
/**
* Writes test definitions based on {@link MocoServerConfigFile} configuration.
*/
private class ConfigFileWriter extends ConfigWriter<MocoServerConfigFile>
{
/**
* Creates a new ConfigFileWriter instance.
*/
public ConfigFileWriter( MocoServerConfigFile config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return
String.format(
"json%s%s",
getRunnerFactory().substring( 0, 1).toUpperCase(),
getRunnerFactory().substring( 1));
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.valueOf( getConfig().getPort()))
.add( String.format( "file( \"%s\")", getConfig().getPath()));
getCertConfigWriter().ifPresent( cert -> cert.getRunnerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
}
/**
* Writes test definitions based on {@link MocoServerConfigResource} configuration.
*/
private class ConfigResourceWriter extends ConfigWriter<MocoServerConfigResource>
{
/**
* Creates a new ConfigResourceWriter instance.
*/
public ConfigResourceWriter( MocoServerConfigResource config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory method for this server configuration.
*/
protected String getRunnerFactoryConfig()
{
return
String.format(
"json%s%s",
getRunnerFactory().substring( 0, 1).toUpperCase(),
getRunnerFactory().substring( 1));
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.valueOf( getConfig().getPort()))
.add( String.format( "pathResource( \"%s\")", getConfig().getPath()));
getCertConfigWriter().ifPresent( cert -> cert.getRunnerFactoryConfigArgs().forEach( certArg -> args.add( certArg)));
return args.build();
}
}
/**
* Writes test definitions based on {@link MocoServerConfigPojo} configuration.
*/
private class ConfigPojoWriter extends ConfigWriter<MocoServerConfigPojo>
{
/**
* Creates a new ConfigPojoWriter instance.
*/
public ConfigPojoWriter( MocoServerConfigPojo config)
{
super( config);
}
/**
* Returns the MocoJunitRunner factory arguments for server configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
/**
* Writes server configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
super.writeConfigDependencies( targetWriter);
writePojoDependencies( targetWriter);
}
/**
* Writes server configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
super.writeConfigInit( targetWriter);
targetWriter.println();
targetWriter.println( String.format( "private static %s %s;", getServerClass(), getConfig().getName()));
targetWriter.println();
targetWriter.println( "static {");
targetWriter.indent();
targetWriter.println(
String.format(
"%s = %s( %s);",
getConfig().getName(),
getServerFactory(),
getServerFactoryArgs().stream().collect( joining( ", "))));
Optional.ofNullable( getConfig().getPojoWriter())
.ifPresent( pojoWriter -> pojoWriter.writePojo( getConfig().getName(), targetWriter));
targetWriter.unindent();
targetWriter.println( "}");
}
}
/**
* Creates a {@link ConfigWriter} for a {@link MocoServerConfig} instance.
*/
private class ConfigWriterVisitor implements ConfigVisitor
{
public void visit( MocoServerConfigFile config)
{
configWriter_ = new ConfigFileWriter( config);
}
public void visit( MocoServerConfigResource config)
{
configWriter_ = new ConfigResourceWriter( config);
}
public void visit( MocoServerConfigPojo config)
{
configWriter_ = new ConfigPojoWriter( config);
}
private ConfigWriter<?> configWriter_;
}
/**
* Base class for certificate configuration writers.
*/
private static abstract class CertConfigWriter<C extends CertConfig>
{
/**
* Creates a new CertConfigWriter instance.
*/
protected CertConfigWriter( C config)
{
config_ = config;
}
/**
* Returns the {@link CertConfig} for this test writer.
*/
protected C getConfig()
{
return config_;
}
/**
* Writes certificate configuration dependencies to the given stream.
*/
public void writeConfigDependencies( IndentedWriter targetWriter)
{
targetWriter.println( "import com.github.dreamhead.moco.HttpsCertificate;");
targetWriter.println( "import static com.github.dreamhead.moco.HttpsCertificate.certificate;");
}
/**
* Writes certificate configuration initializations to the given stream.
*/
public void writeConfigInit( IndentedWriter targetWriter)
{
targetWriter.println(
String.format(
"private static final HttpsCertificate %s = certificate( %s);",
getConfig().getName(),
getCertFactoryConfigArgs().stream().collect( joining( ", "))));
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected abstract List<String> getCertFactoryConfigArgs();
/**
* Returns the server factory arguments for certificate configuration.
*/
public List<String> getServerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
/**
* Returns the MocoJunitRunner factory arguments for certificate configuration.
*/
public List<String> getRunnerFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
return args.add( getConfig().getName()).build();
}
private final C config_;
}
/**
* Writes test definitions based on {@link CertConfigFile} configuration.
*/
private static class CertConfigFileWriter extends CertConfigWriter<CertConfigFile>
{
/**
* Creates a new CertConfigFileWriter instance.
*/
public CertConfigFileWriter( CertConfigFile certConfig)
{
super( certConfig);
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected List<String> getCertFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.format( "file( \"%s\")", getConfig().getPath()))
.add( String.format( "\"%s\"", getConfig().getKeyStorePassword()))
.add( String.format( "\"%s\"", getConfig().getCertPassword()));
return args.build();
}
}
/**
* Writes test definitions based on {@link CertConfigResource} configuration.
*/
private static class CertConfigResourceWriter extends CertConfigWriter<CertConfigResource>
{
/**
* Creates a new CertConfigResourceWriter instance.
*/
public CertConfigResourceWriter( CertConfigResource certConfig)
{
super( certConfig);
}
/**
* Returns the certificate factory arguments for this certificate configuration.
*/
protected List<String> getCertFactoryConfigArgs()
{
ListBuilder<String> args = ListBuilder.to();
args
.add( String.format( "pathResource( \"%s\")", getConfig().getPath()))
.add( String.format( "\"%s\"", getConfig().getKeyStorePassword()))
.add( String.format( "\"%s\"", getConfig().getCertPassword()));
return args.build();
}
}
/**
* Creates a {@link CertConfigWriter} for a {@link CertConfig} instance.
*/
private class CertConfigWriterVisitor implements CertConfigVisitor
{
public void visit( CertConfigFile certConfig)
{
certConfigWriter_ = new CertConfigFileWriter( certConfig);
}
public void visit( CertConfigResource certConfig)
{
certConfigWriter_ = new CertConfigResourceWriter( certConfig);
}
private CertConfigWriter<?> certConfigWriter_;
}
}
| Fix ClassCanBeStatic errors
| tcases-moco/src/main/java/org/cornutum/tcases/openapi/moco/MocoServerTestWriter.java | Fix ClassCanBeStatic errors | <ide><path>cases-moco/src/main/java/org/cornutum/tcases/openapi/moco/MocoServerTestWriter.java
<ide> /**
<ide> * Creates a {@link CertConfigWriter} for a {@link CertConfig} instance.
<ide> */
<del> private class CertConfigWriterVisitor implements CertConfigVisitor
<add> private static class CertConfigWriterVisitor implements CertConfigVisitor
<ide> {
<ide> public void visit( CertConfigFile certConfig)
<ide> { |
|
Java | apache-2.0 | 6db0d244f3b0395257ff16ddfee70b8689ff86d4 | 0 | spring-cloud/spring-cloud-release-tools,spring-cloud/spring-cloud-release-tools,spring-cloud/spring-cloud-release-tools,spring-cloud/spring-cloud-release-tools,spring-cloud/spring-cloud-release-tools,spring-cloud/spring-cloud-release-tools | package org.springframework.cloud.release.internal.project;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URISyntaxException;
import java.nio.file.Files;
import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.springframework.cloud.release.internal.ReleaserProperties;
import org.springframework.cloud.release.internal.pom.TestPomReader;
import static org.assertj.core.api.BDDAssertions.then;
import static org.assertj.core.api.BDDAssertions.thenThrownBy;
/**
* @author Marcin Grzejszczak
*/
public class ProjectBuilderTests {
TestPomReader reader = new TestPomReader();
@Before
public void checkOs() {
Assume.assumeFalse(System.getProperty("os.name").toLowerCase().startsWith("win"));
}
@Test
public void should_successfully_execute_a_command_when_after_running_there_is_no_html_file_with_unresolved_tag() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.build();
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
}
@Test
public void should_throw_exception_when_after_running_there_is_an_html_file_with_unresolved_tag() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::build).hasMessageContaining("contains a tag that wasn't resolved properly");
}
@Test
public void should_throw_exception_when_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("sleep 1");
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::build).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_successfully_execute_a_deploy_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setDeployCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.deploy();
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
}
@Test
public void should_throw_exception_when_deploy_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setDeployCommand("sleep 1");
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::deploy).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_successfully_execute_a_publish_docs_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "ls -al", "ls -al" });
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
TestProcessExecutor executor = executor(properties);
ProjectBuilder builder = new ProjectBuilder(properties, executor);
builder.publishDocs("");
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
then(executor.counter).isEqualTo(2);
}
@Test
public void should_successfully_execute_a_publish_docs_command_and_substitute_the_version() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "echo '{{version}}'" });
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
TestProcessExecutor executor = executor(properties);
ProjectBuilder builder = new ProjectBuilder(properties, executor);
builder.publishDocs("1.1.0.RELEASE");
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("1.1.0.RELEASE");
}
@Test
public void should_throw_exception_when_publish_docs_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "sleep 1", "sleep 1" });
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(() -> builder.publishDocs("")).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_throw_exception_when_process_exits_with_invalid_code() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("exit 1");
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, new ProcessExecutor(properties) {
@Override Process startProcess(ProcessBuilder builder) throws IOException {
return processWithInvalidExitCode();
}
});
thenThrownBy(builder::build).hasMessageContaining("The process has exited with exit code [1]");
}
@Test
public void should_successfully_execute_a_bump_versions_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.setWorkingDir(file("/projects/spring-cloud-contract").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.bumpVersions("2.3.4.BUILD-SNAPSHOT");
File rootPom = file("/projects/spring-cloud-contract/pom.xml");
File tools = file("/projects/spring-cloud-contract/spring-cloud-contract-tools/pom.xml");
File converters = file("/projects/spring-cloud-contract/spring-cloud-contract-tools/spring-cloud-contract-converters/pom.xml");
then(this.reader.readPom(rootPom).getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
then(this.reader.readPom(tools).getParent().getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
then(this.reader.readPom(converters).getParent().getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
}
private Process processWithInvalidExitCode() {
return new Process() {
@Override public OutputStream getOutputStream() {
return null;
}
@Override public InputStream getInputStream() {
return null;
}
@Override public InputStream getErrorStream() {
return null;
}
@Override public int waitFor() throws InterruptedException {
return 0;
}
@Override public int exitValue() {
return 1;
}
@Override public void destroy() {
}
};
}
private TestProcessExecutor executor(ReleaserProperties properties) {
return new TestProcessExecutor(properties);
}
class TestProcessExecutor extends ProcessExecutor {
int counter = 0;
TestProcessExecutor(ReleaserProperties properties) {
super(properties);
}
@Override ProcessBuilder builder(String[] commands, String workingDir) {
this.counter++;
return super.builder(commands, workingDir)
.redirectOutput(file("/projects/builder/resolved/resolved.log"));
}
}
private File file(String relativePath) {
try {
File root = new File(ProjectBuilderTests.class.getResource("/").toURI());
File file = new File(root, relativePath);
if (!file.exists()) {
file.createNewFile();
}
return file;
}
catch (IOException | URISyntaxException e) {
throw new IllegalStateException(e);
}
}
private String asString(File file) throws IOException {
return new String(Files.readAllBytes(file.toPath()));
}
} | spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/project/ProjectBuilderTests.java | package org.springframework.cloud.release.internal.project;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URISyntaxException;
import java.nio.file.Files;
import org.junit.Assume;
import org.junit.Before;
import org.junit.Test;
import org.springframework.cloud.release.internal.ReleaserProperties;
import org.springframework.cloud.release.internal.pom.TestPomReader;
import static org.assertj.core.api.BDDAssertions.then;
import static org.assertj.core.api.BDDAssertions.thenThrownBy;
/**
* @author Marcin Grzejszczak
*/
public class ProjectBuilderTests {
TestPomReader reader = new TestPomReader();
@Before
public void checkOs() {
Assume.assumeFalse(System.getProperty("os.name").toLowerCase().startsWith("win"));
}
@Test
public void should_successfully_execute_a_command_when_after_running_there_is_no_html_file_with_unresolved_tag() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.build();
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
}
@Test
public void should_throw_exception_when_after_running_there_is_an_html_file_with_unresolved_tag() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::build).hasMessageContaining("contains a tag that wasn't resolved properly");
}
@Test
public void should_throw_exception_when_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("sleep 1");
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::build).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_successfully_execute_a_deploy_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setDeployCommand("ls -al");
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.deploy();
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
}
@Test
public void should_throw_exception_when_deploy_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setDeployCommand("sleep 1");
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(builder::deploy).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_successfully_execute_a_publish_docs_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "ls -al", "ls -al" });
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
TestProcessExecutor executor = executor(properties);
ProjectBuilder builder = new ProjectBuilder(properties, executor);
builder.publishDocs("");
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("resolved.log");
then(executor.counter).isEqualTo(2);
}
@Test
public void should_successfully_execute_a_publish_docs_command_and_substitute_the_version() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "echo '{{version}}'" });
properties.setWorkingDir(file("/projects/builder/resolved").getPath());
TestProcessExecutor executor = executor(properties);
ProjectBuilder builder = new ProjectBuilder(properties, executor);
builder.publishDocs("1.1.0.RELEASE");
then(asString(file("/projects/builder/resolved/resolved.log")))
.contains("1.1.0.RELEASE");
}
@Test
public void should_throw_exception_when_publish_docs_command_took_too_long_to_execute() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setPublishDocsCommands(new String[] { "ls -al", "ls -al" });
properties.getMaven().setWaitTimeInMinutes(0);
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
thenThrownBy(() -> builder.publishDocs("")).hasMessageContaining("Process waiting time of [0] minutes exceeded");
}
@Test
public void should_throw_exception_when_process_exits_with_invalid_code() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.getMaven().setBuildCommand("exit 1");
properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, new ProcessExecutor(properties) {
@Override Process startProcess(ProcessBuilder builder) throws IOException {
return processWithInvalidExitCode();
}
});
thenThrownBy(builder::build).hasMessageContaining("The process has exited with exit code [1]");
}
@Test
public void should_successfully_execute_a_bump_versions_command() throws Exception {
ReleaserProperties properties = new ReleaserProperties();
properties.setWorkingDir(file("/projects/spring-cloud-contract").getPath());
ProjectBuilder builder = new ProjectBuilder(properties, executor(properties));
builder.bumpVersions("2.3.4.BUILD-SNAPSHOT");
File rootPom = file("/projects/spring-cloud-contract/pom.xml");
File tools = file("/projects/spring-cloud-contract/spring-cloud-contract-tools/pom.xml");
File converters = file("/projects/spring-cloud-contract/spring-cloud-contract-tools/spring-cloud-contract-converters/pom.xml");
then(this.reader.readPom(rootPom).getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
then(this.reader.readPom(tools).getParent().getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
then(this.reader.readPom(converters).getParent().getVersion()).isEqualTo("2.3.4.BUILD-SNAPSHOT");
}
private Process processWithInvalidExitCode() {
return new Process() {
@Override public OutputStream getOutputStream() {
return null;
}
@Override public InputStream getInputStream() {
return null;
}
@Override public InputStream getErrorStream() {
return null;
}
@Override public int waitFor() throws InterruptedException {
return 0;
}
@Override public int exitValue() {
return 1;
}
@Override public void destroy() {
}
};
}
private TestProcessExecutor executor(ReleaserProperties properties) {
return new TestProcessExecutor(properties);
}
class TestProcessExecutor extends ProcessExecutor {
int counter = 0;
TestProcessExecutor(ReleaserProperties properties) {
super(properties);
}
@Override ProcessBuilder builder(String[] commands, String workingDir) {
this.counter++;
return super.builder(commands, workingDir)
.redirectOutput(file("/projects/builder/resolved/resolved.log"));
}
}
private File file(String relativePath) {
try {
File root = new File(ProjectBuilderTests.class.getResource("/").toURI());
File file = new File(root, relativePath);
if (!file.exists()) {
file.createNewFile();
}
return file;
}
catch (IOException | URISyntaxException e) {
throw new IllegalStateException(e);
}
}
private String asString(File file) throws IOException {
return new String(Files.readAllBytes(file.toPath()));
}
} | Trying to make the tests pass
| spring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/project/ProjectBuilderTests.java | Trying to make the tests pass | <ide><path>pring-cloud-release-tools-core/src/test/java/org/springframework/cloud/release/internal/project/ProjectBuilderTests.java
<ide> @Test
<ide> public void should_throw_exception_when_publish_docs_command_took_too_long_to_execute() throws Exception {
<ide> ReleaserProperties properties = new ReleaserProperties();
<del> properties.getMaven().setPublishDocsCommands(new String[] { "ls -al", "ls -al" });
<add> properties.getMaven().setPublishDocsCommands(new String[] { "sleep 1", "sleep 1" });
<ide> properties.getMaven().setWaitTimeInMinutes(0);
<ide> properties.setWorkingDir(file("/projects/builder/unresolved").getPath());
<ide> ProjectBuilder builder = new ProjectBuilder(properties, executor(properties)); |
|
Java | bsd-2-clause | 11d2f687abae245914a00f2aa091e04d5d75036c | 0 | imagejan/imagej-updater | /*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2014 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package net.imagej.updater;
import static net.imagej.updater.FilesCollection.DEFAULT_UPDATE_SITE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.scijava.test.TestUtils.createTemporaryDirectory;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;
import javax.xml.parsers.ParserConfigurationException;
import net.imagej.updater.FileObject.Action;
import net.imagej.updater.FileObject.Status;
import net.imagej.updater.util.Progress;
import net.imagej.updater.util.StderrProgress;
import net.imagej.updater.util.UpdaterUtil;
import org.scijava.log.LogService;
import org.scijava.util.ClassUtils;
import org.scijava.util.FileUtils;
import org.xml.sax.SAXException;
/**
* A container of functions useful for testing the updater/uploader.
*
* @author Johannes Schindelin
*/
public class UpdaterTestUtils {
/**
* This is a hack, albeit not completely a dumb one. As long as you have
* swing-updater compiled and up-to-date, you can use this method to inspect
* the state at any given moment
*
* @param files The collection of files, including the current update site and
* IJ root.
*/
public static void show(final FilesCollection files) {
try {
String url = ClassUtils.getLocation(UpdaterTestUtils.class).toString();
final String suffix = "/updater/target/test-classes/";
assertTrue(url + " ends with " + suffix, url.endsWith(suffix));
url =
url.substring(0, url.length() - suffix.length()) +
"/ui/swing/target/classes/";
final ClassLoader loader =
new java.net.URLClassLoader(
new java.net.URL[] { new java.net.URL(url) });
final Class<?> clazz =
loader.loadClass("net.imagej.ui.swing.updater.UpdaterFrame");
final java.lang.reflect.Constructor<?> ctor =
clazz.getConstructor(LogService.class, UploaderService.class, FilesCollection.class);
final Object updaterFrame = ctor.newInstance(UpdaterUtil.getLogService(), null, files);
final java.lang.reflect.Method setVisible =
clazz.getMethod("setVisible", boolean.class);
setVisible.invoke(updaterFrame, true);
final java.lang.reflect.Method isVisible = clazz.getMethod("isVisible");
for (;;) {
Thread.sleep(1000);
if (isVisible.invoke(updaterFrame).equals(Boolean.FALSE)) break;
}
}
catch (final Throwable t) {
t.printStackTrace();
}
}
//
// Utility functions
//
public static FilesCollection main(final FilesCollection files, final String... args) throws ParserConfigurationException, SAXException {
files.prefix(".checksums").delete();
CommandLine.main(files.prefix(""), -1, progress, args);
return readDb(files);
}
public static File addUpdateSite(final FilesCollection files, final String name) throws Exception {
final File directory = createTemporaryDirectory("update-site-" + name);
final String url = directory.toURI().toURL().toString().replace('\\', '/');
final String sshHost = "file:localhost";
final String uploadDirectory = directory.getAbsolutePath();
final FilesUploader uploader = FilesUploader.initialUploader(null, url, sshHost, uploadDirectory, progress);
assertTrue(uploader.login());
uploader.upload(progress);
CommandLine.main(files.prefix(""), -1, "add-update-site", name, url, sshHost, uploadDirectory);
System.err.println("Initialized update site at " + url);
return directory;
}
protected static File makeIJRoot(final File webRoot) throws IOException {
final File ijRoot = createTemporaryDirectory("ij-root-");
initDb(ijRoot, webRoot);
return ijRoot;
}
protected static void initDb(final FilesCollection files) throws IOException {
initDb(files.prefix(""), getWebRoot(files));
}
protected static void initDb(final File ijRoot, final File webRoot) throws IOException {
writeGZippedFile(ijRoot, "db.xml.gz", "<pluginRecords><update-site name=\""
+ FilesCollection.DEFAULT_UPDATE_SITE + "\" timestamp=\"0\" url=\""
+ webRoot.toURI().toURL().toString() + "\" ssh-host=\"file:localhost\" "
+ "upload-directory=\"" + webRoot.getAbsolutePath() + "\"/></pluginRecords>");
}
public static FilesCollection initialize(final String... fileNames) throws Exception {
return initialize(null, null, fileNames);
}
public static FilesCollection initialize(File ijRoot, File webRoot, final String... fileNames)
throws Exception
{
if (ijRoot == null) ijRoot = createTemporaryDirectory("ij-root-");
if (webRoot == null) webRoot = createTemporaryDirectory("ij-web-");
final File localDb = new File(ijRoot, "db.xml.gz");
final File remoteDb = new File(webRoot, "db.xml.gz");
// Initialize update site
final String url = webRoot.toURI().toURL().toString() + "/";
final String sshHost = "file:localhost";
final String uploadDirectory = webRoot.getAbsolutePath() + "/";
assertFalse(localDb.exists());
assertFalse(remoteDb.exists());
FilesUploader uploader =
FilesUploader.initialUploader(null, url, sshHost, uploadDirectory, progress);
assertTrue(uploader.login());
uploader.upload(progress);
assertFalse(localDb.exists());
assertTrue(remoteDb.exists());
final long remoteDbSize = remoteDb.length();
// Write initial db.xml.gz
FilesCollection files = new FilesCollection(ijRoot);
useWebRoot(files, webRoot);
if (fileNames.length == 0) {
files.write();
assertTrue(localDb.exists());
} else {
// Write files
final List<String> list = new ArrayList<String>();
for (final String name : fileNames) {
writeFile(new File(ijRoot, name), name);
list.add(name);
}
// Initialize db.xml.gz
if (localDb.exists()) {
files.read(localDb);
}
new XMLFileReader(files).read(FilesCollection.DEFAULT_UPDATE_SITE);
assertEquals(0, files.size());
files.write();
assertTrue(localDb.exists());
final Checksummer czechsummer = new Checksummer(files, progress);
czechsummer.updateFromLocal(list);
for (final String name : fileNames) {
final FileObject file = files.get(name);
assertNotNull(name, file);
file.stageForUpload(files, FilesCollection.DEFAULT_UPDATE_SITE);
}
uploader = new FilesUploader(null, files, FilesCollection.DEFAULT_UPDATE_SITE, progress);
assertTrue(uploader.login());
uploader.upload(progress);
assertTrue(remoteDb.exists());
assertNotEqual(remoteDb.length(), remoteDbSize);
}
return files;
}
public static boolean cleanup(final FilesCollection files) {
final File ijRoot = files.prefix("");
if (ijRoot.isDirectory() && !deleteRecursivelyAtLeastOnExit(ijRoot)) {
System.err.println("Warning: Deleting " + ijRoot
+ " deferred to exit");
}
for (String updateSite : files.getUpdateSiteNames(false)) {
final File webRoot = getWebRoot(files, updateSite);
if (webRoot != null && webRoot.isDirectory()
&& !deleteRecursivelyAtLeastOnExit(webRoot)) {
System.err.println("Warning: Deleting " + webRoot
+ " deferred to exit");
}
}
return true;
}
/**
* Deletes a directory recursively, falling back to deleteOnExit().
*
* Thanks to Windows' incredibly sophisticated and intelligent file
* locking, we cannot delete files that are in use, even if they are
* "in use" by, say, a ClassLoader that is about to be garbage
* collected.
*
* For single files, Java's API has the File#deleteOnExit method, but
* it does not perform what you'd think it should do on directories.
*
* To be able to clean up directories reliably, we introduce this
* function which tries to delete all files and directories directly,
* falling back to deleteOnExit.
*
* @param directory the directory to delete recursively
* @return whether the directory was deleted successfully
*/
public static boolean deleteRecursivelyAtLeastOnExit(final File directory) {
boolean result = true;
final File[] list = directory.listFiles();
if (list != null) {
for (final File file : list) {
if (file.isDirectory()) {
if (!deleteRecursivelyAtLeastOnExit(file)) {
result = false;
}
continue;
}
if (!file.delete()) {
file.deleteOnExit();
result = false;
}
}
}
if (!result || !directory.delete()) {
directory.deleteOnExit();
result = false;
}
return result;
}
protected static FilesCollection readDb(FilesCollection files) throws ParserConfigurationException,
SAXException {
return readDb(files.prefix(""));
}
protected static FilesCollection readDb(final File ijRoot) throws ParserConfigurationException, SAXException {
final FilesCollection files = new FilesCollection(ijRoot);
// We're too fast, cannot trust the cached checksums
files.prefix(".checksums").delete();
files.downloadIndexAndChecksum(progress);
return files;
}
public static void useWebRoot(final FilesCollection files, final File webRoot) throws MalformedURLException {
final UpdateSite updateSite = files.getUpdateSite(FilesCollection.DEFAULT_UPDATE_SITE, false);
assertNotNull(updateSite);
updateSite.setURL( webRoot.toURI().toURL().toString());
updateSite.setHost("file:localhost");
updateSite.setUploadDirectory(webRoot.getAbsolutePath());
}
public static File getWebRoot(final FilesCollection files) {
return getWebRoot(files, DEFAULT_UPDATE_SITE);
}
public static File getWebRoot(final FilesCollection files, final String updateSite) {
final UpdateSite site = files.getUpdateSite(updateSite, false);
if (!DEFAULT_UPDATE_SITE.equals(updateSite)
&& (site.getHost() == null || site.getHost().startsWith("file:"))) {
return null;
}
assertTrue("file:localhost".equals(site.getHost()));
return new File(site.getUploadDirectory());
}
protected static void update(final FilesCollection files) throws IOException {
final File ijRoot = files.prefix(".");
final Installer installer = new Installer(files, progress);
installer.start();
assertTrue(new File(ijRoot, "update").isDirectory());
installer.moveUpdatedIntoPlace();
assertFalse(new File(ijRoot, "update").exists());
}
protected static void upload(final FilesCollection files) throws Exception {
upload(files, DEFAULT_UPDATE_SITE);
}
protected static void upload(final FilesCollection files, final String updateSite) throws Exception {
for (final FileObject file : files.toUpload())
assertEquals(updateSite, file.updateSite);
final FilesUploader uploader =
new FilesUploader(null, files, updateSite, progress);
assertTrue(uploader.login());
uploader.upload(progress);
files.write();
}
protected static FileObject[] makeList(final FilesCollection files) {
final List<FileObject> list = new ArrayList<FileObject>();
for (final FileObject object : files)
list.add(object);
return list.toArray(new FileObject[list.size()]);
}
protected static void assertStatus(final Status status,
final FilesCollection files, final String filename)
{
final FileObject file = files.get(filename);
assertStatus(status, file);
}
protected static void
assertStatus(final Status status, final FileObject file)
{
assertNotNull("Object " + file.getFilename(), file);
assertEquals("Status of " + file.getFilename(), status, file.getStatus());
}
protected static void assertAction(final Action action,
final FilesCollection files, final String filename)
{
assertAction(action, files.get(filename));
}
protected static void assertAction(final Action action,
final FileObject file)
{
assertNotNull("Object " + file, file);
assertEquals("Action of " + file.filename, action, file.getAction());
}
protected static void assertNotEqual(final Object object1,
final Object object2)
{
if (object1 == null) {
assertNotNull(object2);
}
else {
assertFalse(object1.equals(object2));
}
}
protected static void assertNotEqual(final long long1, final long long2) {
assertTrue(long1 != long2);
}
protected static void
assertCount(final int count, final Iterable<?> iterable)
{
assertEquals(count, count(iterable));
}
protected static int count(final Iterable<?> iterable) {
int count = 0;
for (@SuppressWarnings("unused")
final Object object : iterable)
{
count++;
}
return count;
}
protected static void print(final Iterable<?> iterable) {
System.err.println("{");
int count = 0;
for (final Object object : iterable) {
System.err.println("\t" +
++count +
": " +
object +
(object instanceof FileObject ? " = " +
((FileObject) object).getStatus() + "/" +
((FileObject) object).getAction() : ""));
}
System.err.println("}");
}
/**
* Change the mtime of a file
*
* @param file the file to touch
* @param timestamp the mtime as pseudo-long (YYYYMMDDhhmmss)
*/
protected static void touch(final File file, final long timestamp) {
final long millis = UpdaterUtil.timestamp2millis(timestamp);
file.setLastModified(millis);
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files, final String path) throws FileNotFoundException, IOException
{
return writeJar(files, path, path, path);
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @param args a list of entry name / contents pairs
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files, final String path,
final String... args) throws FileNotFoundException, IOException
{
return writeJar(files.prefix(path), args);
}
/**
* Write a .jar file
*
* @param jarFile which .jar file to write into
* @param args a list of entry name / contents pairs
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final File jarFile,
final String... args) throws FileNotFoundException, IOException
{
assertTrue((args.length % 2) == 0);
jarFile.getParentFile().mkdirs();
final JarOutputStream jar = new JarOutputStream(new FileOutputStream(jarFile));
for (int i = 0; i + 1 < args.length; i += 2) {
final JarEntry entry = new JarEntry(args[i]);
jar.putNextEntry(entry);
jar.write(args[i + 1].getBytes());
jar.closeEntry();
}
jar.close();
return jarFile;
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @param classes a list of classes whose files to write
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files,
final String path, final Class<?>... classes)
throws FileNotFoundException, IOException {
return writeJar(files.prefix(path), classes);
}
/**
* Write a .jar file
*
* @param file which directory to write into
* @param classes a list of classes whose files to write
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final File file, final Class<?>... classes) throws FileNotFoundException, IOException {
file.getParentFile().mkdirs();
final Map<String, URL> extra = new LinkedHashMap<String, URL>();
final byte[] buffer = new byte[32768];
final JarOutputStream jar = new JarOutputStream(new FileOutputStream(file));
for (int i = 0; i < classes.length; i++) {
final String path = classes[i].getName().replace('.', '/') + ".class";
final JarEntry entry = new JarEntry(path);
jar.putNextEntry(entry);
final InputStream in = classes[i].getResourceAsStream("/" + path);
for (;;) {
int count = in.read(buffer);
if (count < 0)
break;
jar.write(buffer, 0, count);
}
in.close();
jar.closeEntry();
final String url = classes[i].getResource("/" + path).toString();
final String baseURL = url.substring(0, url.length() - path.length());
final URL metaInf = new URL(baseURL + "META-INF/");
for (final URL url2 : FileUtils.listContents(metaInf)) {
final String path2 = url2.toString().substring(baseURL.length());
if (!extra.containsKey(path2)) extra.put(path2, url2);
else {
final URL url3 = extra.get(path2);
if (!url2.equals(url3)) {
System.err.println("Warning: skipping duplicate " + path2 + "\n(" + url2 + " vs " + url3);
}
}
}
}
for (Entry<String, URL> entry2 : extra.entrySet()) {
final String path = entry2.getKey();
final JarEntry entry = new JarEntry(path);
jar.putNextEntry(entry);
final InputStream in = entry2.getValue().openStream();
for (;;) {
int count = in.read(buffer);
if (count < 0)
break;
jar.write(buffer, 0, count);
}
in.close();
jar.closeEntry();
}
jar.close();
return file;
}
/**
* Write a .gz file
*
* @param dir The directory into which to write
* @param name The file name
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
protected static File writeGZippedFile(final File dir, final String name,
final String content) throws FileNotFoundException, IOException
{
final File file = new File(dir, name);
file.getParentFile().mkdirs();
writeStream(new GZIPOutputStream(new FileOutputStream(file)), content, true);
return file;
}
/**
* Write a text file
*
* @param files The files collection
* @param path the path of the file into which to write
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final FilesCollection files, final String path, final String content)
throws FileNotFoundException, IOException
{
return writeFile(files.prefix(path), content);
}
/**
* Write a text file
*
* @param files The files collection
* @param path the path of the file into which to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final FilesCollection files, final String path)
throws FileNotFoundException, IOException
{
return writeFile(files.prefix(path), path);
}
/**
* Write a text file
*
* @param file The file into which to write
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final File file, final String content)
throws FileNotFoundException, IOException
{
final File dir = file.getParentFile();
if (!dir.isDirectory()) dir.mkdirs();
final String name = file.getName();
if (name.endsWith(".jar")) return writeJar(file, content, content);
writeStream(new FileOutputStream(file), content, true);
return file;
}
/**
* Writes a string to a stream.
*
* @param out where to write to
* @param content what to write
* @param close whether to close the stream
*/
protected static void writeStream(final OutputStream out, final String content,
final boolean close)
{
final PrintWriter writer = new PrintWriter(out);
writer.println(content);
if (close) {
writer.close();
}
}
/**
* Reads a file's contents.
*
* @param file the file
* @return the contents, as a String
* @throws IOException
*/
protected static String readFile(final File file) throws IOException {
return readStream(new FileInputStream(file));
}
/**
* Read a gzip'ed stream and return what we got as a String
*
* @param in the input stream as compressed by gzip
* @return the contents, as a Stringcl
* @throws IOException
*/
protected static String readGzippedStream(final InputStream in) throws IOException {
return readStream(new GZIPInputStream(in));
}
/**
* Read a stream and return what we got as a String
*
* @param in the input stream
* @return the contents, as a String
* @throws IOException
*/
protected static String readStream(final InputStream in) throws IOException {
final ByteArrayOutputStream out = new ByteArrayOutputStream();
final byte[] buffer = new byte[16384];
for (;;) {
int count = in.read(buffer);
if (count < 0) break;
out.write(buffer, 0, count);
}
in.close();
out.close();
return out.toString();
}
/**
* A quieter version of the progress than {@link StderrProgress}.
*/
public final static Progress progress = new Progress() {
final boolean verbose = false;
final PrintStream err = System.err;
private String prefix = "", item = "";
@Override
public void setTitle(String title) {
prefix = title;
item = "";
}
@Override
public void setCount(int count, int total) {
if (verbose) err.print(prefix + item + count + "/" + total + "\r");
}
@Override
public void addItem(Object item) {
this.item = "/" + item + ": ";
}
@Override
public void setItemCount(int count, int total) {
if (verbose) err.print(prefix + item + " [" + count + "/" + total + "]\r");
}
@Override
public void itemDone(Object item) {
if (verbose) err.print(prefix + item + "\n");
}
@Override
public void done() {
// this space intentionally left blank
}
};
/**
* Writes a {@code .jar} file containing a single file with a specific timestamp.
*
* @param files the collection
* @param jarFileName the path of the {@code .jar} file
* @param year the year of the timestamp
* @param month the month of the timestamp
* @param day the day of the month of the timestamp
* @param fileName the name of the file contained in the {@code .jar} file
* @param fileContents the contents of the file contained in the {@code .jar} file
* @return a reference to the written {@code .jar} file
* @throws IOException
*/
public static File writeJarWithDatedFile(final FilesCollection files,
final String jarFileName, final int year, final int month,
final int day, final String fileName,
final String fileContents) throws IOException {
final File file = files.prefix(jarFileName);
final File dir = file.getParentFile();
if (dir != null && !dir.isDirectory()) assertTrue(dir.mkdirs());
final JarOutputStream out = new JarOutputStream(new FileOutputStream(file));
final JarEntry entry = new JarEntry(fileName);
entry.setTime(new GregorianCalendar(year, month, day).getTimeInMillis());
out.putNextEntry(entry);
out.write(fileContents.getBytes());
out.closeEntry();
out.close();
return file;
}
}
| src/test/java/net/imagej/updater/UpdaterTestUtils.java | /*
* #%L
* ImageJ software for multidimensional image processing and analysis.
* %%
* Copyright (C) 2009 - 2014 Board of Regents of the University of
* Wisconsin-Madison, Broad Institute of MIT and Harvard, and Max Planck
* Institute of Molecular Cell Biology and Genetics.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package net.imagej.updater;
import static net.imagej.updater.FilesCollection.DEFAULT_UPDATE_SITE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import org.scijava.test.TestUtils;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.zip.GZIPInputStream;
import java.util.zip.GZIPOutputStream;
import javax.xml.parsers.ParserConfigurationException;
import net.imagej.updater.FileObject.Action;
import net.imagej.updater.FileObject.Status;
import net.imagej.updater.util.Progress;
import net.imagej.updater.util.StderrProgress;
import net.imagej.updater.util.UpdaterUtil;
import org.scijava.log.LogService;
import org.scijava.util.ClassUtils;
import org.scijava.util.FileUtils;
import org.xml.sax.SAXException;
/**
* A container of functions useful for testing the updater/uploader.
*
* @author Johannes Schindelin
*/
public class UpdaterTestUtils {
/**
* This is a hack, albeit not completely a dumb one. As long as you have
* swing-updater compiled and up-to-date, you can use this method to inspect
* the state at any given moment
*
* @param files The collection of files, including the current update site and
* IJ root.
*/
public static void show(final FilesCollection files) {
try {
String url = ClassUtils.getLocation(UpdaterTestUtils.class).toString();
final String suffix = "/updater/target/test-classes/";
assertTrue(url + " ends with " + suffix, url.endsWith(suffix));
url =
url.substring(0, url.length() - suffix.length()) +
"/ui/swing/target/classes/";
final ClassLoader loader =
new java.net.URLClassLoader(
new java.net.URL[] { new java.net.URL(url) });
final Class<?> clazz =
loader.loadClass("net.imagej.ui.swing.updater.UpdaterFrame");
final java.lang.reflect.Constructor<?> ctor =
clazz.getConstructor(LogService.class, UploaderService.class, FilesCollection.class);
final Object updaterFrame = ctor.newInstance(UpdaterUtil.getLogService(), null, files);
final java.lang.reflect.Method setVisible =
clazz.getMethod("setVisible", boolean.class);
setVisible.invoke(updaterFrame, true);
final java.lang.reflect.Method isVisible = clazz.getMethod("isVisible");
for (;;) {
Thread.sleep(1000);
if (isVisible.invoke(updaterFrame).equals(Boolean.FALSE)) break;
}
}
catch (final Throwable t) {
t.printStackTrace();
}
}
//
// Utility functions
//
public static FilesCollection main(final FilesCollection files, final String... args) throws ParserConfigurationException, SAXException {
files.prefix(".checksums").delete();
CommandLine.main(files.prefix(""), -1, progress, args);
return readDb(files);
}
public static File addUpdateSite(final FilesCollection files, final String name) throws Exception {
final File directory = createTemporaryDirectory("update-site-" + name);
final String url = directory.toURI().toURL().toString().replace('\\', '/');
final String sshHost = "file:localhost";
final String uploadDirectory = directory.getAbsolutePath();
final FilesUploader uploader = FilesUploader.initialUploader(null, url, sshHost, uploadDirectory, progress);
assertTrue(uploader.login());
uploader.upload(progress);
CommandLine.main(files.prefix(""), -1, "add-update-site", name, url, sshHost, uploadDirectory);
System.err.println("Initialized update site at " + url);
return directory;
}
protected static File makeIJRoot(final File webRoot) throws IOException {
final File ijRoot = createTemporaryDirectory("ij-root-");
initDb(ijRoot, webRoot);
return ijRoot;
}
protected static void initDb(final FilesCollection files) throws IOException {
initDb(files.prefix(""), getWebRoot(files));
}
protected static void initDb(final File ijRoot, final File webRoot) throws IOException {
writeGZippedFile(ijRoot, "db.xml.gz", "<pluginRecords><update-site name=\""
+ FilesCollection.DEFAULT_UPDATE_SITE + "\" timestamp=\"0\" url=\""
+ webRoot.toURI().toURL().toString() + "\" ssh-host=\"file:localhost\" "
+ "upload-directory=\"" + webRoot.getAbsolutePath() + "\"/></pluginRecords>");
}
public static FilesCollection initialize(final String... fileNames) throws Exception {
return initialize(null, null, fileNames);
}
public static FilesCollection initialize(File ijRoot, File webRoot, final String... fileNames)
throws Exception
{
if (ijRoot == null) ijRoot = createTemporaryDirectory("ij-root-");
if (webRoot == null) webRoot = createTemporaryDirectory("ij-web-");
final File localDb = new File(ijRoot, "db.xml.gz");
final File remoteDb = new File(webRoot, "db.xml.gz");
// Initialize update site
final String url = webRoot.toURI().toURL().toString() + "/";
final String sshHost = "file:localhost";
final String uploadDirectory = webRoot.getAbsolutePath() + "/";
assertFalse(localDb.exists());
assertFalse(remoteDb.exists());
FilesUploader uploader =
FilesUploader.initialUploader(null, url, sshHost, uploadDirectory, progress);
assertTrue(uploader.login());
uploader.upload(progress);
assertFalse(localDb.exists());
assertTrue(remoteDb.exists());
final long remoteDbSize = remoteDb.length();
// Write initial db.xml.gz
FilesCollection files = new FilesCollection(ijRoot);
useWebRoot(files, webRoot);
if (fileNames.length == 0) {
files.write();
assertTrue(localDb.exists());
} else {
// Write files
final List<String> list = new ArrayList<String>();
for (final String name : fileNames) {
writeFile(new File(ijRoot, name), name);
list.add(name);
}
// Initialize db.xml.gz
if (localDb.exists()) {
files.read(localDb);
}
new XMLFileReader(files).read(FilesCollection.DEFAULT_UPDATE_SITE);
assertEquals(0, files.size());
files.write();
assertTrue(localDb.exists());
final Checksummer czechsummer = new Checksummer(files, progress);
czechsummer.updateFromLocal(list);
for (final String name : fileNames) {
final FileObject file = files.get(name);
assertNotNull(name, file);
file.stageForUpload(files, FilesCollection.DEFAULT_UPDATE_SITE);
}
uploader = new FilesUploader(null, files, FilesCollection.DEFAULT_UPDATE_SITE, progress);
assertTrue(uploader.login());
uploader.upload(progress);
assertTrue(remoteDb.exists());
assertNotEqual(remoteDb.length(), remoteDbSize);
}
return files;
}
public static boolean cleanup(final FilesCollection files) {
final File ijRoot = files.prefix("");
if (ijRoot.isDirectory() && !deleteRecursivelyAtLeastOnExit(ijRoot)) {
System.err.println("Warning: Deleting " + ijRoot
+ " deferred to exit");
}
for (String updateSite : files.getUpdateSiteNames(false)) {
final File webRoot = getWebRoot(files, updateSite);
if (webRoot != null && webRoot.isDirectory()
&& !deleteRecursivelyAtLeastOnExit(webRoot)) {
System.err.println("Warning: Deleting " + webRoot
+ " deferred to exit");
}
}
return true;
}
/**
* Deletes a directory recursively, falling back to deleteOnExit().
*
* Thanks to Windows' incredibly sophisticated and intelligent file
* locking, we cannot delete files that are in use, even if they are
* "in use" by, say, a ClassLoader that is about to be garbage
* collected.
*
* For single files, Java's API has the File#deleteOnExit method, but
* it does not perform what you'd think it should do on directories.
*
* To be able to clean up directories reliably, we introduce this
* function which tries to delete all files and directories directly,
* falling back to deleteOnExit.
*
* @param directory the directory to delete recursively
* @return whether the directory was deleted successfully
*/
public static boolean deleteRecursivelyAtLeastOnExit(final File directory) {
boolean result = true;
final File[] list = directory.listFiles();
if (list != null) {
for (final File file : list) {
if (file.isDirectory()) {
if (!deleteRecursivelyAtLeastOnExit(file)) {
result = false;
}
continue;
}
if (!file.delete()) {
file.deleteOnExit();
result = false;
}
}
}
if (!result || !directory.delete()) {
directory.deleteOnExit();
result = false;
}
return result;
}
protected static FilesCollection readDb(FilesCollection files) throws ParserConfigurationException,
SAXException {
return readDb(files.prefix(""));
}
protected static FilesCollection readDb(final File ijRoot) throws ParserConfigurationException, SAXException {
final FilesCollection files = new FilesCollection(ijRoot);
// We're too fast, cannot trust the cached checksums
files.prefix(".checksums").delete();
files.downloadIndexAndChecksum(progress);
return files;
}
public static void useWebRoot(final FilesCollection files, final File webRoot) throws MalformedURLException {
final UpdateSite updateSite = files.getUpdateSite(FilesCollection.DEFAULT_UPDATE_SITE, false);
assertNotNull(updateSite);
updateSite.setURL( webRoot.toURI().toURL().toString());
updateSite.setHost("file:localhost");
updateSite.setUploadDirectory(webRoot.getAbsolutePath());
}
public static File getWebRoot(final FilesCollection files) {
return getWebRoot(files, DEFAULT_UPDATE_SITE);
}
public static File getWebRoot(final FilesCollection files, final String updateSite) {
final UpdateSite site = files.getUpdateSite(updateSite, false);
if (!DEFAULT_UPDATE_SITE.equals(updateSite)
&& (site.getHost() == null || site.getHost().startsWith("file:"))) {
return null;
}
assertTrue("file:localhost".equals(site.getHost()));
return new File(site.getUploadDirectory());
}
protected static void update(final FilesCollection files) throws IOException {
final File ijRoot = files.prefix(".");
final Installer installer = new Installer(files, progress);
installer.start();
assertTrue(new File(ijRoot, "update").isDirectory());
installer.moveUpdatedIntoPlace();
assertFalse(new File(ijRoot, "update").exists());
}
protected static void upload(final FilesCollection files) throws Exception {
upload(files, DEFAULT_UPDATE_SITE);
}
protected static void upload(final FilesCollection files, final String updateSite) throws Exception {
for (final FileObject file : files.toUpload())
assertEquals(updateSite, file.updateSite);
final FilesUploader uploader =
new FilesUploader(null, files, updateSite, progress);
assertTrue(uploader.login());
uploader.upload(progress);
files.write();
}
protected static FileObject[] makeList(final FilesCollection files) {
final List<FileObject> list = new ArrayList<FileObject>();
for (final FileObject object : files)
list.add(object);
return list.toArray(new FileObject[list.size()]);
}
protected static void assertStatus(final Status status,
final FilesCollection files, final String filename)
{
final FileObject file = files.get(filename);
assertStatus(status, file);
}
protected static void
assertStatus(final Status status, final FileObject file)
{
assertNotNull("Object " + file.getFilename(), file);
assertEquals("Status of " + file.getFilename(), status, file.getStatus());
}
protected static void assertAction(final Action action,
final FilesCollection files, final String filename)
{
assertAction(action, files.get(filename));
}
protected static void assertAction(final Action action,
final FileObject file)
{
assertNotNull("Object " + file, file);
assertEquals("Action of " + file.filename, action, file.getAction());
}
protected static void assertNotEqual(final Object object1,
final Object object2)
{
if (object1 == null) {
assertNotNull(object2);
}
else {
assertFalse(object1.equals(object2));
}
}
protected static void assertNotEqual(final long long1, final long long2) {
assertTrue(long1 != long2);
}
protected static void
assertCount(final int count, final Iterable<?> iterable)
{
assertEquals(count, count(iterable));
}
protected static int count(final Iterable<?> iterable) {
int count = 0;
for (@SuppressWarnings("unused")
final Object object : iterable)
{
count++;
}
return count;
}
protected static void print(final Iterable<?> iterable) {
System.err.println("{");
int count = 0;
for (final Object object : iterable) {
System.err.println("\t" +
++count +
": " +
object +
(object instanceof FileObject ? " = " +
((FileObject) object).getStatus() + "/" +
((FileObject) object).getAction() : ""));
}
System.err.println("}");
}
/**
* Change the mtime of a file
*
* @param file the file to touch
* @param timestamp the mtime as pseudo-long (YYYYMMDDhhmmss)
*/
protected static void touch(final File file, final long timestamp) {
final long millis = UpdaterUtil.timestamp2millis(timestamp);
file.setLastModified(millis);
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files, final String path) throws FileNotFoundException, IOException
{
return writeJar(files, path, path, path);
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @param args a list of entry name / contents pairs
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files, final String path,
final String... args) throws FileNotFoundException, IOException
{
return writeJar(files.prefix(path), args);
}
/**
* Write a .jar file
*
* @param jarFile which .jar file to write into
* @param args a list of entry name / contents pairs
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final File jarFile,
final String... args) throws FileNotFoundException, IOException
{
assertTrue((args.length % 2) == 0);
jarFile.getParentFile().mkdirs();
final JarOutputStream jar = new JarOutputStream(new FileOutputStream(jarFile));
for (int i = 0; i + 1 < args.length; i += 2) {
final JarEntry entry = new JarEntry(args[i]);
jar.putNextEntry(entry);
jar.write(args[i + 1].getBytes());
jar.closeEntry();
}
jar.close();
return jarFile;
}
/**
* Write a .jar file
*
* @param files the files collection
* @param path the path of the .jar file
* @param classes a list of classes whose files to write
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final FilesCollection files,
final String path, final Class<?>... classes)
throws FileNotFoundException, IOException {
return writeJar(files.prefix(path), classes);
}
/**
* Write a .jar file
*
* @param file which directory to write into
* @param classes a list of classes whose files to write
* @return the File object for the .jar file
* @throws FileNotFoundException
* @throws IOException
*/
protected static File writeJar(final File file, final Class<?>... classes) throws FileNotFoundException, IOException {
file.getParentFile().mkdirs();
final Map<String, URL> extra = new LinkedHashMap<String, URL>();
final byte[] buffer = new byte[32768];
final JarOutputStream jar = new JarOutputStream(new FileOutputStream(file));
for (int i = 0; i < classes.length; i++) {
final String path = classes[i].getName().replace('.', '/') + ".class";
final JarEntry entry = new JarEntry(path);
jar.putNextEntry(entry);
final InputStream in = classes[i].getResourceAsStream("/" + path);
for (;;) {
int count = in.read(buffer);
if (count < 0)
break;
jar.write(buffer, 0, count);
}
in.close();
jar.closeEntry();
final String url = classes[i].getResource("/" + path).toString();
final String baseURL = url.substring(0, url.length() - path.length());
final URL metaInf = new URL(baseURL + "META-INF/");
for (final URL url2 : FileUtils.listContents(metaInf)) {
final String path2 = url2.toString().substring(baseURL.length());
if (!extra.containsKey(path2)) extra.put(path2, url2);
else {
final URL url3 = extra.get(path2);
if (!url2.equals(url3)) {
System.err.println("Warning: skipping duplicate " + path2 + "\n(" + url2 + " vs " + url3);
}
}
}
}
for (Entry<String, URL> entry2 : extra.entrySet()) {
final String path = entry2.getKey();
final JarEntry entry = new JarEntry(path);
jar.putNextEntry(entry);
final InputStream in = entry2.getValue().openStream();
for (;;) {
int count = in.read(buffer);
if (count < 0)
break;
jar.write(buffer, 0, count);
}
in.close();
jar.closeEntry();
}
jar.close();
return file;
}
/**
* Write a .gz file
*
* @param dir The directory into which to write
* @param name The file name
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
protected static File writeGZippedFile(final File dir, final String name,
final String content) throws FileNotFoundException, IOException
{
final File file = new File(dir, name);
file.getParentFile().mkdirs();
writeStream(new GZIPOutputStream(new FileOutputStream(file)), content, true);
return file;
}
/**
* Write a text file
*
* @param files The files collection
* @param path the path of the file into which to write
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final FilesCollection files, final String path, final String content)
throws FileNotFoundException, IOException
{
return writeFile(files.prefix(path), content);
}
/**
* Write a text file
*
* @param files The files collection
* @param path the path of the file into which to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final FilesCollection files, final String path)
throws FileNotFoundException, IOException
{
return writeFile(files.prefix(path), path);
}
/**
* Write a text file
*
* @param file The file into which to write
* @param content The contents to write
* @return the File object for the file that was written to
* @throws IOException
* @throws FileNotFoundException
*/
public static File writeFile(final File file, final String content)
throws FileNotFoundException, IOException
{
final File dir = file.getParentFile();
if (!dir.isDirectory()) dir.mkdirs();
final String name = file.getName();
if (name.endsWith(".jar")) return writeJar(file, content, content);
writeStream(new FileOutputStream(file), content, true);
return file;
}
/**
* Writes a string to a stream.
*
* @param out where to write to
* @param content what to write
* @param close whether to close the stream
*/
protected static void writeStream(final OutputStream out, final String content,
final boolean close)
{
final PrintWriter writer = new PrintWriter(out);
writer.println(content);
if (close) {
writer.close();
}
}
/**
* Reads a file's contents.
*
* @param file the file
* @return the contents, as a String
* @throws IOException
*/
protected static String readFile(final File file) throws IOException {
return readStream(new FileInputStream(file));
}
/**
* Read a gzip'ed stream and return what we got as a String
*
* @param in the input stream as compressed by gzip
* @return the contents, as a Stringcl
* @throws IOException
*/
protected static String readGzippedStream(final InputStream in) throws IOException {
return readStream(new GZIPInputStream(in));
}
/**
* Read a stream and return what we got as a String
*
* @param in the input stream
* @return the contents, as a String
* @throws IOException
*/
protected static String readStream(final InputStream in) throws IOException {
final ByteArrayOutputStream out = new ByteArrayOutputStream();
final byte[] buffer = new byte[16384];
for (;;) {
int count = in.read(buffer);
if (count < 0) break;
out.write(buffer, 0, count);
}
in.close();
out.close();
return out.toString();
}
/**
* A quieter version of the progress than {@link StderrProgress}.
*/
public final static Progress progress = new Progress() {
final boolean verbose = false;
final PrintStream err = System.err;
private String prefix = "", item = "";
@Override
public void setTitle(String title) {
prefix = title;
item = "";
}
@Override
public void setCount(int count, int total) {
if (verbose) err.print(prefix + item + count + "/" + total + "\r");
}
@Override
public void addItem(Object item) {
this.item = "/" + item + ": ";
}
@Override
public void setItemCount(int count, int total) {
if (verbose) err.print(prefix + item + " [" + count + "/" + total + "]\r");
}
@Override
public void itemDone(Object item) {
if (verbose) err.print(prefix + item + "\n");
}
@Override
public void done() {
// this space intentionally left blank
}
};
/**
* Writes a {@code .jar} file containing a single file with a specific timestamp.
*
* @param files the collection
* @param jarFileName the path of the {@code .jar} file
* @param year the year of the timestamp
* @param month the month of the timestamp
* @param day the day of the month of the timestamp
* @param fileName the name of the file contained in the {@code .jar} file
* @param fileContents the contents of the file contained in the {@code .jar} file
* @return a reference to the written {@code .jar} file
* @throws IOException
*/
public static File writeJarWithDatedFile(final FilesCollection files,
final String jarFileName, final int year, final int month,
final int day, final String fileName,
final String fileContents) throws IOException {
final File file = files.prefix(jarFileName);
final File dir = file.getParentFile();
if (dir != null && !dir.isDirectory()) assertTrue(dir.mkdirs());
final JarOutputStream out = new JarOutputStream(new FileOutputStream(file));
final JarEntry entry = new JarEntry(fileName);
entry.setTime(new GregorianCalendar(year, month, day).getTimeInMillis());
out.putNextEntry(entry);
out.write(fileContents.getBytes());
out.closeEntry();
out.close();
return file;
}
// work-around for bug in scijava-common 2.20.0, not needed with versions >= 2.20.1
private static File createTemporaryDirectory(final String prefix) throws IOException {
final Entry<Class<?>, String> entry = TestUtils
.getCallingCodeLocation(UpdaterTestUtils.class);
return TestUtils.createTemporaryDirectory(prefix, entry.getKey(),
entry.getValue());
}
}
| We updated to a newer scijava-common long ago
Signed-off-by: Johannes Schindelin <[email protected]>
| src/test/java/net/imagej/updater/UpdaterTestUtils.java | We updated to a newer scijava-common long ago | <ide><path>rc/test/java/net/imagej/updater/UpdaterTestUtils.java
<ide> import static org.junit.Assert.assertFalse;
<ide> import static org.junit.Assert.assertNotNull;
<ide> import static org.junit.Assert.assertTrue;
<del>
<del>import org.scijava.test.TestUtils;
<add>import static org.scijava.test.TestUtils.createTemporaryDirectory;
<ide>
<ide> import java.io.ByteArrayOutputStream;
<ide> import java.io.File;
<ide> out.close();
<ide> return file;
<ide> }
<del>
<del> // work-around for bug in scijava-common 2.20.0, not needed with versions >= 2.20.1
<del> private static File createTemporaryDirectory(final String prefix) throws IOException {
<del> final Entry<Class<?>, String> entry = TestUtils
<del> .getCallingCodeLocation(UpdaterTestUtils.class);
<del> return TestUtils.createTemporaryDirectory(prefix, entry.getKey(),
<del> entry.getValue());
<del> }
<ide> } |
|
JavaScript | agpl-3.0 | 7dbceec7a3556407d5fcbc5446c83d8d1292b16e | 0 | hawkrives/gobbldygook,hawkrives/gobbldygook,hawkrives/gobbldygook | 'use strict';
// Include gulp and tools
var autoprefixer = require('gulp-autoprefixer');
var browserSync = require('browser-sync');
var changed = require('gulp-changed');
var del = require('del');
var filter = require('gulp-filter');
var gulp = require('gulp');
var gutil = require('gulp-util');
var jshint = require('gulp-jshint');
var notify = require('gulp-notify');
var sass = require('gulp-sass');
var symlink = require('gulp-symlink');
var size = require('gulp-size');
var runSequence = require('run-sequence');
var sourcemaps = require('gulp-sourcemaps');
var webpack = require('webpack');
var config = require('./webpack-config');
var reload = browserSync.reload;
var compiler = webpack(config);
var AUTOPREFIXER_BROWSERS = [
'ie >= 11',
'ie_mob >= 11',
'ff >= 30',
'chrome >= 34',
'safari >= 8',
'opera >= 23',
'ios >= 8',
'android >= 4.4',
];
////
// JavaScript
///
// Build JS for the browser
gulp.task('webpack', function(callback){
compiler.run(function(err, stats) {
if (err)
notify.onError({message: 'webpack error'})
callback();
})
});
// Lint JavaScript
gulp.task('jshint', function () {
return gulp.src('app/scripts/**/*.{js,es6}')
.pipe(jshint())
.pipe(jshint.reporter('jshint-stylish'));
});
gulp.task('scripts', ['webpack', 'jshint']);
// Copy Web Fonts To Dist
gulp.task('fonts:woff', function () {
return gulp.src('app/styles/fonts/**')
.pipe(gulp.dest('dist/fonts'))
.pipe(size({title: 'fonts'}));
});
// Copy Icons To Dist
gulp.task('fonts:ionicons', function () {
return gulp.src('app/styles/ionicons/font/*.woff')
.pipe(gulp.dest('dist/ionicons'))
.pipe(size({title: 'ionicons'}))
});
gulp.task('fonts', ['fonts:woff', 'fonts:ionicons'])
// Automatically Prefix CSS
gulp.task('styles:css', function () {
return gulp.src('app/styles/**/*.css')
.pipe(changed('app/styles'))
.pipe(autoprefixer({browsers: AUTOPREFIXER_BROWSERS}))
.pipe(gulp.dest('dist'))
.pipe(reload({stream: true}))
.pipe(size({title: 'styles:css'}))
});
// Compile Any Other Sass Files You Added (app/styles)
gulp.task('styles:scss', function () {
return gulp.src('app/styles/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass())
.pipe(sourcemaps.write())
.on('error', notify.onError({
message: 'styles:scss error: <%= error.message %>'
}))
.pipe(autoprefixer({browsers: AUTOPREFIXER_BROWSERS}))
.pipe(gulp.dest('dist'))
.pipe(filter('**/*.css'))
.pipe(reload({stream: true}))
.pipe(size({title: 'styles:scss'}))
});
// Output Final CSS Styles
gulp.task('styles', ['styles:scss', 'styles:css']);
// Copy the html file
gulp.task('html', function () {
return gulp.src('app/index.html')
.pipe(gulp.dest('dist'))
.pipe(size({title: 'html'}));
});
// Clean Output Directory
gulp.task('clean', del.bind(null, ['dist']));
gulp.task('link', function() {
return gulp.src('data')
.pipe(symlink('dist/data', {force: true}))
});
// Watch Files For Changes & Reload
gulp.task('serve', ['webpack', 'html', 'styles', 'fonts', 'link'], function () {
browserSync.init({
notify: true,
minify: false,
browser: "google chrome",
server: {
baseDir: ['dist']
}
});
gulp.watch(['{app,mockups}/**/*.{js,es6}'], ['webpack', 'jshint', reload]);
gulp.watch(['app/styles/**/*.scss'], ['styles:scss']);
});
gulp.task('default', ['clean'], function(cb) {
runSequence('styles', ['jshint', 'webpack', 'html', 'fonts', 'link'], cb);
});
| gulpfile.js | 'use strict';
// Include gulp and tools
var autoprefixer = require('gulp-autoprefixer');
var browserSync = require('browser-sync');
var changed = require('gulp-changed');
var del = require('del');
var filter = require('gulp-filter');
var gulp = require('gulp');
var gutil = require('gulp-util');
var jshint = require('gulp-jshint');
var notify = require('gulp-notify');
var sass = require('gulp-sass');
var symlink = require('gulp-symlink');
var size = require('gulp-size');
var runSequence = require('run-sequence');
var sourcemaps = require('gulp-sourcemaps');
var webpack = require('webpack');
var config = require('./webpack-config');
var reload = browserSync.reload;
var compiler = webpack(config);
var AUTOPREFIXER_BROWSERS = [
'ie >= 11',
'ie_mob >= 11',
'ff >= 30',
'chrome >= 34',
'safari >= 8',
'opera >= 23',
'ios >= 8',
'android >= 4.4',
];
////
// JavaScript
///
// Build JS for the browser
gulp.task('webpack', function(callback){
compiler.run(function(err, stats) {
if (err)
notify.onError({message: 'webpack error'})
callback();
})
});
// Lint JavaScript
gulp.task('jshint', function () {
return gulp.src('app/scripts/**/*.{js,es6}')
.pipe(jshint())
.pipe(jshint.reporter('jshint-stylish'));
});
gulp.task('scripts', ['webpack', 'jshint']);
// Copy Web Fonts To Dist
gulp.task('fonts:woff', function () {
return gulp.src('app/styles/fonts/**')
.pipe(gulp.dest('dist/fonts'))
.pipe(size({title: 'fonts'}));
});
// Copy Icons To Dist
gulp.task('fonts:ionicons', function () {
return gulp.src('app/styles/ionicons/font/*.woff')
.pipe(gulp.dest('dist/ionicons'))
.pipe(size({title: 'ionicons'}))
});
gulp.task('fonts', ['fonts:woff', 'fonts:ionicons'])
// Automatically Prefix CSS
gulp.task('styles:css', function () {
return gulp.src('app/styles/**/*.css')
.pipe(changed('app/styles'))
.pipe(autoprefixer({browsers: AUTOPREFIXER_BROWSERS}))
.pipe(gulp.dest('dist'))
.pipe(reload({stream: true}))
.pipe(size({title: 'styles:css'}))
});
// Compile Any Other Sass Files You Added (app/styles)
gulp.task('styles:scss', function () {
return gulp.src('app/styles/**/*.scss')
.pipe(sourcemaps.init())
.pipe(sass())
.pipe(sourcemaps.write())
.on('error', notify.onError({
message: 'styles:scss error: <%= error.message %>'
}))
.pipe(autoprefixer({browsers: AUTOPREFIXER_BROWSERS}))
.pipe(gulp.dest('dist'))
.pipe(filter('**/*.css'))
.pipe(reload({stream: true}))
.pipe(size({title: 'styles:scss'}))
});
// Output Final CSS Styles
gulp.task('styles', ['styles:scss', 'styles:css']);
// Copy the html file
gulp.task('html', function () {
return gulp.src('app/index.html')
.pipe(gulp.dest('dist'))
.pipe(size({title: 'html'}));
});
// Clean Output Directory
gulp.task('clean', del.bind(null, ['dist']));
gulp.task('link', function() {
return gulp.src('data')
.pipe(symlink('dist/data', {force: true}))
});
// Watch Files For Changes & Reload
gulp.task('serve', ['webpack', 'html', 'styles', 'fonts', 'link'], function () {
browserSync.init({
notify: true,
minify: false,
browser: "google chrome",
server: {
baseDir: ['dist', './']
}
});
gulp.watch(['{app,mockups}/**/*.{js,es6}'], ['webpack', 'jshint', reload]);
gulp.watch(['app/styles/**/*.scss'], ['styles:scss']);
});
gulp.task('default', ['clean'], function(cb) {
runSequence('styles', ['jshint', 'webpack', 'html', 'fonts', 'link'], cb);
});
| Don't serve files from . anymore.
| gulpfile.js | Don't serve files from . anymore. | <ide><path>ulpfile.js
<ide> minify: false,
<ide> browser: "google chrome",
<ide> server: {
<del> baseDir: ['dist', './']
<add> baseDir: ['dist']
<ide> }
<ide> });
<ide> |
|
Java | bsd-2-clause | c8712863df738c89a22bb7a0da026217df1f6c30 | 0 | balcirakpeter/perun,zlamalp/perun,stavamichal/perun,jirmauritz/perun,licehammer/perun,stavamichal/perun,jirmauritz/perun,balcirakpeter/perun,CESNET/perun,zoraseb/perun,CESNET/perun,martin-kuba/perun,zwejra/perun,zoraseb/perun,zoraseb/perun,balcirakpeter/perun,mvocu/perun,CESNET/perun,zwejra/perun,martin-kuba/perun,balcirakpeter/perun,martin-kuba/perun,martin-kuba/perun,zlamalp/perun,jirmauritz/perun,stavamichal/perun,zoraseb/perun,CESNET/perun,mvocu/perun,stavamichal/perun,jirmauritz/perun,jirmauritz/perun,zlamalp/perun,licehammer/perun,martin-kuba/perun,zoraseb/perun,zlamalp/perun,licehammer/perun,balcirakpeter/perun,zlamalp/perun,stavamichal/perun,mvocu/perun,balcirakpeter/perun,licehammer/perun,martin-kuba/perun,mvocu/perun,stavamichal/perun,licehammer/perun,mvocu/perun,martin-kuba/perun,zlamalp/perun,CESNET/perun,zwejra/perun,zlamalp/perun,balcirakpeter/perun,zwejra/perun,CESNET/perun,licehammer/perun,jirmauritz/perun,CESNET/perun,zwejra/perun,zwejra/perun,mvocu/perun,mvocu/perun,stavamichal/perun,zoraseb/perun | package cz.metacentrum.perun.ldapc.initializer.utils;
import cz.metacentrum.perun.core.api.Attribute;
import cz.metacentrum.perun.core.api.AttributesManager;
import cz.metacentrum.perun.core.api.ExtSourcesManager;
import cz.metacentrum.perun.core.api.Facility;
import cz.metacentrum.perun.core.api.Group;
import cz.metacentrum.perun.core.api.Member;
import cz.metacentrum.perun.core.api.PerunPrincipal;
import cz.metacentrum.perun.core.api.PerunSession;
import cz.metacentrum.perun.core.api.Resource;
import cz.metacentrum.perun.core.api.Status;
import cz.metacentrum.perun.core.api.User;
import cz.metacentrum.perun.core.api.UserExtSource;
import cz.metacentrum.perun.core.api.Vo;
import cz.metacentrum.perun.core.api.exceptions.AttributeNotExistsException;
import cz.metacentrum.perun.core.api.exceptions.FacilityNotExistsException;
import cz.metacentrum.perun.core.api.exceptions.InternalErrorException;
import cz.metacentrum.perun.core.api.exceptions.PrivilegeException;
import cz.metacentrum.perun.core.api.exceptions.WrongAttributeAssignmentException;
import cz.metacentrum.perun.core.bl.PerunBl;
import cz.metacentrum.perun.ldapc.initializer.beans.PerunInitializer;
import cz.metacentrum.perun.rpclib.Rpc;
import cz.metacentrum.perun.rpclib.api.RpcCaller;
import cz.metacentrum.perun.rpclib.impl.RpcCallerImpl;
import java.io.BufferedWriter;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Class with static utility methods
*
* @author Michal Stava <[email protected]>
*/
public class Utils {
/**
* Method to set last processed id for concrete consumer
*
* @param consumerName name of consumer to set
* @param lastProcessedId id to set
* @param perunPrincipal perunPrincipal for initializing RpcCaller
* @throws InternalErrorException
* @throws PrivilegeException
*/
public static void setLastProcessedId(PerunPrincipal perunPrincipal, String consumerName, int lastProcessedId) throws InternalErrorException, PrivilegeException {
RpcCaller rpcCaller = new RpcCallerImpl(perunPrincipal);
Rpc.AuditMessagesManager.setLastProcessedId(rpcCaller, consumerName, lastProcessedId);
}
/**
* Return Writer for output for specific file with fileName.
* If fileName is null, return standard output
*
* @param fileName fileName or null (if stdout)
* @return writer with specific output
*
* @exception FileNotFoundException if defined file can't be created
*/
public static Writer getWriterForOutput(String fileName) throws FileNotFoundException {
if (fileName != null) return new PrintWriter(fileName);
else return new OutputStreamWriter(System.out);
}
/**
* Method generate all Vos to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllVosToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//Get list of all vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//For every vos get needed information and write them to the writer
for(Vo vo: vos) {
String dn = "dn: ";
String desc = "description: ";
String oc1 = "objectclass: top";
String oc2 = "objectclass: organization";
String oc3 = "objectclass: perunVO";
String o = "o: ";
String perunVoId = "perunVoId: ";
perunVoId+= String.valueOf(vo.getId());
o+= vo.getShortName();
desc+= vo.getName();
dn+= "perunVoId=" + vo.getId() + ",dc=perun,dc=cesnet,dc=cz";
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc2 + '\n');
writer.write(oc3 + '\n');
writer.write(o + '\n');
writer.write(perunVoId + '\n');
writer.write(desc + '\n');
//Generate all members in member groups of this vo and add them here (only members with status Valid)
List<Member> validMembers = perun.getMembersManagerBl().getMembers(perunSession, vo, Status.VALID);
for(Member m: validMembers) {
writer.write("uniqueMember: perunUserId=" + m.getUserId() + ",ou=People,dc=perun,dc=cesnet,dc=cz" + '\n');
}
writer.write('\n');
}
}
/**
* Method generate all Resources to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllResourcesToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//first get all Vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//Then from every Vo get all assigned resources and write their data to the writer
for(Vo vo: vos) {
List<Resource> resources;
resources = perun.getResourcesManagerBl().getResources(perunSession, vo);
for(Resource resource: resources) {
//Read facility attribute entityID and write it for the resource if exists
Facility facility = null;
try {
facility = perun.getFacilitiesManagerBl().getFacilityById(perunSession, resource.getFacilityId());
} catch (FacilityNotExistsException ex) {
throw new InternalErrorException("Can't found facility of this resource " + resource, ex);
}
Attribute entityIDAttr = null;
try {
entityIDAttr = perun.getAttributesManagerBl().getAttribute(perunSession, facility, AttributesManager.NS_FACILITY_ATTR_DEF + ":entityID");
} catch (AttributeNotExistsException | WrongAttributeAssignmentException ex) {
throw new InternalErrorException("Problem with loading entityID attribute of facility " + facility, ex);
}
String dn = "dn: ";
String oc1 = "objectclass: top";
String oc3 = "objectclass: perunResource";
String cn = "cn: ";
String perunVoId = "perunVoId: ";
String perunFacilityId = "perunFacilityId: ";
String perunResourceId = "perunResourceId: ";
String description = "description: ";
String entityID = "entityID: ";
perunVoId+= String.valueOf(resource.getVoId());
perunFacilityId+= String.valueOf(resource.getFacilityId());
perunResourceId+= String.valueOf(resource.getId());
dn+= "perunResourceId=" + resource.getId() + ",perunVoId=" + resource.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
cn+= resource.getName();
String descriptionValue = resource.getDescription();
if(descriptionValue != null) {
if(descriptionValue.matches("^[ ]*$")) descriptionValue = null;
}
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc3 + '\n');
writer.write(cn + '\n');
writer.write(perunResourceId + '\n');
if(descriptionValue != null) writer.write(description + descriptionValue + '\n');
writer.write(perunVoId + '\n');
writer.write(perunFacilityId + '\n');
if(entityIDAttr.getValue() != null) writer.write(entityID + (String) entityIDAttr.getValue() + '\n');
//ADD resources which group is assigned to
List<Group> associatedGroups = perun.getResourcesManagerBl().getAssignedGroups(perunSession, resource);
for(Group g: associatedGroups) {
writer.write("assignedGroupId: " + g.getId());
writer.write('\n');
}
writer.write('\n');
}
}
}
/**
* Method generate all Groups to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllGroupsToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//First get all vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//Then from all vos get all assigned groups and generate data about them to the writer
for(Vo vo: vos) {
List<Group> groups;
groups = perun.getGroupsManagerBl().getGroups(perunSession, vo);
for(Group group: groups) {
String dn = "dn: ";
String oc1 = "objectclass: top";
String oc3 = "objectclass: perunGroup";
String cn = "cn: ";
String perunVoId = "perunVoId: ";
String parentGroup = "perunParentGroup: ";
String parentGroupId = "perunParentGroupId: ";
String perunGroupId = "perunGroupId: ";
String owner = "owner: ";
String description = "description: ";
String perunUniqueGroupName = "perunUniqueGroupName: ";
List<Member> members;
members = perun.getGroupsManagerBl().getGroupMembers(perunSession, group, Status.VALID);
perunGroupId+= String.valueOf(group.getId());
perunVoId+= String.valueOf(group.getVoId());
dn+= "perunGroupId=" + group.getId() + ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
cn+= group.getName();
perunUniqueGroupName+= vo.getShortName() + ":" + group.getName();
if(group.getDescription() != null) description+= group.getDescription();
if(group.getParentGroupId() != null) {
parentGroupId+= group.getParentGroupId();
parentGroup+= "perunGroupId=" + group.getParentGroupId()+ ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
}
List<Member> admins = new ArrayList<>();
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc3 + '\n');
writer.write(cn + '\n');
writer.write(perunUniqueGroupName + '\n');
writer.write(perunGroupId + '\n');
writer.write(perunVoId + '\n');
if(group.getDescription() != null) writer.write(description + '\n');
if(group.getParentGroupId() != null) {
writer.write(parentGroupId + '\n');
writer.write(parentGroup + '\n');
}
//ADD Group Members
for(Member m: members) {
writer.write("uniqueMember: " + "perunUserId=" + m.getUserId() + ",ou=People,dc=perun,dc=cesnet,dc=cz");
writer.write('\n');
}
//ADD resources which group is assigned to
List<Resource> associatedResources;
associatedResources = perun.getResourcesManagerBl().getAssignedResources(perunSession, group);
for(Resource r: associatedResources) {
writer.write("assignedToResourceId: " + r.getId());
writer.write('\n');
}
//FOR NOW No groups has owner
writer.write(owner + '\n');
writer.write('\n');
}
}
}
/**
* Method generate all Users to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
* @throws AttributeNotExistsException
* @throws WrongAttributeAssignmentException
*/
public static void generateAllUsersToWriter(PerunInitializer perunInitializer) throws IOException, InternalErrorException, AttributeNotExistsException, WrongAttributeAssignmentException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
List<User> users = perun.getUsersManagerBl().getUsers(perunSession);
for(User user: users) {
String dn = "dn: ";
String entryStatus = "entryStatus: active";
String oc1 = "objectclass: top";
String oc2 = "objectclass: person";
String oc3 = "objectclass: organizationalPerson";
String oc4 = "objectclass: inetOrgPerson";
String oc5 = "objectclass: perunUser";
String oc6 = "objectclass: tenOperEntry";
String oc7 = "objectclass: inetUser";
String sn = "sn: ";
String cn = "cn: ";
String givenName = "givenName: ";
String perunUserId = "perunUserId: ";
String mail = "mail: ";
String preferredMail = "preferredMail: ";
String o = "o: ";
String isServiceUser = "isServiceUser: ";
String isSponsoredUser = "isSponsoredUser: ";
String userPassword = "userPassword: ";
List<String> membersOf = new ArrayList<>();
List<Member> members;
Set<String> membersOfPerunVo = new HashSet<>();
members = perun.getMembersManagerBl().getMembersByUser(perunSession, user);
for(Member member: members) {
if(member.getStatus().equals(Status.VALID)) {
membersOfPerunVo.add("memberOfPerunVo: " + member.getVoId());
List<Group> groups;
groups = perun.getGroupsManagerBl().getAllMemberGroups(perunSession, member);
for(Group group: groups) {
membersOf.add("memberOf: " + "perunGroupId=" + group.getId() + ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz");
}
}
}
//Attribute attrMail = perun.getAttributesManagerBl().getAttribute(perunSession, u, AttributesManager.NS_USER_ATTR_DEF + ":mail");
Attribute attrPreferredMail = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":preferredMail");
Attribute attrOrganization = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":organization");
Attribute attrVirtCertDNs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_VIRT + ":userCertDNs");
Attribute attrLibraryIDs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":libraryIDs");
perunUserId+= String.valueOf(user.getId());
dn+= "perunUserId=" + user.getId() + ",ou=People,dc=perun,dc=cesnet,dc=cz";
String firstName = user.getFirstName();
String lastName = user.getLastName();
if(firstName == null) firstName = "";
if(lastName == null || lastName.isEmpty()) lastName = "N/A";
sn+= lastName;
cn+= firstName + " " + lastName;
if(user.isServiceUser()) isServiceUser+= "1";
else isServiceUser+= "0";
if(user.isSponsoredUser()) isSponsoredUser+= "1";
else isSponsoredUser+= "0";
if(firstName.isEmpty()) givenName = null;
else givenName+= firstName;
if(attrPreferredMail == null || attrPreferredMail.getValue() == null) mail = null;
else mail+= (String) attrPreferredMail.getValue();
if(attrPreferredMail == null || attrPreferredMail.getValue() == null) preferredMail =null;
else preferredMail+= (String) attrPreferredMail.getValue();
if(attrOrganization == null || attrOrganization.getValue() == null) o= null;
else o+= (String) attrOrganization.getValue();
Map<String, String> certDNs = null;
Set<String> certSubjectsWithPrefix = null;
Set<String> certSubjectsWithoutPrefix = new HashSet<>();
if(attrVirtCertDNs != null && attrVirtCertDNs.getValue() != null) {
certDNs = (Map) attrVirtCertDNs.getValue();
certSubjectsWithPrefix = certDNs.keySet();
for(String certSubject: certSubjectsWithPrefix) {
certSubjectsWithoutPrefix.add(certSubject.replaceFirst("^[0-9]+[:]", ""));
}
}
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc2 + '\n');
writer.write(oc3 + '\n');
writer.write(oc4 + '\n');
writer.write(oc5 + '\n');
writer.write(oc6 + '\n');
writer.write(oc7 + '\n');
writer.write(entryStatus + '\n');
writer.write(sn + '\n');
writer.write(cn + '\n');
if(givenName != null) writer.write(givenName + '\n');
writer.write(perunUserId + '\n');
writer.write(isServiceUser + '\n');
writer.write(isSponsoredUser + '\n');
if(mail != null) writer.write(mail + '\n');
if(preferredMail != null) writer.write(preferredMail + '\n');
if(o != null) writer.write(o + '\n');
if(certSubjectsWithoutPrefix != null && !certSubjectsWithoutPrefix.isEmpty()) {
for(String s: certSubjectsWithoutPrefix) {
writer.write("userCertificateSubject: " + s + '\n');
}
}
List<String> libraryIDs = new ArrayList<>();
if(attrLibraryIDs.getValue() != null) {
libraryIDs = (ArrayList) attrLibraryIDs.getValue();
}
if(libraryIDs != null && !libraryIDs.isEmpty()) {
for(String id : libraryIDs) {
writer.write("libraryIDs: " + id + '\n');
}
}
//GET ALL USERS UIDs
List<String> similarUids = perun.getAttributesManagerBl().getAllSimilarAttributeNames(perunSession, AttributesManager.NS_USER_ATTR_DEF + ":uid-namespace:");
if(similarUids != null && !similarUids.isEmpty()) {
for(String s: similarUids) {
Attribute uidNamespace = perun.getAttributesManagerBl().getAttribute(perunSession, user, s);
if(uidNamespace != null && uidNamespace.getValue() != null) {
writer.write("uidNumber;x-ns-" + uidNamespace.getFriendlyNameParameter() + ": " + uidNamespace.getValue().toString() + '\n');
}
}
}
//GET ALL USERS LOGINs
List<String> similarLogins = perun.getAttributesManagerBl().getAllSimilarAttributeNames(perunSession, AttributesManager.NS_USER_ATTR_DEF + ":login-namespace:");
if(similarLogins != null && !similarLogins.isEmpty()) {
for(String s: similarLogins) {
Attribute loginNamespace = perun.getAttributesManagerBl().getAttribute(perunSession, user, s);
if(loginNamespace != null && loginNamespace.getValue() != null) {
writer.write("login;x-ns-" + loginNamespace.getFriendlyNameParameter() + ": " + loginNamespace.getValue().toString() + '\n');
if(loginNamespace.getFriendlyNameParameter().equals("einfra")) {
writer.write(userPassword + "{SASL}" + loginNamespace.getValue().toString() + '@' + loginNamespace.getFriendlyNameParameter().toUpperCase() + '\n');
}
}
}
}
//GET ALL USERS EXTlogins FOR EVERY EXTSOURCE WITH TYPE EQUALS IDP
List<UserExtSource> userExtSources = perun.getUsersManagerBl().getUserExtSources(perunSession, user);
List<String> extLogins = new ArrayList<>();
for(UserExtSource ues: userExtSources) {
if(ues != null && ues.getExtSource() != null) {
String type = ues.getExtSource().getType();
if(type != null) {
if(type.equals(ExtSourcesManager.EXTSOURCE_IDP)) {
String extLogin;
extLogin = ues.getLogin();
if(extLogin == null) extLogin = "";
writer.write("eduPersonPrincipalNames: " + extLogin + '\n');
}
}
}
}
//ADD MEMBEROF ATTRIBUTE TO WRITER
for(String s: membersOf) {
writer.write(s + '\n');
}
//ADD MEMBEROFPERUNVO ATTRIBUTE TO WRITER
for(String s: membersOfPerunVo) {
writer.write(s + '\n');
}
writer.write('\n');
}
}
}
| perun-ldapc-initializer/src/main/java/cz/metacentrum/perun/ldapc/initializer/utils/Utils.java | package cz.metacentrum.perun.ldapc.initializer.utils;
import cz.metacentrum.perun.core.api.Attribute;
import cz.metacentrum.perun.core.api.AttributesManager;
import cz.metacentrum.perun.core.api.ExtSourcesManager;
import cz.metacentrum.perun.core.api.Facility;
import cz.metacentrum.perun.core.api.Group;
import cz.metacentrum.perun.core.api.Member;
import cz.metacentrum.perun.core.api.PerunPrincipal;
import cz.metacentrum.perun.core.api.PerunSession;
import cz.metacentrum.perun.core.api.Resource;
import cz.metacentrum.perun.core.api.Status;
import cz.metacentrum.perun.core.api.User;
import cz.metacentrum.perun.core.api.UserExtSource;
import cz.metacentrum.perun.core.api.Vo;
import cz.metacentrum.perun.core.api.exceptions.AttributeNotExistsException;
import cz.metacentrum.perun.core.api.exceptions.FacilityNotExistsException;
import cz.metacentrum.perun.core.api.exceptions.InternalErrorException;
import cz.metacentrum.perun.core.api.exceptions.PrivilegeException;
import cz.metacentrum.perun.core.api.exceptions.WrongAttributeAssignmentException;
import cz.metacentrum.perun.core.bl.PerunBl;
import cz.metacentrum.perun.ldapc.initializer.beans.PerunInitializer;
import cz.metacentrum.perun.rpclib.Rpc;
import cz.metacentrum.perun.rpclib.api.RpcCaller;
import cz.metacentrum.perun.rpclib.impl.RpcCallerImpl;
import java.io.BufferedWriter;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* Class with static utility methods
*
* @author Michal Stava <[email protected]>
*/
public class Utils {
/**
* Method to set last processed id for concrete consumer
*
* @param consumerName name of consumer to set
* @param lastProcessedId id to set
* @param perunPrincipal perunPrincipal for initializing RpcCaller
* @throws InternalErrorException
* @throws PrivilegeException
*/
public static void setLastProcessedId(PerunPrincipal perunPrincipal, String consumerName, int lastProcessedId) throws InternalErrorException, PrivilegeException {
RpcCaller rpcCaller = new RpcCallerImpl(perunPrincipal);
Rpc.AuditMessagesManager.setLastProcessedId(rpcCaller, consumerName, lastProcessedId);
}
/**
* Return Writer for output for specific file with fileName.
* If fileName is null, return standard output
*
* @param fileName fileName or null (if stdout)
* @return writer with specific output
*
* @exception FileNotFoundException if defined file can't be created
*/
public static Writer getWriterForOutput(String fileName) throws FileNotFoundException {
if (fileName != null) return new PrintWriter(fileName);
else return new OutputStreamWriter(System.out);
}
/**
* Method generate all Vos to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllVosToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//Get list of all vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//For every vos get needed information and write them to the writer
for(Vo vo: vos) {
String dn = "dn: ";
String desc = "description: ";
String oc1 = "objectclass: top";
String oc2 = "objectclass: organization";
String oc3 = "objectclass: perunVO";
String o = "o: ";
String perunVoId = "perunVoId: ";
perunVoId+= String.valueOf(vo.getId());
o+= vo.getShortName();
desc+= vo.getName();
dn+= "perunVoId=" + vo.getId() + ",dc=perun,dc=cesnet,dc=cz";
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc2 + '\n');
writer.write(oc3 + '\n');
writer.write(o + '\n');
writer.write(perunVoId + '\n');
writer.write(desc + '\n');
//Generate all members in member groups of this vo and add them here (only members with status Valid)
List<Member> validMembers = perun.getMembersManagerBl().getMembers(perunSession, vo, Status.VALID);
for(Member m: validMembers) {
writer.write("uniqueMember: perunUserId=" + m.getUserId() + ",ou=People,dc=perun,dc=cesnet,dc=cz" + '\n');
}
writer.write('\n');
}
}
/**
* Method generate all Resources to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllResourcesToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//first get all Vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//Then from every Vo get all assigned resources and write their data to the writer
for(Vo vo: vos) {
List<Resource> resources;
resources = perun.getResourcesManagerBl().getResources(perunSession, vo);
for(Resource resource: resources) {
//Read facility attribute entityID and write it for the resource if exists
Facility facility = null;
try {
facility = perun.getFacilitiesManagerBl().getFacilityById(perunSession, resource.getFacilityId());
} catch (FacilityNotExistsException ex) {
throw new InternalErrorException("Can't found facility of this resource " + resource, ex);
}
Attribute entityIDAttr = null;
try {
entityIDAttr = perun.getAttributesManagerBl().getAttribute(perunSession, facility, AttributesManager.NS_FACILITY_ATTR_DEF + ":entityID");
} catch (AttributeNotExistsException | WrongAttributeAssignmentException ex) {
throw new InternalErrorException("Problem with loading entityID attribute of facility " + facility, ex);
}
String dn = "dn: ";
String oc1 = "objectclass: top";
String oc3 = "objectclass: perunResource";
String cn = "cn: ";
String perunVoId = "perunVoId: ";
String perunFacilityId = "perunFacilityId: ";
String perunResourceId = "perunResourceId: ";
String description = "description: ";
String entityID = "entityID: ";
perunVoId+= String.valueOf(resource.getVoId());
perunFacilityId+= String.valueOf(resource.getFacilityId());
perunResourceId+= String.valueOf(resource.getId());
dn+= "perunResourceId=" + resource.getId() + ",perunVoId=" + resource.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
cn+= resource.getName();
String descriptionValue = resource.getDescription();
if(descriptionValue != null) {
if(descriptionValue.matches("^[ ]*$")) descriptionValue = null;
}
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc3 + '\n');
writer.write(cn + '\n');
writer.write(perunResourceId + '\n');
if(descriptionValue != null) writer.write(description + descriptionValue + '\n');
writer.write(perunVoId + '\n');
writer.write(perunFacilityId + '\n');
if(entityIDAttr.getValue() != null) writer.write(entityID + (String) entityIDAttr.getValue() + '\n');
//ADD resources which group is assigned to
List<Group> associatedGroups = perun.getResourcesManagerBl().getAssignedGroups(perunSession, resource);
for(Group g: associatedGroups) {
writer.write("assignedGroupId: " + g.getId());
writer.write('\n');
}
writer.write('\n');
}
}
}
/**
* Method generate all Groups to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
*/
public static void generateAllGroupsToWriter(PerunInitializer perunInitializer) throws InternalErrorException, IOException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
//First get all vos
List<Vo> vos = perun.getVosManagerBl().getVos(perunSession);
//Then from all vos get all assigned groups and generate data about them to the writer
for(Vo vo: vos) {
List<Group> groups;
groups = perun.getGroupsManagerBl().getGroups(perunSession, vo);
for(Group group: groups) {
String dn = "dn: ";
String oc1 = "objectclass: top";
String oc3 = "objectclass: perunGroup";
String cn = "cn: ";
String perunVoId = "perunVoId: ";
String parentGroup = "perunParentGroup: ";
String parentGroupId = "perunParentGroupId: ";
String perunGroupId = "perunGroupId: ";
String owner = "owner: ";
String description = "description: ";
String perunUniqueGroupName = "perunUniqueGroupName: ";
List<Member> members;
members = perun.getGroupsManagerBl().getGroupMembers(perunSession, group, Status.VALID);
perunGroupId+= String.valueOf(group.getId());
perunVoId+= String.valueOf(group.getVoId());
dn+= "perunGroupId=" + group.getId() + ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
cn+= group.getName();
perunUniqueGroupName+= vo.getShortName() + ":" + group.getName();
if(group.getDescription() != null) description+= group.getDescription();
if(group.getParentGroupId() != null) {
parentGroupId+= group.getParentGroupId();
parentGroup+= "perunGroupId=" + group.getParentGroupId()+ ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz";
}
List<Member> admins = new ArrayList<>();
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc3 + '\n');
writer.write(cn + '\n');
writer.write(perunUniqueGroupName + '\n');
writer.write(perunGroupId + '\n');
writer.write(perunVoId + '\n');
if(group.getDescription() != null) writer.write(description + '\n');
if(group.getParentGroupId() != null) {
writer.write(parentGroupId + '\n');
writer.write(parentGroup + '\n');
}
//ADD Group Members
for(Member m: members) {
writer.write("uniqueMember: " + "perunUserId=" + m.getUserId() + ",ou=People,dc=perun,dc=cesnet,dc=cz");
writer.write('\n');
}
//ADD resources which group is assigned to
List<Resource> associatedResources;
associatedResources = perun.getResourcesManagerBl().getAssignedResources(perunSession, group);
for(Resource r: associatedResources) {
writer.write("assignedToResourceId: " + r.getId());
writer.write('\n');
}
//FOR NOW No groups has owner
writer.write(owner + '\n');
writer.write('\n');
}
}
}
/**
* Method generate all Users to the text for using in LDIF.
* Write all these information to writer in perunInitializer object.
*
* @param perunInitializer need to be loaded to get all needed dependencies
*
* @throws InternalErrorException if some problem with initializer or objects in perun-core
* @throws IOException if some problem with writer
* @throws AttributeNotExistsException
* @throws WrongAttributeAssignmentException
*/
public static void generateAllUsersToWriter(PerunInitializer perunInitializer) throws IOException, InternalErrorException, AttributeNotExistsException, WrongAttributeAssignmentException {
//Load basic variables
if(perunInitializer == null) throw new InternalErrorException("PerunInitializer must be loaded before using in generating methods!");
PerunSession perunSession = perunInitializer.getPerunSession();
PerunBl perun = perunInitializer.getPerunBl();
BufferedWriter writer = perunInitializer.getOutputWriter();
List<User> users = perun.getUsersManagerBl().getUsers(perunSession);
for(User user: users) {
String dn = "dn: ";
String entryStatus = "entryStatus: active";
String oc1 = "objectclass: top";
String oc2 = "objectclass: person";
String oc3 = "objectclass: organizationalPerson";
String oc4 = "objectclass: inetOrgPerson";
String oc5 = "objectclass: perunUser";
String oc6 = "objectclass: tenOperEntry";
String oc7 = "objectclass: inetUser";
String sn = "sn: ";
String cn = "cn: ";
String givenName = "givenName: ";
String perunUserId = "perunUserId: ";
String mail = "mail: ";
String preferredMail = "preferredMail: ";
String o = "o: ";
String isServiceUser = "isServiceUser: ";
String isSponsoredUser = "isSponsoredUser: ";
String userPassword = "userPassword: ";
String phone = "telephoneNumber: ";
List<String> membersOf = new ArrayList<>();
List<Member> members;
Set<String> membersOfPerunVo = new HashSet<>();
members = perun.getMembersManagerBl().getMembersByUser(perunSession, user);
for(Member member: members) {
if(member.getStatus().equals(Status.VALID)) {
membersOfPerunVo.add("memberOfPerunVo: " + member.getVoId());
List<Group> groups;
groups = perun.getGroupsManagerBl().getAllMemberGroups(perunSession, member);
for(Group group: groups) {
membersOf.add("memberOf: " + "perunGroupId=" + group.getId() + ",perunVoId=" + group.getVoId() + ",dc=perun,dc=cesnet,dc=cz");
}
}
}
//Attribute attrMail = perun.getAttributesManagerBl().getAttribute(perunSession, u, AttributesManager.NS_USER_ATTR_DEF + ":mail");
Attribute attrPreferredMail = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":preferredMail");
Attribute attrOrganization = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":organization");
Attribute attrVirtCertDNs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_VIRT + ":userCertDNs");
Attribute attrLibraryIDs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":libraryIDs");
Attribute attrPhone = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":phone");
perunUserId+= String.valueOf(user.getId());
dn+= "perunUserId=" + user.getId() + ",ou=People,dc=perun,dc=cesnet,dc=cz";
String firstName = user.getFirstName();
String lastName = user.getLastName();
if(firstName == null) firstName = "";
if(lastName == null || lastName.isEmpty()) lastName = "N/A";
sn+= lastName;
cn+= firstName + " " + lastName;
if(user.isServiceUser()) isServiceUser+= "1";
else isServiceUser+= "0";
if(user.isSponsoredUser()) isSponsoredUser+= "1";
else isSponsoredUser+= "0";
if(firstName.isEmpty()) givenName = null;
else givenName+= firstName;
if(attrPreferredMail == null || attrPreferredMail.getValue() == null) mail = null;
else mail+= (String) attrPreferredMail.getValue();
if(attrPreferredMail == null || attrPreferredMail.getValue() == null) preferredMail =null;
else preferredMail+= (String) attrPreferredMail.getValue();
if(attrOrganization == null || attrOrganization.getValue() == null) o= null;
else o+= (String) attrOrganization.getValue();
if(attrPhone == null || attrPhone.getValue() == null || ((String) attrPhone.getValue()).isEmpty()) phone= null;
else phone+= (String) attrPhone.getValue();
Map<String, String> certDNs = null;
Set<String> certSubjectsWithPrefix = null;
Set<String> certSubjectsWithoutPrefix = new HashSet<>();
if(attrVirtCertDNs != null && attrVirtCertDNs.getValue() != null) {
certDNs = (Map) attrVirtCertDNs.getValue();
certSubjectsWithPrefix = certDNs.keySet();
for(String certSubject: certSubjectsWithPrefix) {
certSubjectsWithoutPrefix.add(certSubject.replaceFirst("^[0-9]+[:]", ""));
}
}
writer.write(dn + '\n');
writer.write(oc1 + '\n');
writer.write(oc2 + '\n');
writer.write(oc3 + '\n');
writer.write(oc4 + '\n');
writer.write(oc5 + '\n');
writer.write(oc6 + '\n');
writer.write(oc7 + '\n');
writer.write(entryStatus + '\n');
writer.write(sn + '\n');
writer.write(cn + '\n');
if(givenName != null) writer.write(givenName + '\n');
writer.write(perunUserId + '\n');
writer.write(isServiceUser + '\n');
writer.write(isSponsoredUser + '\n');
if(mail != null) writer.write(mail + '\n');
if(preferredMail != null) writer.write(preferredMail + '\n');
if(o != null) writer.write(o + '\n');
if(phone != null) writer.write(phone + '\n');
if(certSubjectsWithoutPrefix != null && !certSubjectsWithoutPrefix.isEmpty()) {
for(String s: certSubjectsWithoutPrefix) {
writer.write("userCertificateSubject: " + s + '\n');
}
}
List<String> libraryIDs = new ArrayList<>();
if(attrLibraryIDs.getValue() != null) {
libraryIDs = (ArrayList) attrLibraryIDs.getValue();
}
if(libraryIDs != null && !libraryIDs.isEmpty()) {
for(String id : libraryIDs) {
writer.write("libraryIDs: " + id + '\n');
}
}
//GET ALL USERS UIDs
List<String> similarUids = perun.getAttributesManagerBl().getAllSimilarAttributeNames(perunSession, AttributesManager.NS_USER_ATTR_DEF + ":uid-namespace:");
if(similarUids != null && !similarUids.isEmpty()) {
for(String s: similarUids) {
Attribute uidNamespace = perun.getAttributesManagerBl().getAttribute(perunSession, user, s);
if(uidNamespace != null && uidNamespace.getValue() != null) {
writer.write("uidNumber;x-ns-" + uidNamespace.getFriendlyNameParameter() + ": " + uidNamespace.getValue().toString() + '\n');
}
}
}
//GET ALL USERS LOGINs
List<String> similarLogins = perun.getAttributesManagerBl().getAllSimilarAttributeNames(perunSession, AttributesManager.NS_USER_ATTR_DEF + ":login-namespace:");
if(similarLogins != null && !similarLogins.isEmpty()) {
for(String s: similarLogins) {
Attribute loginNamespace = perun.getAttributesManagerBl().getAttribute(perunSession, user, s);
if(loginNamespace != null && loginNamespace.getValue() != null) {
writer.write("login;x-ns-" + loginNamespace.getFriendlyNameParameter() + ": " + loginNamespace.getValue().toString() + '\n');
if(loginNamespace.getFriendlyNameParameter().equals("einfra")) {
writer.write(userPassword + "{SASL}" + loginNamespace.getValue().toString() + '@' + loginNamespace.getFriendlyNameParameter().toUpperCase() + '\n');
}
}
}
}
//GET ALL USERS EXTlogins FOR EVERY EXTSOURCE WITH TYPE EQUALS IDP
List<UserExtSource> userExtSources = perun.getUsersManagerBl().getUserExtSources(perunSession, user);
List<String> extLogins = new ArrayList<>();
for(UserExtSource ues: userExtSources) {
if(ues != null && ues.getExtSource() != null) {
String type = ues.getExtSource().getType();
if(type != null) {
if(type.equals(ExtSourcesManager.EXTSOURCE_IDP)) {
String extLogin;
extLogin = ues.getLogin();
if(extLogin == null) extLogin = "";
writer.write("eduPersonPrincipalNames: " + extLogin + '\n');
}
}
}
}
//ADD MEMBEROF ATTRIBUTE TO WRITER
for(String s: membersOf) {
writer.write(s + '\n');
}
//ADD MEMBEROFPERUNVO ATTRIBUTE TO WRITER
for(String s: membersOfPerunVo) {
writer.write(s + '\n');
}
writer.write('\n');
}
}
}
| Revert "Add phone to ldapc initializer for user objects"
This reverts commit b29df586e22715ee7fa773295af51ebf7faa28c0.
Related to revert in commit a5dc6c23c5c0c3dbf118316f8d9e721424438970
| perun-ldapc-initializer/src/main/java/cz/metacentrum/perun/ldapc/initializer/utils/Utils.java | Revert "Add phone to ldapc initializer for user objects" | <ide><path>erun-ldapc-initializer/src/main/java/cz/metacentrum/perun/ldapc/initializer/utils/Utils.java
<ide> String isServiceUser = "isServiceUser: ";
<ide> String isSponsoredUser = "isSponsoredUser: ";
<ide> String userPassword = "userPassword: ";
<del> String phone = "telephoneNumber: ";
<ide> List<String> membersOf = new ArrayList<>();
<ide> List<Member> members;
<ide> Set<String> membersOfPerunVo = new HashSet<>();
<ide> Attribute attrOrganization = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":organization");
<ide> Attribute attrVirtCertDNs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_VIRT + ":userCertDNs");
<ide> Attribute attrLibraryIDs = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":libraryIDs");
<del> Attribute attrPhone = perun.getAttributesManagerBl().getAttribute(perunSession, user, AttributesManager.NS_USER_ATTR_DEF + ":phone");
<ide> perunUserId+= String.valueOf(user.getId());
<ide> dn+= "perunUserId=" + user.getId() + ",ou=People,dc=perun,dc=cesnet,dc=cz";
<ide> String firstName = user.getFirstName();
<ide> else preferredMail+= (String) attrPreferredMail.getValue();
<ide> if(attrOrganization == null || attrOrganization.getValue() == null) o= null;
<ide> else o+= (String) attrOrganization.getValue();
<del> if(attrPhone == null || attrPhone.getValue() == null || ((String) attrPhone.getValue()).isEmpty()) phone= null;
<del> else phone+= (String) attrPhone.getValue();
<ide> Map<String, String> certDNs = null;
<ide> Set<String> certSubjectsWithPrefix = null;
<ide> Set<String> certSubjectsWithoutPrefix = new HashSet<>();
<ide> if(mail != null) writer.write(mail + '\n');
<ide> if(preferredMail != null) writer.write(preferredMail + '\n');
<ide> if(o != null) writer.write(o + '\n');
<del> if(phone != null) writer.write(phone + '\n');
<ide> if(certSubjectsWithoutPrefix != null && !certSubjectsWithoutPrefix.isEmpty()) {
<ide> for(String s: certSubjectsWithoutPrefix) {
<ide> writer.write("userCertificateSubject: " + s + '\n'); |
|
Java | apache-2.0 | ad3060a463aa3b90289996e64925eebdcd88150b | 0 | GerritCodeReview/gerrit,WANdisco/gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,qtproject/qtqa-gerrit,qtproject/qtqa-gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,qtproject/qtqa-gerrit,WANdisco/gerrit,WANdisco/gerrit,WANdisco/gerrit,qtproject/qtqa-gerrit,GerritCodeReview/gerrit,GerritCodeReview/gerrit,WANdisco/gerrit,GerritCodeReview/gerrit,GerritCodeReview/gerrit,qtproject/qtqa-gerrit,GerritCodeReview/gerrit,qtproject/qtqa-gerrit,qtproject/qtqa-gerrit | // Copyright (C) 2016 The Android Open Source Project
//
// 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.google.gerrit.acceptance;
import com.google.gerrit.reviewdb.client.Change.Id;
import com.google.gerrit.server.index.QueryOptions;
import com.google.gerrit.server.index.Schema;
import com.google.gerrit.server.index.change.ChangeIndex;
import com.google.gerrit.server.query.DataSource;
import com.google.gerrit.server.query.Predicate;
import com.google.gerrit.server.query.QueryParseException;
import com.google.gerrit.server.query.change.ChangeData;
import java.io.IOException;
class ReadOnlyChangeIndex implements ChangeIndex {
private final ChangeIndex index;
ReadOnlyChangeIndex(ChangeIndex index) {
this.index = index;
}
ChangeIndex unwrap() {
return index;
}
@Override
public Schema<ChangeData> getSchema() {
return index.getSchema();
}
@Override
public void close() {
index.close();
}
@Override
public void replace(ChangeData obj) throws IOException {
// do nothing
}
@Override
public void delete(Id key) throws IOException {
// do nothing
}
@Override
public void deleteAll() throws IOException {
// do nothing
}
@Override
public DataSource<ChangeData> getSource(Predicate<ChangeData> p, QueryOptions opts)
throws QueryParseException {
return index.getSource(p, opts);
}
@Override
public void markReady(boolean ready) throws IOException {
// do nothing
}
}
| gerrit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java | // Copyright (C) 2016 The Android Open Source Project
//
// 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.google.gerrit.acceptance;
import com.google.gerrit.reviewdb.client.Change.Id;
import com.google.gerrit.server.index.QueryOptions;
import com.google.gerrit.server.index.Schema;
import com.google.gerrit.server.index.change.ChangeIndex;
import com.google.gerrit.server.query.DataSource;
import com.google.gerrit.server.query.Predicate;
import com.google.gerrit.server.query.QueryParseException;
import com.google.gerrit.server.query.change.ChangeData;
import java.io.IOException;
public class ReadOnlyChangeIndex implements ChangeIndex {
private final ChangeIndex index;
public ReadOnlyChangeIndex(ChangeIndex index) {
this.index = index;
}
public ChangeIndex unwrap() {
return index;
}
@Override
public Schema<ChangeData> getSchema() {
return index.getSchema();
}
@Override
public void close() {
index.close();
}
@Override
public void replace(ChangeData obj) throws IOException {
// do nothing
}
@Override
public void delete(Id key) throws IOException {
// do nothing
}
@Override
public void deleteAll() throws IOException {
// do nothing
}
@Override
public DataSource<ChangeData> getSource(Predicate<ChangeData> p, QueryOptions opts)
throws QueryParseException {
return index.getSource(p, opts);
}
@Override
public void markReady(boolean ready) throws IOException {
// do nothing
}
}
| ReadOnlyChangeIndex: Reduce visibility to package
Change-Id: If0ab91299e518cb6244c8470cad573621997584b
| gerrit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java | ReadOnlyChangeIndex: Reduce visibility to package | <ide><path>errit-acceptance-framework/src/test/java/com/google/gerrit/acceptance/ReadOnlyChangeIndex.java
<ide> import com.google.gerrit.server.query.change.ChangeData;
<ide> import java.io.IOException;
<ide>
<del>public class ReadOnlyChangeIndex implements ChangeIndex {
<add>class ReadOnlyChangeIndex implements ChangeIndex {
<ide> private final ChangeIndex index;
<ide>
<del> public ReadOnlyChangeIndex(ChangeIndex index) {
<add> ReadOnlyChangeIndex(ChangeIndex index) {
<ide> this.index = index;
<ide> }
<ide>
<del> public ChangeIndex unwrap() {
<add> ChangeIndex unwrap() {
<ide> return index;
<ide> }
<ide> |
|
Java | apache-2.0 | 67452577ba9323e6e4535372de1b66979e62cdf4 | 0 | asedunov/intellij-community,ahb0327/intellij-community,alphafoobar/intellij-community,Distrotech/intellij-community,fnouama/intellij-community,petteyg/intellij-community,clumsy/intellij-community,holmes/intellij-community,retomerz/intellij-community,jagguli/intellij-community,caot/intellij-community,kool79/intellij-community,lucafavatella/intellij-community,signed/intellij-community,hurricup/intellij-community,tmpgit/intellij-community,da1z/intellij-community,consulo/consulo,robovm/robovm-studio,xfournet/intellij-community,dslomov/intellij-community,jagguli/intellij-community,fengbaicanhe/intellij-community,ahb0327/intellij-community,caot/intellij-community,MER-GROUP/intellij-community,diorcety/intellij-community,asedunov/intellij-community,kdwink/intellij-community,da1z/intellij-community,kool79/intellij-community,kdwink/intellij-community,dslomov/intellij-community,da1z/intellij-community,izonder/intellij-community,ibinti/intellij-community,supersven/intellij-community,muntasirsyed/intellij-community,ahb0327/intellij-community,nicolargo/intellij-community,MichaelNedzelsky/intellij-community,fitermay/intellij-community,vladmm/intellij-community,suncycheng/intellij-community,orekyuu/intellij-community,dslomov/intellij-community,fengbaicanhe/intellij-community,dslomov/intellij-community,joewalnes/idea-community,TangHao1987/intellij-community,jagguli/intellij-community,signed/intellij-community,suncycheng/intellij-community,petteyg/intellij-community,nicolargo/intellij-community,vvv1559/intellij-community,da1z/intellij-community,salguarnieri/intellij-community,nicolargo/intellij-community,ahb0327/intellij-community,adedayo/intellij-community,asedunov/intellij-community,ThiagoGarciaAlves/intellij-community,ol-loginov/intellij-community,youdonghai/intellij-community,petteyg/intellij-community,mglukhikh/intellij-community,petteyg/intellij-community,fnouama/intellij-community,SerCeMan/intellij-community,blademainer/intellij-community,alphafoobar/intellij-community,ftomassetti/intellij-community,idea4bsd/idea4bsd,wreckJ/intellij-community,fengbaicanhe/intellij-community,ivan-fedorov/intellij-community,ryano144/intellij-community,izonder/intellij-community,dslomov/intellij-community,nicolargo/intellij-community,holmes/intellij-community,holmes/intellij-community,FHannes/intellij-community,xfournet/intellij-community,allotria/intellij-community,ftomassetti/intellij-community,ol-loginov/intellij-community,fitermay/intellij-community,Distrotech/intellij-community,mglukhikh/intellij-community,allotria/intellij-community,semonte/intellij-community,kool79/intellij-community,FHannes/intellij-community,caot/intellij-community,ThiagoGarciaAlves/intellij-community,SerCeMan/intellij-community,blademainer/intellij-community,FHannes/intellij-community,blademainer/intellij-community,FHannes/intellij-community,orekyuu/intellij-community,ThiagoGarciaAlves/intellij-community,MichaelNedzelsky/intellij-community,petteyg/intellij-community,ibinti/intellij-community,SerCeMan/intellij-community,FHannes/intellij-community,MichaelNedzelsky/intellij-community,holmes/intellij-community,TangHao1987/intellij-community,dslomov/intellij-community,FHannes/intellij-community,ftomassetti/intellij-community,robovm/robovm-studio,hurricup/intellij-community,semonte/intellij-community,Lekanich/intellij-community,apixandru/intellij-community,retomerz/intellij-community,pwoodworth/intellij-community,youdonghai/intellij-community,lucafavatella/intellij-community,fitermay/intellij-community,ftomassetti/intellij-community,samthor/intellij-community,MER-GROUP/intellij-community,amith01994/intellij-community,ryano144/intellij-community,hurricup/intellij-community,adedayo/intellij-community,wreckJ/intellij-community,ivan-fedorov/intellij-community,caot/intellij-community,FHannes/intellij-community,vvv1559/intellij-community,nicolargo/intellij-community,TangHao1987/intellij-community,ThiagoGarciaAlves/intellij-community,MER-GROUP/intellij-community,blademainer/intellij-community,lucafavatella/intellij-community,ThiagoGarciaAlves/intellij-community,gnuhub/intellij-community,clumsy/intellij-community,salguarnieri/intellij-community,ThiagoGarciaAlves/intellij-community,fengbaicanhe/intellij-community,hurricup/intellij-community,kool79/intellij-community,vvv1559/intellij-community,joewalnes/idea-community,idea4bsd/idea4bsd,vladmm/intellij-community,da1z/intellij-community,ibinti/intellij-community,nicolargo/intellij-community,retomerz/intellij-community,salguarnieri/intellij-community,ftomassetti/intellij-community,SerCeMan/intellij-community,clumsy/intellij-community,consulo/consulo,akosyakov/intellij-community,hurricup/intellij-community,dslomov/intellij-community,hurricup/intellij-community,jagguli/intellij-community,robovm/robovm-studio,xfournet/intellij-community,da1z/intellij-community,Lekanich/intellij-community,ivan-fedorov/intellij-community,caot/intellij-community,mglukhikh/intellij-community,vladmm/intellij-community,adedayo/intellij-community,diorcety/intellij-community,vladmm/intellij-community,xfournet/intellij-community,orekyuu/intellij-community,samthor/intellij-community,jagguli/intellij-community,muntasirsyed/intellij-community,adedayo/intellij-community,kdwink/intellij-community,Lekanich/intellij-community,xfournet/intellij-community,ivan-fedorov/intellij-community,samthor/intellij-community,retomerz/intellij-community,diorcety/intellij-community,ibinti/intellij-community,caot/intellij-community,MichaelNedzelsky/intellij-community,muntasirsyed/intellij-community,jagguli/intellij-community,TangHao1987/intellij-community,ol-loginov/intellij-community,kdwink/intellij-community,michaelgallacher/intellij-community,pwoodworth/intellij-community,kdwink/intellij-community,kool79/intellij-community,caot/intellij-community,samthor/intellij-community,samthor/intellij-community,akosyakov/intellij-community,ernestp/consulo,supersven/intellij-community,wreckJ/intellij-community,michaelgallacher/intellij-community,youdonghai/intellij-community,tmpgit/intellij-community,apixandru/intellij-community,akosyakov/intellij-community,apixandru/intellij-community,signed/intellij-community,holmes/intellij-community,caot/intellij-community,ibinti/intellij-community,holmes/intellij-community,hurricup/intellij-community,apixandru/intellij-community,michaelgallacher/intellij-community,youdonghai/intellij-community,apixandru/intellij-community,MichaelNedzelsky/intellij-community,fengbaicanhe/intellij-community,da1z/intellij-community,pwoodworth/intellij-community,ibinti/intellij-community,tmpgit/intellij-community,consulo/consulo,wreckJ/intellij-community,fnouama/intellij-community,blademainer/intellij-community,allotria/intellij-community,Lekanich/intellij-community,wreckJ/intellij-community,amith01994/intellij-community,ol-loginov/intellij-community,ernestp/consulo,slisson/intellij-community,akosyakov/intellij-community,Lekanich/intellij-community,fengbaicanhe/intellij-community,ivan-fedorov/intellij-community,jagguli/intellij-community,alphafoobar/intellij-community,allotria/intellij-community,gnuhub/intellij-community,diorcety/intellij-community,akosyakov/intellij-community,idea4bsd/idea4bsd,suncycheng/intellij-community,retomerz/intellij-community,orekyuu/intellij-community,vvv1559/intellij-community,pwoodworth/intellij-community,gnuhub/intellij-community,ivan-fedorov/intellij-community,fengbaicanhe/intellij-community,michaelgallacher/intellij-community,lucafavatella/intellij-community,allotria/intellij-community,asedunov/intellij-community,petteyg/intellij-community,vladmm/intellij-community,ernestp/consulo,clumsy/intellij-community,idea4bsd/idea4bsd,xfournet/intellij-community,signed/intellij-community,blademainer/intellij-community,SerCeMan/intellij-community,muntasirsyed/intellij-community,diorcety/intellij-community,idea4bsd/idea4bsd,semonte/intellij-community,supersven/intellij-community,orekyuu/intellij-community,Lekanich/intellij-community,TangHao1987/intellij-community,vladmm/intellij-community,amith01994/intellij-community,fengbaicanhe/intellij-community,ryano144/intellij-community,apixandru/intellij-community,mglukhikh/intellij-community,consulo/consulo,diorcety/intellij-community,supersven/intellij-community,Lekanich/intellij-community,FHannes/intellij-community,da1z/intellij-community,jagguli/intellij-community,robovm/robovm-studio,robovm/robovm-studio,samthor/intellij-community,asedunov/intellij-community,ThiagoGarciaAlves/intellij-community,idea4bsd/idea4bsd,ivan-fedorov/intellij-community,holmes/intellij-community,wreckJ/intellij-community,amith01994/intellij-community,tmpgit/intellij-community,signed/intellij-community,xfournet/intellij-community,kool79/intellij-community,hurricup/intellij-community,blademainer/intellij-community,SerCeMan/intellij-community,dslomov/intellij-community,fitermay/intellij-community,orekyuu/intellij-community,tmpgit/intellij-community,mglukhikh/intellij-community,amith01994/intellij-community,dslomov/intellij-community,samthor/intellij-community,asedunov/intellij-community,ftomassetti/intellij-community,amith01994/intellij-community,allotria/intellij-community,fitermay/intellij-community,diorcety/intellij-community,asedunov/intellij-community,signed/intellij-community,lucafavatella/intellij-community,kdwink/intellij-community,robovm/robovm-studio,vvv1559/intellij-community,joewalnes/idea-community,salguarnieri/intellij-community,supersven/intellij-community,ernestp/consulo,slisson/intellij-community,nicolargo/intellij-community,fitermay/intellij-community,supersven/intellij-community,vvv1559/intellij-community,petteyg/intellij-community,orekyuu/intellij-community,clumsy/intellij-community,jagguli/intellij-community,MichaelNedzelsky/intellij-community,ahb0327/intellij-community,dslomov/intellij-community,pwoodworth/intellij-community,alphafoobar/intellij-community,signed/intellij-community,idea4bsd/idea4bsd,ryano144/intellij-community,izonder/intellij-community,akosyakov/intellij-community,ol-loginov/intellij-community,ftomassetti/intellij-community,FHannes/intellij-community,muntasirsyed/intellij-community,kdwink/intellij-community,alphafoobar/intellij-community,samthor/intellij-community,wreckJ/intellij-community,retomerz/intellij-community,allotria/intellij-community,signed/intellij-community,michaelgallacher/intellij-community,apixandru/intellij-community,amith01994/intellij-community,ftomassetti/intellij-community,izonder/intellij-community,vladmm/intellij-community,salguarnieri/intellij-community,signed/intellij-community,MER-GROUP/intellij-community,michaelgallacher/intellij-community,vvv1559/intellij-community,idea4bsd/idea4bsd,robovm/robovm-studio,mglukhikh/intellij-community,jagguli/intellij-community,tmpgit/intellij-community,caot/intellij-community,holmes/intellij-community,youdonghai/intellij-community,FHannes/intellij-community,robovm/robovm-studio,akosyakov/intellij-community,salguarnieri/intellij-community,clumsy/intellij-community,wreckJ/intellij-community,MichaelNedzelsky/intellij-community,pwoodworth/intellij-community,adedayo/intellij-community,Distrotech/intellij-community,retomerz/intellij-community,ThiagoGarciaAlves/intellij-community,xfournet/intellij-community,joewalnes/idea-community,lucafavatella/intellij-community,alphafoobar/intellij-community,robovm/robovm-studio,semonte/intellij-community,MER-GROUP/intellij-community,joewalnes/idea-community,alphafoobar/intellij-community,idea4bsd/idea4bsd,xfournet/intellij-community,clumsy/intellij-community,asedunov/intellij-community,lucafavatella/intellij-community,youdonghai/intellij-community,slisson/intellij-community,muntasirsyed/intellij-community,apixandru/intellij-community,retomerz/intellij-community,signed/intellij-community,semonte/intellij-community,asedunov/intellij-community,akosyakov/intellij-community,izonder/intellij-community,ryano144/intellij-community,izonder/intellij-community,akosyakov/intellij-community,kool79/intellij-community,SerCeMan/intellij-community,allotria/intellij-community,lucafavatella/intellij-community,SerCeMan/intellij-community,vladmm/intellij-community,suncycheng/intellij-community,fitermay/intellij-community,kool79/intellij-community,suncycheng/intellij-community,adedayo/intellij-community,idea4bsd/idea4bsd,vvv1559/intellij-community,nicolargo/intellij-community,ThiagoGarciaAlves/intellij-community,petteyg/intellij-community,adedayo/intellij-community,slisson/intellij-community,semonte/intellij-community,fitermay/intellij-community,xfournet/intellij-community,vladmm/intellij-community,FHannes/intellij-community,mglukhikh/intellij-community,mglukhikh/intellij-community,ibinti/intellij-community,Distrotech/intellij-community,michaelgallacher/intellij-community,ftomassetti/intellij-community,muntasirsyed/intellij-community,kool79/intellij-community,ahb0327/intellij-community,slisson/intellij-community,MER-GROUP/intellij-community,alphafoobar/intellij-community,ryano144/intellij-community,gnuhub/intellij-community,ahb0327/intellij-community,tmpgit/intellij-community,suncycheng/intellij-community,hurricup/intellij-community,salguarnieri/intellij-community,semonte/intellij-community,fnouama/intellij-community,asedunov/intellij-community,holmes/intellij-community,Distrotech/intellij-community,MER-GROUP/intellij-community,Distrotech/intellij-community,MichaelNedzelsky/intellij-community,salguarnieri/intellij-community,ftomassetti/intellij-community,amith01994/intellij-community,supersven/intellij-community,tmpgit/intellij-community,ahb0327/intellij-community,diorcety/intellij-community,signed/intellij-community,youdonghai/intellij-community,adedayo/intellij-community,Lekanich/intellij-community,kool79/intellij-community,allotria/intellij-community,SerCeMan/intellij-community,michaelgallacher/intellij-community,consulo/consulo,ibinti/intellij-community,Distrotech/intellij-community,ryano144/intellij-community,orekyuu/intellij-community,lucafavatella/intellij-community,petteyg/intellij-community,nicolargo/intellij-community,da1z/intellij-community,salguarnieri/intellij-community,semonte/intellij-community,michaelgallacher/intellij-community,fitermay/intellij-community,nicolargo/intellij-community,suncycheng/intellij-community,gnuhub/intellij-community,TangHao1987/intellij-community,ryano144/intellij-community,fnouama/intellij-community,holmes/intellij-community,alphafoobar/intellij-community,vvv1559/intellij-community,xfournet/intellij-community,petteyg/intellij-community,pwoodworth/intellij-community,vvv1559/intellij-community,SerCeMan/intellij-community,ThiagoGarciaAlves/intellij-community,ahb0327/intellij-community,MichaelNedzelsky/intellij-community,pwoodworth/intellij-community,adedayo/intellij-community,TangHao1987/intellij-community,michaelgallacher/intellij-community,gnuhub/intellij-community,Lekanich/intellij-community,signed/intellij-community,kool79/intellij-community,fnouama/intellij-community,fitermay/intellij-community,adedayo/intellij-community,SerCeMan/intellij-community,alphafoobar/intellij-community,retomerz/intellij-community,lucafavatella/intellij-community,samthor/intellij-community,wreckJ/intellij-community,jagguli/intellij-community,MER-GROUP/intellij-community,salguarnieri/intellij-community,Distrotech/intellij-community,ivan-fedorov/intellij-community,ahb0327/intellij-community,gnuhub/intellij-community,semonte/intellij-community,izonder/intellij-community,wreckJ/intellij-community,apixandru/intellij-community,ernestp/consulo,diorcety/intellij-community,supersven/intellij-community,semonte/intellij-community,diorcety/intellij-community,caot/intellij-community,caot/intellij-community,michaelgallacher/intellij-community,apixandru/intellij-community,apixandru/intellij-community,asedunov/intellij-community,ibinti/intellij-community,youdonghai/intellij-community,akosyakov/intellij-community,ryano144/intellij-community,izonder/intellij-community,ibinti/intellij-community,ernestp/consulo,pwoodworth/intellij-community,consulo/consulo,izonder/intellij-community,asedunov/intellij-community,clumsy/intellij-community,retomerz/intellij-community,ivan-fedorov/intellij-community,MichaelNedzelsky/intellij-community,youdonghai/intellij-community,youdonghai/intellij-community,Lekanich/intellij-community,blademainer/intellij-community,apixandru/intellij-community,joewalnes/idea-community,ThiagoGarciaAlves/intellij-community,xfournet/intellij-community,kdwink/intellij-community,orekyuu/intellij-community,allotria/intellij-community,ryano144/intellij-community,izonder/intellij-community,blademainer/intellij-community,lucafavatella/intellij-community,joewalnes/idea-community,youdonghai/intellij-community,slisson/intellij-community,pwoodworth/intellij-community,samthor/intellij-community,mglukhikh/intellij-community,ol-loginov/intellij-community,jagguli/intellij-community,idea4bsd/idea4bsd,kdwink/intellij-community,fnouama/intellij-community,signed/intellij-community,fitermay/intellij-community,amith01994/intellij-community,joewalnes/idea-community,lucafavatella/intellij-community,ibinti/intellij-community,MER-GROUP/intellij-community,Distrotech/intellij-community,mglukhikh/intellij-community,TangHao1987/intellij-community,diorcety/intellij-community,ol-loginov/intellij-community,dslomov/intellij-community,ol-loginov/intellij-community,fengbaicanhe/intellij-community,fitermay/intellij-community,holmes/intellij-community,blademainer/intellij-community,ibinti/intellij-community,amith01994/intellij-community,suncycheng/intellij-community,orekyuu/intellij-community,TangHao1987/intellij-community,ol-loginov/intellij-community,allotria/intellij-community,vladmm/intellij-community,gnuhub/intellij-community,tmpgit/intellij-community,nicolargo/intellij-community,kdwink/intellij-community,holmes/intellij-community,retomerz/intellij-community,wreckJ/intellij-community,fengbaicanhe/intellij-community,allotria/intellij-community,MER-GROUP/intellij-community,TangHao1987/intellij-community,hurricup/intellij-community,gnuhub/intellij-community,robovm/robovm-studio,tmpgit/intellij-community,supersven/intellij-community,joewalnes/idea-community,fengbaicanhe/intellij-community,ivan-fedorov/intellij-community,izonder/intellij-community,suncycheng/intellij-community,orekyuu/intellij-community,akosyakov/intellij-community,fnouama/intellij-community,semonte/intellij-community,samthor/intellij-community,michaelgallacher/intellij-community,clumsy/intellij-community,asedunov/intellij-community,MER-GROUP/intellij-community,muntasirsyed/intellij-community,ThiagoGarciaAlves/intellij-community,semonte/intellij-community,clumsy/intellij-community,salguarnieri/intellij-community,fengbaicanhe/intellij-community,xfournet/intellij-community,amith01994/intellij-community,idea4bsd/idea4bsd,blademainer/intellij-community,muntasirsyed/intellij-community,izonder/intellij-community,vvv1559/intellij-community,kdwink/intellij-community,orekyuu/intellij-community,clumsy/intellij-community,ol-loginov/intellij-community,fnouama/intellij-community,alphafoobar/intellij-community,ivan-fedorov/intellij-community,da1z/intellij-community,kdwink/intellij-community,ahb0327/intellij-community,supersven/intellij-community,dslomov/intellij-community,wreckJ/intellij-community,adedayo/intellij-community,muntasirsyed/intellij-community,hurricup/intellij-community,akosyakov/intellij-community,allotria/intellij-community,MichaelNedzelsky/intellij-community,petteyg/intellij-community,samthor/intellij-community,mglukhikh/intellij-community,pwoodworth/intellij-community,fnouama/intellij-community,slisson/intellij-community,robovm/robovm-studio,slisson/intellij-community,MER-GROUP/intellij-community,slisson/intellij-community,FHannes/intellij-community,gnuhub/intellij-community,blademainer/intellij-community,kool79/intellij-community,ibinti/intellij-community,adedayo/intellij-community,Lekanich/intellij-community,suncycheng/intellij-community,ryano144/intellij-community,muntasirsyed/intellij-community,apixandru/intellij-community,ryano144/intellij-community,hurricup/intellij-community,ftomassetti/intellij-community,TangHao1987/intellij-community,ahb0327/intellij-community,youdonghai/intellij-community,amith01994/intellij-community,Lekanich/intellij-community,retomerz/intellij-community,tmpgit/intellij-community,caot/intellij-community,vladmm/intellij-community,slisson/intellij-community,petteyg/intellij-community,retomerz/intellij-community,vvv1559/intellij-community,ol-loginov/intellij-community,mglukhikh/intellij-community,nicolargo/intellij-community,TangHao1987/intellij-community,alphafoobar/intellij-community,supersven/intellij-community,lucafavatella/intellij-community,MichaelNedzelsky/intellij-community,muntasirsyed/intellij-community,supersven/intellij-community,SerCeMan/intellij-community,suncycheng/intellij-community,Distrotech/intellij-community,Distrotech/intellij-community,slisson/intellij-community,fnouama/intellij-community,da1z/intellij-community,hurricup/intellij-community,robovm/robovm-studio,apixandru/intellij-community,idea4bsd/idea4bsd,slisson/intellij-community,semonte/intellij-community,Distrotech/intellij-community,ivan-fedorov/intellij-community,diorcety/intellij-community,da1z/intellij-community,fitermay/intellij-community,FHannes/intellij-community,ftomassetti/intellij-community,clumsy/intellij-community,suncycheng/intellij-community,gnuhub/intellij-community,mglukhikh/intellij-community,ol-loginov/intellij-community,vvv1559/intellij-community,da1z/intellij-community,youdonghai/intellij-community,pwoodworth/intellij-community,vladmm/intellij-community,gnuhub/intellij-community,tmpgit/intellij-community,fnouama/intellij-community,salguarnieri/intellij-community | /*
* Copyright 2000-2009 JetBrains s.r.o.
*
* 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.intellij.ide.fileTemplates;
import com.intellij.ide.IdeBundle;
import com.intellij.ide.fileTemplates.impl.FileTemplateImpl;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.PathManager;
import com.intellij.openapi.application.ex.PathManagerEx;
import com.intellij.openapi.command.CommandProcessor;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.fileTypes.FileType;
import com.intellij.openapi.fileTypes.FileTypes;
import com.intellij.openapi.fileTypes.ex.FileTypeManagerEx;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.util.ClassLoaderUtil;
import com.intellij.openapi.util.ThrowableComputable;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.psi.codeStyle.CodeStyleSettingsManager;
import com.intellij.util.ArrayUtil;
import org.apache.commons.collections.ExtendedProperties;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.exception.VelocityException;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.RuntimeServices;
import org.apache.velocity.runtime.RuntimeSingleton;
import org.apache.velocity.runtime.log.LogSystem;
import org.apache.velocity.runtime.parser.ParseException;
import org.apache.velocity.runtime.parser.node.ASTReference;
import org.apache.velocity.runtime.parser.node.Node;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
import org.apache.velocity.runtime.resource.loader.FileResourceLoader;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.*;
import java.lang.reflect.Field;
import java.util.*;
import static com.intellij.util.containers.CollectionFactory.ar;
/**
* @author MYakovlev
*/
public class FileTemplateUtil{
private static final Logger LOG = Logger.getInstance("#com.intellij.ide.fileTemplates.FileTemplateUtil");
private static boolean ourVelocityInitialized = false;
private static final CreateFromTemplateHandler ourDefaultCreateFromTemplateHandler = new DefaultCreateFromTemplateHandler();
private FileTemplateUtil() {
}
public static String[] calculateAttributes(String templateContent, Properties properties, boolean includeDummies) throws ParseException {
initVelocity();
final Set<String> unsetAttributes = new HashSet<String>();
//noinspection HardCodedStringLiteral
addAttributesToVector(unsetAttributes, RuntimeSingleton.parse(new StringReader(templateContent), "MyTemplate"), properties, includeDummies);
return ArrayUtil.toStringArray(unsetAttributes);
}
private static void addAttributesToVector(Set<String> references, Node apacheNode, Properties properties, boolean includeDummies){
int childCount = apacheNode.jjtGetNumChildren();
for(int i = 0; i < childCount; i++){
Node apacheChild = apacheNode.jjtGetChild(i);
addAttributesToVector(references, apacheChild, properties, includeDummies);
if(apacheChild instanceof ASTReference){
ASTReference apacheReference = (ASTReference)apacheChild;
String s = apacheReference.literal();
s = referenceToAttribute(s, includeDummies);
if (s != null && s.length() > 0 && properties.getProperty(s) == null) references.add(s);
}
}
}
/**
* Removes each two leading '\', removes leading $, removes {}
* Examples:
* $qqq -> qqq
* \$qqq -> qqq if dummy attributes are collected too, null otherwise
* \\$qqq -> qqq
* ${qqq} -> qqq
*/
@Nullable
private static String referenceToAttribute(String attrib, boolean includeDummies) {
while (attrib.startsWith("\\\\")) {
attrib = attrib.substring(2);
}
if (attrib.startsWith("\\$")) {
if (includeDummies) {
attrib = attrib.substring(1);
}
else return null;
}
if (!StringUtil.startsWithChar(attrib, '$')) {
return null;
}
attrib = attrib.substring(1);
if (StringUtil.startsWithChar(attrib, '{')) {
String cleanAttribute = null;
for (int i = 1; i < attrib.length(); i++) {
char currChar = attrib.charAt(i);
if (currChar == '{' || currChar == '.') {
// Invalid match
cleanAttribute = null;
break;
}
else if (currChar == '}') {
// Valid match
cleanAttribute = attrib.substring(1, i);
break;
}
}
attrib = cleanAttribute;
}
else {
for (int i = 0; i < attrib.length(); i++) {
char currChar = attrib.charAt(i);
if (currChar == '{' || currChar == '}' || currChar == '.') {
attrib = attrib.substring(0, i);
break;
}
}
}
return attrib;
}
public static String mergeTemplate(Map attributes, String content) throws IOException{
initVelocity();
VelocityContext context = new VelocityContext();
for (final Object o : attributes.keySet()) {
String name = (String)o;
context.put(name, attributes.get(name));
}
return mergeTemplate(content, context);
}
public static String mergeTemplate(Properties attributes, String content) throws IOException{
initVelocity();
VelocityContext context = new VelocityContext();
Enumeration<?> names = attributes.propertyNames();
while (names.hasMoreElements()){
String name = (String)names.nextElement();
context.put(name, attributes.getProperty(name));
}
return mergeTemplate(content, context);
}
private static String mergeTemplate(String templateContent, final VelocityContext context) throws IOException {
initVelocity();
StringWriter stringWriter = new StringWriter();
try {
Velocity.evaluate(context, stringWriter, "", templateContent);
}
catch (VelocityException e) {
LOG.error("Error evaluating template:\n"+templateContent,e);
ApplicationManager.getApplication().invokeLater(new Runnable() {
public void run() {
Messages.showErrorDialog(IdeBundle.message("error.parsing.file.template"),
IdeBundle.message("title.velocity.error"));
}
});
}
return stringWriter.toString();
}
public static FileTemplate cloneTemplate(FileTemplate template){
FileTemplateImpl templateImpl = (FileTemplateImpl) template;
return (FileTemplate)templateImpl.clone();
}
public static void copyTemplate(FileTemplate src, FileTemplate dest){
dest.setExtension(src.getExtension());
dest.setName(src.getName());
dest.setText(src.getText());
dest.setAdjust(src.isAdjust());
}
@SuppressWarnings({"HardCodedStringLiteral"})
private static synchronized void initVelocity(){
try{
if (ourVelocityInitialized) {
return;
}
File modifiedPatternsPath = new File(PathManager.getConfigPath());
modifiedPatternsPath = new File(modifiedPatternsPath, "fileTemplates");
modifiedPatternsPath = new File(modifiedPatternsPath, "includes");
LogSystem emptyLogSystem = new LogSystem() {
public void init(RuntimeServices runtimeServices) throws Exception {
}
public void logVelocityMessage(int i, String s) {
//todo[myakovlev] log somethere?
}
};
Velocity.setProperty(RuntimeConstants.RUNTIME_LOG_LOGSYSTEM, emptyLogSystem);
Velocity.setProperty(RuntimeConstants.RESOURCE_LOADER, "file,class");
//todo[myakovlev] implement my own Loader, with ability to load templates from classpath
Velocity.setProperty("file.resource.loader.class", MyFileResourceLoader.class.getName());
Velocity.setProperty("class.resource.loader.class", MyClasspathResourceLoader.class.getName());
Velocity.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, modifiedPatternsPath.getAbsolutePath());
Velocity.setProperty(RuntimeConstants.INPUT_ENCODING, FileTemplate.ourEncoding);
Velocity.setProperty(RuntimeConstants.PARSER_POOL_SIZE, 3);
Velocity.init();
ourVelocityInitialized = true;
}
catch (Exception e){
LOG.error("Unable to init Velocity", e);
}
}
public static PsiElement createFromTemplate(@NotNull final FileTemplate template,
@NonNls @Nullable final String fileName,
@Nullable Properties props,
@NotNull final PsiDirectory directory) throws Exception {
return createFromTemplate(template, fileName, props, directory, null);
}
public static PsiElement createFromTemplate(@NotNull final FileTemplate template,
@NonNls @Nullable final String fileName,
@Nullable Properties props,
@NotNull final PsiDirectory directory,
@Nullable ClassLoader classLoader) throws Exception {
@NotNull final Project project = directory.getProject();
if (props == null) {
props = FileTemplateManager.getInstance().getDefaultProperties();
}
FileTemplateManager.getInstance().addRecentName(template.getName());
fillDefaultProperties(props, directory);
if (fileName != null && props.getProperty(FileTemplate.ATTRIBUTE_NAME) == null) {
props.setProperty(FileTemplate.ATTRIBUTE_NAME, fileName);
}
//Set escaped references to dummy values to remove leading "\" (if not already explicitely set)
String[] dummyRefs = calculateAttributes(template.getText(), props, true);
for (String dummyRef : dummyRefs) {
props.setProperty(dummyRef, "");
}
if (template.isJavaClassTemplate()){
String packageName = props.getProperty(FileTemplate.ATTRIBUTE_PACKAGE_NAME);
if(packageName == null || packageName.length() == 0){
props = new Properties(props);
props.setProperty(FileTemplate.ATTRIBUTE_PACKAGE_NAME, FileTemplate.ATTRIBUTE_PACKAGE_NAME);
}
}
final Properties props_ = props;
String mergedText = ClassLoaderUtil.runWithClassLoader(classLoader != null ? classLoader : FileTemplateUtil.class.getClassLoader(),
new ThrowableComputable<String, IOException>() {
@Override
public String compute() throws IOException {
return template.getText(props_);
}
});
final String templateText = StringUtil.convertLineSeparators(mergedText);
final Exception[] commandException = new Exception[1];
final PsiElement[] result = new PsiElement[1];
final Properties finalProps = props;
CommandProcessor.getInstance().executeCommand(project, new Runnable(){
public void run(){
final Runnable run = new Runnable(){
public void run(){
try{
CreateFromTemplateHandler handler = findHandler(template);
result [0] = handler.createFromTemplate(project, directory, fileName, template, templateText, finalProps);
}
catch (Exception ex){
commandException[0] = ex;
}
}
};
ApplicationManager.getApplication().runWriteAction(run);
}
}, template.isJavaClassTemplate()
? IdeBundle.message("command.create.class.from.template")
: IdeBundle.message("command.create.file.from.template"), null);
if(commandException[0] != null){
throw commandException[0];
}
return result[0];
}
private static CreateFromTemplateHandler findHandler(final FileTemplate template) {
for(CreateFromTemplateHandler handler: Extensions.getExtensions(CreateFromTemplateHandler.EP_NAME)) {
if (handler.handlesTemplate(template)) {
return handler;
}
}
return ourDefaultCreateFromTemplateHandler;
}
public static void fillDefaultProperties(final Properties props, final PsiDirectory directory) {
final DefaultTemplatePropertiesProvider[] providers = Extensions.getExtensions(DefaultTemplatePropertiesProvider.EP_NAME);
for(DefaultTemplatePropertiesProvider provider: providers) {
provider.fillProperties(directory, props);
}
}
public static String indent(String methodText, Project project, FileType fileType) {
int indent = CodeStyleSettingsManager.getSettings(project).getIndentSize(fileType);
return methodText.replaceAll("\n", "\n" + StringUtil.repeatSymbol(' ',indent));
}
@NonNls private static final String INCLUDES_PATH = "fileTemplates/includes/";
public static class MyClasspathResourceLoader extends ClasspathResourceLoader{
@NonNls private static final String FT_EXTENSION = ".ft";
public synchronized InputStream getResourceStream(String name) throws ResourceNotFoundException{
return super.getResourceStream(INCLUDES_PATH + name + FT_EXTENSION);
}
}
public static class MyFileResourceLoader extends FileResourceLoader{
public void init(ExtendedProperties configuration){
super.init(configuration);
File modifiedPatternsPath = new File(PathManager.getConfigPath());
modifiedPatternsPath = new File(modifiedPatternsPath, INCLUDES_PATH);
try {
Field pathsField = FileResourceLoader.class.getDeclaredField("paths");
pathsField.setAccessible(true);
Collection<String> paths = (Collection)pathsField.get(this);
paths.clear();
paths.add(modifiedPatternsPath.getAbsolutePath());
if(ApplicationManager.getApplication().isUnitTestMode()){
// todo this is for FileTemplatesTest
// todo it should register its own loader and not depend on in what kind of test velocity is first needed
for (PathManagerEx.TestDataLookupStrategy strategy : ar(PathManagerEx.TestDataLookupStrategy.COMMUNITY_FROM_ULTIMATE, PathManagerEx.TestDataLookupStrategy.COMMUNITY)) {
File testsDir = new File(new File(PathManagerEx.getTestDataPath(strategy), "ide"), "fileTemplates");
paths.add(testsDir.getAbsolutePath());
}
}
}
catch (Exception e) {
LOG.error(e);
throw new RuntimeException(e);
}
}
}
public static boolean canCreateFromTemplate (PsiDirectory[] dirs, FileTemplate template) {
FileType fileType = FileTypeManagerEx.getInstanceEx().getFileTypeByExtension(template.getExtension());
if (fileType.equals(FileTypes.UNKNOWN)) return false;
CreateFromTemplateHandler handler = findHandler(template);
return handler.canCreate(dirs);
}
}
| platform/lang-impl/src/com/intellij/ide/fileTemplates/FileTemplateUtil.java | /*
* Copyright 2000-2009 JetBrains s.r.o.
*
* 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.intellij.ide.fileTemplates;
import com.intellij.ide.IdeBundle;
import com.intellij.ide.fileTemplates.impl.FileTemplateImpl;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.application.PathManager;
import com.intellij.openapi.application.ex.PathManagerEx;
import com.intellij.openapi.command.CommandProcessor;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.fileTypes.FileType;
import com.intellij.openapi.fileTypes.FileTypes;
import com.intellij.openapi.fileTypes.ex.FileTypeManagerEx;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.Messages;
import com.intellij.openapi.util.ClassLoaderUtil;
import com.intellij.openapi.util.ThrowableComputable;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.psi.PsiDirectory;
import com.intellij.psi.PsiElement;
import com.intellij.psi.codeStyle.CodeStyleSettingsManager;
import com.intellij.util.ArrayUtil;
import org.apache.commons.collections.ExtendedProperties;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.exception.VelocityException;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.RuntimeServices;
import org.apache.velocity.runtime.RuntimeSingleton;
import org.apache.velocity.runtime.log.LogSystem;
import org.apache.velocity.runtime.parser.ParseException;
import org.apache.velocity.runtime.parser.node.ASTReference;
import org.apache.velocity.runtime.parser.node.Node;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
import org.apache.velocity.runtime.resource.loader.FileResourceLoader;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.*;
import java.lang.reflect.Field;
import java.util.*;
import static com.intellij.util.containers.CollectionFactory.ar;
/**
* @author MYakovlev
*/
public class FileTemplateUtil{
private static final Logger LOG = Logger.getInstance("#com.intellij.ide.fileTemplates.FileTemplateUtil");
private static boolean ourVelocityInitialized = false;
private static final CreateFromTemplateHandler ourDefaultCreateFromTemplateHandler = new DefaultCreateFromTemplateHandler();
private FileTemplateUtil() {
}
public static String[] calculateAttributes(String templateContent, Properties properties, boolean includeDummies) throws ParseException {
initVelocity();
final Set<String> unsetAttributes = new HashSet<String>();
//noinspection HardCodedStringLiteral
addAttributesToVector(unsetAttributes, RuntimeSingleton.parse(new StringReader(templateContent), "MyTemplate"), properties, includeDummies);
return ArrayUtil.toStringArray(unsetAttributes);
}
private static void addAttributesToVector(Set<String> references, Node apacheNode, Properties properties, boolean includeDummies){
int childCount = apacheNode.jjtGetNumChildren();
for(int i = 0; i < childCount; i++){
Node apacheChild = apacheNode.jjtGetChild(i);
addAttributesToVector(references, apacheChild, properties, includeDummies);
if(apacheChild instanceof ASTReference){
ASTReference apacheReference = (ASTReference)apacheChild;
String s = apacheReference.literal();
s = referenceToAttribute(s, includeDummies);
if (s != null && s.length() > 0 && properties.getProperty(s) == null) references.add(s);
}
}
}
/**
* Removes each two leading '\', removes leading $, removes {}
* Examples:
* $qqq -> qqq
* \$qqq -> qqq if dummy attributes are collected too, null otherwise
* \\$qqq -> qqq
* ${qqq} -> qqq
*/
@Nullable
private static String referenceToAttribute(String attrib, boolean includeDummies) {
while (attrib.startsWith("\\\\")) {
attrib = attrib.substring(2);
}
if (attrib.startsWith("\\$")) {
if (includeDummies) {
attrib = attrib.substring(1);
}
else return null;
}
if (!StringUtil.startsWithChar(attrib, '$')) {
return null;
}
attrib = attrib.substring(1);
if (StringUtil.startsWithChar(attrib, '{')) {
String cleanAttribute = null;
for (int i = 1; i < attrib.length(); i++) {
char currChar = attrib.charAt(i);
if (currChar == '{' || currChar == '.') {
// Invalid match
cleanAttribute = null;
break;
}
else if (currChar == '}') {
// Valid match
cleanAttribute = attrib.substring(1, i);
break;
}
}
attrib = cleanAttribute;
}
else {
for (int i = 0; i < attrib.length(); i++) {
char currChar = attrib.charAt(i);
if (currChar == '{' || currChar == '}' || currChar == '.') {
attrib = attrib.substring(0, i);
break;
}
}
}
return attrib;
}
public static String mergeTemplate(Map attributes, String content) throws IOException{
initVelocity();
VelocityContext context = new VelocityContext();
for (final Object o : attributes.keySet()) {
String name = (String)o;
context.put(name, attributes.get(name));
}
return mergeTemplate(content, context);
}
public static String mergeTemplate(Properties attributes, String content) throws IOException{
initVelocity();
VelocityContext context = new VelocityContext();
Enumeration<?> names = attributes.propertyNames();
while (names.hasMoreElements()){
String name = (String)names.nextElement();
context.put(name, attributes.getProperty(name));
}
return mergeTemplate(content, context);
}
private static String mergeTemplate(String templateContent, final VelocityContext context) throws IOException {
initVelocity();
StringWriter stringWriter = new StringWriter();
try {
Velocity.evaluate(context, stringWriter, "", templateContent);
}
catch (VelocityException e) {
LOG.error("Error evaluating template:\n"+templateContent,e);
ApplicationManager.getApplication().invokeLater(new Runnable() {
public void run() {
Messages.showErrorDialog(IdeBundle.message("error.parsing.file.template"),
IdeBundle.message("title.velocity.error"));
}
});
}
return stringWriter.toString();
}
public static FileTemplate cloneTemplate(FileTemplate template){
FileTemplateImpl templateImpl = (FileTemplateImpl) template;
return (FileTemplate)templateImpl.clone();
}
public static void copyTemplate(FileTemplate src, FileTemplate dest){
dest.setExtension(src.getExtension());
dest.setName(src.getName());
dest.setText(src.getText());
dest.setAdjust(src.isAdjust());
}
@SuppressWarnings({"HardCodedStringLiteral"})
private static synchronized void initVelocity(){
try{
if (ourVelocityInitialized) {
return;
}
File modifiedPatternsPath = new File(PathManager.getConfigPath());
modifiedPatternsPath = new File(modifiedPatternsPath, "fileTemplates");
modifiedPatternsPath = new File(modifiedPatternsPath, "includes");
LogSystem emptyLogSystem = new LogSystem() {
public void init(RuntimeServices runtimeServices) throws Exception {
}
public void logVelocityMessage(int i, String s) {
//todo[myakovlev] log somethere?
}
};
Velocity.setProperty(RuntimeConstants.RUNTIME_LOG_LOGSYSTEM, emptyLogSystem);
Velocity.setProperty(RuntimeConstants.RESOURCE_LOADER, "file,class");
//todo[myakovlev] implement my own Loader, with ability to load templates from classpath
Velocity.setProperty("file.resource.loader.class", MyFileResourceLoader.class.getName());
Velocity.setProperty("class.resource.loader.class", MyClasspathResourceLoader.class.getName());
Velocity.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, modifiedPatternsPath.getAbsolutePath());
Velocity.setProperty(RuntimeConstants.INPUT_ENCODING, FileTemplate.ourEncoding);
Velocity.init();
ourVelocityInitialized = true;
}
catch (Exception e){
LOG.error("Unable to init Velocity", e);
}
}
public static PsiElement createFromTemplate(@NotNull final FileTemplate template,
@NonNls @Nullable final String fileName,
@Nullable Properties props,
@NotNull final PsiDirectory directory) throws Exception {
return createFromTemplate(template, fileName, props, directory, null);
}
public static PsiElement createFromTemplate(@NotNull final FileTemplate template,
@NonNls @Nullable final String fileName,
@Nullable Properties props,
@NotNull final PsiDirectory directory,
@Nullable ClassLoader classLoader) throws Exception {
@NotNull final Project project = directory.getProject();
if (props == null) {
props = FileTemplateManager.getInstance().getDefaultProperties();
}
FileTemplateManager.getInstance().addRecentName(template.getName());
fillDefaultProperties(props, directory);
if (fileName != null && props.getProperty(FileTemplate.ATTRIBUTE_NAME) == null) {
props.setProperty(FileTemplate.ATTRIBUTE_NAME, fileName);
}
//Set escaped references to dummy values to remove leading "\" (if not already explicitely set)
String[] dummyRefs = calculateAttributes(template.getText(), props, true);
for (String dummyRef : dummyRefs) {
props.setProperty(dummyRef, "");
}
if (template.isJavaClassTemplate()){
String packageName = props.getProperty(FileTemplate.ATTRIBUTE_PACKAGE_NAME);
if(packageName == null || packageName.length() == 0){
props = new Properties(props);
props.setProperty(FileTemplate.ATTRIBUTE_PACKAGE_NAME, FileTemplate.ATTRIBUTE_PACKAGE_NAME);
}
}
final Properties props_ = props;
String mergedText = ClassLoaderUtil.runWithClassLoader(classLoader != null ? classLoader : FileTemplateUtil.class.getClassLoader(),
new ThrowableComputable<String, IOException>() {
@Override
public String compute() throws IOException {
return template.getText(props_);
}
});
final String templateText = StringUtil.convertLineSeparators(mergedText);
final Exception[] commandException = new Exception[1];
final PsiElement[] result = new PsiElement[1];
final Properties finalProps = props;
CommandProcessor.getInstance().executeCommand(project, new Runnable(){
public void run(){
final Runnable run = new Runnable(){
public void run(){
try{
CreateFromTemplateHandler handler = findHandler(template);
result [0] = handler.createFromTemplate(project, directory, fileName, template, templateText, finalProps);
}
catch (Exception ex){
commandException[0] = ex;
}
}
};
ApplicationManager.getApplication().runWriteAction(run);
}
}, template.isJavaClassTemplate()
? IdeBundle.message("command.create.class.from.template")
: IdeBundle.message("command.create.file.from.template"), null);
if(commandException[0] != null){
throw commandException[0];
}
return result[0];
}
private static CreateFromTemplateHandler findHandler(final FileTemplate template) {
for(CreateFromTemplateHandler handler: Extensions.getExtensions(CreateFromTemplateHandler.EP_NAME)) {
if (handler.handlesTemplate(template)) {
return handler;
}
}
return ourDefaultCreateFromTemplateHandler;
}
public static void fillDefaultProperties(final Properties props, final PsiDirectory directory) {
final DefaultTemplatePropertiesProvider[] providers = Extensions.getExtensions(DefaultTemplatePropertiesProvider.EP_NAME);
for(DefaultTemplatePropertiesProvider provider: providers) {
provider.fillProperties(directory, props);
}
}
public static String indent(String methodText, Project project, FileType fileType) {
int indent = CodeStyleSettingsManager.getSettings(project).getIndentSize(fileType);
return methodText.replaceAll("\n", "\n" + StringUtil.repeatSymbol(' ',indent));
}
@NonNls private static final String INCLUDES_PATH = "fileTemplates/includes/";
public static class MyClasspathResourceLoader extends ClasspathResourceLoader{
@NonNls private static final String FT_EXTENSION = ".ft";
public synchronized InputStream getResourceStream(String name) throws ResourceNotFoundException{
return super.getResourceStream(INCLUDES_PATH + name + FT_EXTENSION);
}
}
public static class MyFileResourceLoader extends FileResourceLoader{
public void init(ExtendedProperties configuration){
super.init(configuration);
File modifiedPatternsPath = new File(PathManager.getConfigPath());
modifiedPatternsPath = new File(modifiedPatternsPath, INCLUDES_PATH);
try {
Field pathsField = FileResourceLoader.class.getDeclaredField("paths");
pathsField.setAccessible(true);
Collection<String> paths = (Collection)pathsField.get(this);
paths.clear();
paths.add(modifiedPatternsPath.getAbsolutePath());
if(ApplicationManager.getApplication().isUnitTestMode()){
// todo this is for FileTemplatesTest
// todo it should register its own loader and not depend on in what kind of test velocity is first needed
for (PathManagerEx.TestDataLookupStrategy strategy : ar(PathManagerEx.TestDataLookupStrategy.COMMUNITY_FROM_ULTIMATE, PathManagerEx.TestDataLookupStrategy.COMMUNITY)) {
File testsDir = new File(new File(PathManagerEx.getTestDataPath(strategy), "ide"), "fileTemplates");
paths.add(testsDir.getAbsolutePath());
}
}
}
catch (Exception e) {
LOG.error(e);
throw new RuntimeException(e);
}
}
}
public static boolean canCreateFromTemplate (PsiDirectory[] dirs, FileTemplate template) {
FileType fileType = FileTypeManagerEx.getInstanceEx().getFileTypeByExtension(template.getExtension());
if (fileType.equals(FileTypes.UNKNOWN)) return false;
CreateFromTemplateHandler handler = findHandler(template);
return handler.canCreate(dirs);
}
}
| We don't need 20 velocity parsers taking 2+ megabytes.
| platform/lang-impl/src/com/intellij/ide/fileTemplates/FileTemplateUtil.java | We don't need 20 velocity parsers taking 2+ megabytes. | <ide><path>latform/lang-impl/src/com/intellij/ide/fileTemplates/FileTemplateUtil.java
<ide> Velocity.setProperty("class.resource.loader.class", MyClasspathResourceLoader.class.getName());
<ide> Velocity.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, modifiedPatternsPath.getAbsolutePath());
<ide> Velocity.setProperty(RuntimeConstants.INPUT_ENCODING, FileTemplate.ourEncoding);
<add> Velocity.setProperty(RuntimeConstants.PARSER_POOL_SIZE, 3);
<ide> Velocity.init();
<ide> ourVelocityInitialized = true;
<ide> } |
|
Java | mpl-2.0 | 4a07095e5eeb6ae6bee6096627d12f7849e5debb | 0 | Wurst-Imperium/Wurst-Client-for-MC-1.9.X,Wurst-Imperium/Wurst-MC-1.9,Wurst-Imperium/Wurst-Client-for-MC-1.9.X | /*
* Copyright 2014 - 2017 | Wurst-Imperium | All rights reserved.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package net.wurstclient.features.mods;
import net.minecraft.item.ItemFood;
import net.minecraft.network.play.client.CPacketPlayer;
import net.wurstclient.compatibility.WConnection;
import net.wurstclient.compatibility.WMinecraft;
import net.wurstclient.events.listeners.UpdateListener;
import net.wurstclient.utils.InventoryUtils;
@Mod.Info(
description = "Allows you to eat food much faster.\n" + "OM! NOM! NOM!",
name = "FastEat",
tags = "FastNom, fast eat, fast nom",
help = "Mods/FastEat")
@Mod.Bypasses(ghostMode = false, latestNCP = false, olderNCP = false)
public final class FastEatMod extends Mod implements UpdateListener
{
@Override
public void onEnable()
{
wurst.events.add(UpdateListener.class, this);
}
@Override
public void onDisable()
{
wurst.events.remove(UpdateListener.class, this);
}
@Override
public void onUpdate()
{
// check if alive
if(WMinecraft.getPlayer().getHealth() <= 0)
return;
// check onGround
if(!WMinecraft.getPlayer().onGround)
return;
// check if eating
if(!mc.gameSettings.keyBindUseItem.pressed)
return;
// check hunger level
if(!WMinecraft.getPlayer().getFoodStats().needFood())
return;
// check held item
if(!InventoryUtils.checkHeldItem((item) -> item instanceof ItemFood))
return;
// send packets
for(int i = 0; i < 100; i++)
WConnection.sendPacket(new CPacketPlayer(false));
}
}
| src/net/wurstclient/features/mods/FastEatMod.java | /*
* Copyright 2014 - 2017 | Wurst-Imperium | All rights reserved.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
package net.wurstclient.features.mods;
import net.minecraft.item.ItemFood;
import net.minecraft.network.play.client.CPacketPlayer;
import net.wurstclient.compatibility.WConnection;
import net.wurstclient.compatibility.WMinecraft;
import net.wurstclient.events.listeners.UpdateListener;
@Mod.Info(
description = "Allows you to eat food much faster.\n" + "OM! NOM! NOM!",
name = "FastEat",
tags = "FastNom, fast eat, fast nom",
help = "Mods/FastEat")
@Mod.Bypasses(ghostMode = false, latestNCP = false, olderNCP = false)
public final class FastEatMod extends Mod implements UpdateListener
{
@Override
public void onEnable()
{
wurst.events.add(UpdateListener.class, this);
}
@Override
public void onUpdate()
{
if(WMinecraft.getPlayer().getHealth() > 0
&& WMinecraft.getPlayer().onGround
&& WMinecraft.getPlayer().inventory.getCurrentItem() != null
&& WMinecraft.getPlayer().inventory.getCurrentItem()
.getItem() instanceof ItemFood
&& WMinecraft.getPlayer().getFoodStats().needFood()
&& mc.gameSettings.keyBindUseItem.pressed)
for(int i = 0; i < 100; i++)
WConnection.sendPacket(new CPacketPlayer(false));
}
@Override
public void onDisable()
{
wurst.events.remove(UpdateListener.class, this);
}
}
| Update FastEatMod | src/net/wurstclient/features/mods/FastEatMod.java | Update FastEatMod | <ide><path>rc/net/wurstclient/features/mods/FastEatMod.java
<ide> import net.wurstclient.compatibility.WConnection;
<ide> import net.wurstclient.compatibility.WMinecraft;
<ide> import net.wurstclient.events.listeners.UpdateListener;
<add>import net.wurstclient.utils.InventoryUtils;
<ide>
<ide> @Mod.Info(
<ide> description = "Allows you to eat food much faster.\n" + "OM! NOM! NOM!",
<ide> }
<ide>
<ide> @Override
<del> public void onUpdate()
<del> {
<del> if(WMinecraft.getPlayer().getHealth() > 0
<del> && WMinecraft.getPlayer().onGround
<del> && WMinecraft.getPlayer().inventory.getCurrentItem() != null
<del> && WMinecraft.getPlayer().inventory.getCurrentItem()
<del> .getItem() instanceof ItemFood
<del> && WMinecraft.getPlayer().getFoodStats().needFood()
<del> && mc.gameSettings.keyBindUseItem.pressed)
<del> for(int i = 0; i < 100; i++)
<del> WConnection.sendPacket(new CPacketPlayer(false));
<del> }
<del>
<del> @Override
<ide> public void onDisable()
<ide> {
<ide> wurst.events.remove(UpdateListener.class, this);
<ide> }
<add>
<add> @Override
<add> public void onUpdate()
<add> {
<add> // check if alive
<add> if(WMinecraft.getPlayer().getHealth() <= 0)
<add> return;
<add>
<add> // check onGround
<add> if(!WMinecraft.getPlayer().onGround)
<add> return;
<add>
<add> // check if eating
<add> if(!mc.gameSettings.keyBindUseItem.pressed)
<add> return;
<add>
<add> // check hunger level
<add> if(!WMinecraft.getPlayer().getFoodStats().needFood())
<add> return;
<add>
<add> // check held item
<add> if(!InventoryUtils.checkHeldItem((item) -> item instanceof ItemFood))
<add> return;
<add>
<add> // send packets
<add> for(int i = 0; i < 100; i++)
<add> WConnection.sendPacket(new CPacketPlayer(false));
<add> }
<ide> } |
|
Java | apache-2.0 | 027d3b54ccf4590cbf5c799849291d6908266cfc | 0 | unratito/ceylon.language,jvasileff/ceylon.language,unratito/ceylon.language,lucaswerkmeister/ceylon.language,ceylon/ceylon.language,lucaswerkmeister/ceylon.language,ceylon/ceylon.language,jvasileff/ceylon.language | package com.redhat.ceylon.compiler.java.runtime.metamodel;
import ceylon.language.Map;
import ceylon.language.Sequential;
import ceylon.language.empty_;
import ceylon.language.model.Function;
import ceylon.language.model.FunctionModel$impl;
import ceylon.language.model.Method$impl;
import ceylon.language.model.Model$impl;
import ceylon.language.model.declaration.FunctionDeclaration;
import com.redhat.ceylon.compiler.java.metadata.Ceylon;
import com.redhat.ceylon.compiler.java.metadata.Ignore;
import com.redhat.ceylon.compiler.java.metadata.TypeInfo;
import com.redhat.ceylon.compiler.java.metadata.TypeParameter;
import com.redhat.ceylon.compiler.java.metadata.TypeParameters;
import com.redhat.ceylon.compiler.java.metadata.Variance;
import com.redhat.ceylon.compiler.java.runtime.model.TypeDescriptor;
import com.redhat.ceylon.compiler.typechecker.model.ProducedTypedReference;
@Ceylon(major = 5)
@com.redhat.ceylon.compiler.java.metadata.Class
@TypeParameters({
@TypeParameter(value = "Container", variance = Variance.IN),
@TypeParameter(value = "Type", variance = Variance.OUT),
@TypeParameter(value = "Arguments", variance = Variance.IN, satisfies = "ceylon.language::Sequential<ceylon.language::Anything>"),
})
public class AppliedMethod<Container, Type, Arguments extends Sequential<? extends Object>>
extends AppliedMember<Container, ceylon.language.model.Function<? extends Type, ? super Arguments>>
implements ceylon.language.model.Method<Container, Type, Arguments> {
private FreeFunction declaration;
private ProducedTypedReference appliedFunction;
private ceylon.language.model.Type<Type> closedType;
@Ignore
private TypeDescriptor $reifiedType;
@Ignore
private TypeDescriptor $reifiedArguments;
private Map<? extends ceylon.language.model.declaration.TypeParameter, ? extends ceylon.language.model.Type<?>> typeArguments;
public AppliedMethod(@Ignore TypeDescriptor $reifiedContainer,
@Ignore TypeDescriptor $reifiedType,
@Ignore TypeDescriptor $reifiedArguments,
ProducedTypedReference appliedFunction,
FreeFunction declaration,
ceylon.language.model.ClassOrInterface<? extends Object> container) {
super($reifiedContainer, TypeDescriptor.klass(ceylon.language.model.Function.class, $reifiedType, $reifiedArguments), container);
this.$reifiedType = $reifiedType;
this.$reifiedArguments = $reifiedArguments;
this.appliedFunction = appliedFunction;
this.declaration = declaration;
this.typeArguments = Metamodel.getTypeArguments(declaration, appliedFunction);
this.closedType = Metamodel.getAppliedMetamodel(Metamodel.getFunctionReturnType(appliedFunction));
}
@Override
@Ignore
public Model$impl $ceylon$language$model$Model$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@Ignore
public Method$impl<Container, Type, Arguments> $ceylon$language$model$Method$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@Ignore
public FunctionModel$impl<Type, Arguments> $ceylon$language$model$FunctionModel$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@TypeInfo("ceylon.language::Map<ceylon.language.model.declaration::TypeParameter,ceylon.language.model::Type<ceylon.language::Anything>>")
public ceylon.language.Map<? extends ceylon.language.model.declaration.TypeParameter, ? extends ceylon.language.model.Type<?>> getTypeArguments() {
return typeArguments;
}
@Override
@TypeInfo("ceylon.language.model.declaration::FunctionDeclaration")
public FunctionDeclaration getDeclaration() {
return declaration;
}
@Override
@TypeInfo("ceylon.language.model::Type<Type>")
public ceylon.language.model.Type<? extends Type> getType() {
return closedType;
}
@Override
protected Function<Type, Arguments> bindTo(Object instance) {
return new AppliedFunction($reifiedType, $reifiedArguments, appliedFunction, declaration, getContainer(), instance);
}
@Ignore
@Override
public TypeDescriptor $getType() {
return TypeDescriptor.klass(AppliedMethod.class, super.$reifiedType, $reifiedType, $reifiedArguments);
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic() {
return $call$variadic(empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Object arg2, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object... argsAndVarargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0) {
return $call$variadic(arg0, empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1) {
return $call$variadic(arg0, arg1, empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Object arg2) {
return $call$variadic(arg0, arg1, arg2, empty_.$get());
}
@Override
public int hashCode() {
int result = 1;
result = 37 * result + getDeclaringClassOrInterface().hashCode();
result = 37 * result + getDeclaration().hashCode();
result = 37 * result + getTypeArguments().hashCode();
return result;
}
@Override
public boolean equals(Object obj) {
if(obj == null)
return false;
if(obj == this)
return true;
if(obj instanceof ceylon.language.model.Method == false)
return false;
ceylon.language.model.Method other = (ceylon.language.model.Method) obj;
return getDeclaration().equals(other.getDeclaration())
&& getDeclaringClassOrInterface().equals(other.getDeclaringClassOrInterface())
&& getTypeArguments().equals(other.getTypeArguments());
}
@Override
@TypeInfo("ceylon.language.model::ClassOrInterface<ceylon.language::Anything>")
public ceylon.language.model.ClassOrInterface<? extends java.lang.Object> getContainer(){
return getDeclaringClassOrInterface();
}
@Override
public String toString() {
return Metamodel.toTypeString(this);
}
}
| runtime/com/redhat/ceylon/compiler/java/runtime/metamodel/AppliedMethod.java | package com.redhat.ceylon.compiler.java.runtime.metamodel;
import ceylon.language.Map;
import ceylon.language.Sequential;
import ceylon.language.empty_;
import ceylon.language.model.Function;
import ceylon.language.model.FunctionModel$impl;
import ceylon.language.model.Method$impl;
import ceylon.language.model.Model$impl;
import ceylon.language.model.declaration.FunctionDeclaration;
import com.redhat.ceylon.compiler.java.metadata.Ceylon;
import com.redhat.ceylon.compiler.java.metadata.Ignore;
import com.redhat.ceylon.compiler.java.metadata.TypeInfo;
import com.redhat.ceylon.compiler.java.metadata.TypeParameter;
import com.redhat.ceylon.compiler.java.metadata.TypeParameters;
import com.redhat.ceylon.compiler.java.metadata.Variance;
import com.redhat.ceylon.compiler.java.runtime.model.TypeDescriptor;
import com.redhat.ceylon.compiler.typechecker.model.ProducedTypedReference;
@Ceylon(major = 5)
@com.redhat.ceylon.compiler.java.metadata.Class
@TypeParameters({
@TypeParameter(value = "Container", variance = Variance.IN),
@TypeParameter(value = "Type", variance = Variance.OUT),
@TypeParameter(value = "Arguments", variance = Variance.IN, satisfies = "ceylon.language::Sequential<ceylon.language::Anything>"),
})
public class AppliedMethod<Container, Type, Arguments extends Sequential<? extends Object>>
extends AppliedMember<Container, ceylon.language.model.Function<? extends Type, ? super Arguments>>
implements ceylon.language.model.Method<Container, Type, Arguments> {
private FreeFunction declaration;
private ProducedTypedReference appliedFunction;
private ceylon.language.model.Type<Type> closedType;
@Ignore
private TypeDescriptor $reifiedType;
@Ignore
private TypeDescriptor $reifiedArguments;
private Map<? extends ceylon.language.model.declaration.TypeParameter, ? extends ceylon.language.model.Type<?>> typeArguments;
public AppliedMethod(@Ignore TypeDescriptor $reifiedContainer,
@Ignore TypeDescriptor $reifiedType,
@Ignore TypeDescriptor $reifiedArguments,
ProducedTypedReference appliedFunction,
FreeFunction declaration,
ceylon.language.model.ClassOrInterface<? extends Object> container) {
super($reifiedContainer, TypeDescriptor.klass(ceylon.language.model.Function.class, $reifiedType, $reifiedArguments), container);
this.$reifiedType = $reifiedType;
this.$reifiedArguments = $reifiedArguments;
this.appliedFunction = appliedFunction;
this.declaration = declaration;
this.typeArguments = Metamodel.getTypeArguments(declaration, appliedFunction);
this.closedType = Metamodel.getAppliedMetamodel(Metamodel.getFunctionReturnType(appliedFunction));
}
@Override
@Ignore
public Model$impl $ceylon$language$model$Model$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@Ignore
public Method$impl<Container, Type, Arguments> $ceylon$language$model$Method$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@Ignore
public FunctionModel$impl<Type, Arguments> $ceylon$language$model$FunctionModel$impl() {
// TODO Auto-generated method stub
return null;
}
@Override
@TypeInfo("ceylon.language::Map<ceylon.language.model.declaration::TypeParameter,ceylon.language.model::Type<ceylon.language::Anything>")
public ceylon.language.Map<? extends ceylon.language.model.declaration.TypeParameter, ? extends ceylon.language.model.Type<?>> getTypeArguments() {
return typeArguments;
}
@Override
@TypeInfo("ceylon.language.model.declaration::FunctionDeclaration")
public FunctionDeclaration getDeclaration() {
return declaration;
}
@Override
@TypeInfo("ceylon.language.model::Type<Type>")
public ceylon.language.model.Type<? extends Type> getType() {
return closedType;
}
@Override
protected Function<Type, Arguments> bindTo(Object instance) {
return new AppliedFunction($reifiedType, $reifiedArguments, appliedFunction, declaration, getContainer(), instance);
}
@Ignore
@Override
public TypeDescriptor $getType() {
return TypeDescriptor.klass(AppliedMethod.class, super.$reifiedType, $reifiedType, $reifiedArguments);
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic() {
return $call$variadic(empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Object arg2, Sequential<?> varargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object... argsAndVarargs) {
throw new UnsupportedOperationException();
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0) {
return $call$variadic(arg0, empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1) {
return $call$variadic(arg0, arg1, empty_.$get());
}
@Override
@Ignore
public Function<? extends Type, ? super Arguments> $call$variadic(
Object arg0, Object arg1, Object arg2) {
return $call$variadic(arg0, arg1, arg2, empty_.$get());
}
@Override
public int hashCode() {
int result = 1;
result = 37 * result + getDeclaringClassOrInterface().hashCode();
result = 37 * result + getDeclaration().hashCode();
result = 37 * result + getTypeArguments().hashCode();
return result;
}
@Override
public boolean equals(Object obj) {
if(obj == null)
return false;
if(obj == this)
return true;
if(obj instanceof ceylon.language.model.Method == false)
return false;
ceylon.language.model.Method other = (ceylon.language.model.Method) obj;
return getDeclaration().equals(other.getDeclaration())
&& getDeclaringClassOrInterface().equals(other.getDeclaringClassOrInterface())
&& getTypeArguments().equals(other.getTypeArguments());
}
@Override
@TypeInfo("ceylon.language.model::ClassOrInterface<ceylon.language::Anything>")
public ceylon.language.model.ClassOrInterface<? extends java.lang.Object> getContainer(){
return getDeclaringClassOrInterface();
}
@Override
public String toString() {
return Metamodel.toTypeString(this);
}
}
| metamodel: fixed a bogus @TypeInfo
| runtime/com/redhat/ceylon/compiler/java/runtime/metamodel/AppliedMethod.java | metamodel: fixed a bogus @TypeInfo | <ide><path>untime/com/redhat/ceylon/compiler/java/runtime/metamodel/AppliedMethod.java
<ide> }
<ide>
<ide> @Override
<del> @TypeInfo("ceylon.language::Map<ceylon.language.model.declaration::TypeParameter,ceylon.language.model::Type<ceylon.language::Anything>")
<add> @TypeInfo("ceylon.language::Map<ceylon.language.model.declaration::TypeParameter,ceylon.language.model::Type<ceylon.language::Anything>>")
<ide> public ceylon.language.Map<? extends ceylon.language.model.declaration.TypeParameter, ? extends ceylon.language.model.Type<?>> getTypeArguments() {
<ide> return typeArguments;
<ide> } |
|
Java | mit | 6f11c2b21b8042bc767740245cadc4798152805a | 0 | InnovateUKGitHub/innovation-funding-service,InnovateUKGitHub/innovation-funding-service,InnovateUKGitHub/innovation-funding-service,InnovateUKGitHub/innovation-funding-service,InnovateUKGitHub/innovation-funding-service | package org.innovateuk.ifs.interview.transactional;
import org.innovateuk.ifs.application.repository.ApplicationRepository;
import org.innovateuk.ifs.category.mapper.InnovationAreaMapper;
import org.innovateuk.ifs.category.resource.InnovationAreaResource;
import org.innovateuk.ifs.commons.error.Error;
import org.innovateuk.ifs.commons.service.ServiceResult;
import org.innovateuk.ifs.competition.domain.Competition;
import org.innovateuk.ifs.competition.repository.CompetitionRepository;
import org.innovateuk.ifs.interview.domain.Interview;
import org.innovateuk.ifs.interview.mapper.InterviewInviteMapper;
import org.innovateuk.ifs.interview.repository.InterviewRepository;
import org.innovateuk.ifs.interview.resource.InterviewState;
import org.innovateuk.ifs.invite.domain.ParticipantStatus;
import org.innovateuk.ifs.invite.domain.competition.*;
import org.innovateuk.ifs.invite.mapper.InterviewParticipantMapper;
import org.innovateuk.ifs.invite.mapper.ParticipantStatusMapper;
import org.innovateuk.ifs.invite.repository.CompetitionParticipantRepository;
import org.innovateuk.ifs.invite.repository.InterviewInviteRepository;
import org.innovateuk.ifs.invite.repository.InterviewParticipantRepository;
import org.innovateuk.ifs.invite.resource.*;
import org.innovateuk.ifs.notifications.resource.ExternalUserNotificationTarget;
import org.innovateuk.ifs.notifications.resource.Notification;
import org.innovateuk.ifs.notifications.resource.NotificationTarget;
import org.innovateuk.ifs.notifications.resource.SystemNotificationSource;
import org.innovateuk.ifs.notifications.service.NotificationTemplateRenderer;
import org.innovateuk.ifs.notifications.service.senders.NotificationSender;
import org.innovateuk.ifs.profile.domain.Profile;
import org.innovateuk.ifs.profile.repository.ProfileRepository;
import org.innovateuk.ifs.security.LoggedInUserSupplier;
import org.innovateuk.ifs.user.domain.User;
import org.innovateuk.ifs.user.repository.UserRepository;
import org.innovateuk.ifs.workflow.repository.ActivityStateRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.security.access.method.P;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Map;
import static java.lang.Boolean.TRUE;
import static java.lang.String.format;
import static java.time.ZonedDateTime.now;
import static java.time.format.DateTimeFormatter.ofPattern;
import static java.util.Arrays.asList;
import static java.util.stream.Collectors.toList;
import static org.innovateuk.ifs.commons.error.CommonErrors.notFoundError;
import static org.innovateuk.ifs.commons.error.CommonFailureKeys.*;
import static org.innovateuk.ifs.commons.error.CommonFailureKeys.INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_UNOPENED_INVITE;
import static org.innovateuk.ifs.commons.service.ServiceResult.serviceSuccess;
import static org.innovateuk.ifs.invite.constant.InviteStatus.CREATED;
import static org.innovateuk.ifs.invite.constant.InviteStatus.OPENED;
import static org.innovateuk.ifs.invite.domain.Invite.generateInviteHash;
import static org.innovateuk.ifs.invite.domain.ParticipantStatus.*;
import static org.innovateuk.ifs.invite.domain.competition.CompetitionParticipantRole.INTERVIEW_ASSESSOR;
import static org.innovateuk.ifs.util.CollectionFunctions.mapWithIndex;
import static org.innovateuk.ifs.util.CollectionFunctions.simpleMap;
import static org.innovateuk.ifs.util.EntityLookupCallbacks.find;
import static org.innovateuk.ifs.util.MapFunctions.asMap;
import static org.innovateuk.ifs.util.StringFunctions.plainTextToHtml;
import static org.innovateuk.ifs.util.StringFunctions.stripHtml;
/*
* Service for managing {@link InterviewInvite}s.
*/
@Service
@Transactional
public class InterviewInviteServiceImpl implements InterviewInviteService {
private static final String WEB_CONTEXT = "/interview";
private static final DateTimeFormatter detailsFormatter = ofPattern("d MMM yyyy");
@Autowired
private InterviewInviteRepository interviewInviteRepository;
@Autowired
private CompetitionParticipantRepository competitionParticipantRepository;
@Autowired
private InterviewParticipantRepository interviewParticipantRepository;
@Autowired
private CompetitionRepository competitionRepository;
@Autowired
private InnovationAreaMapper innovationAreaMapper;
@Autowired
private InterviewInviteMapper interviewInviteMapper;
@Autowired
private ParticipantStatusMapper participantStatusMapper;
@Autowired
private InterviewParticipantMapper interviewParticipantMapper;
@Autowired
private UserRepository userRepository;
@Autowired
private ProfileRepository profileRepository;
@Autowired
private NotificationSender notificationSender;
@Autowired
private NotificationTemplateRenderer renderer;
@Autowired
private SystemNotificationSource systemNotificationSource;
@Autowired
private LoggedInUserSupplier loggedInUserSupplier;
@Autowired
private InterviewRepository interviewRepository;
enum Notifications {
INVITE_ASSESSOR_GROUP_TO_INTERVIEW
}
@Value("${ifs.web.baseURL}")
private String webBaseUrl;
@Override
public ServiceResult<AssessorInvitesToSendResource> getAllInvitesToSend(long competitionId) {
return getCompetition(competitionId).andOnSuccess(competition -> {
List<InterviewInvite> invites = interviewInviteRepository.getByCompetitionIdAndStatus(competition.getId(), CREATED);
List<String> recipients = simpleMap(invites, InterviewInvite::getName);
recipients.sort(String::compareTo);
return serviceSuccess(new AssessorInvitesToSendResource(
recipients,
competition.getId(),
competition.getName(),
getInvitePreviewContent(competition)
));
});
}
@Override
public ServiceResult<AssessorInvitesToSendResource> getAllInvitesToResend(long competitionId, List<Long> inviteIds) {
return getCompetition(competitionId).andOnSuccess(competition -> {
List<InterviewInvite> invites = interviewInviteRepository.getByIdIn(inviteIds);
List<String> recipients = simpleMap(invites, InterviewInvite::getName);
recipients.sort(String::compareTo);
return serviceSuccess(new AssessorInvitesToSendResource(
recipients,
competition.getId(),
competition.getName(),
getInvitePreviewContent(competition)
));
});
}
@Override
public ServiceResult<Void> sendAllInvites(long competitionId, AssessorInviteSendResource assessorInviteSendResource) {
return getCompetition(competitionId).andOnSuccess(competition -> {
String customTextPlain = stripHtml(assessorInviteSendResource.getContent());
String customTextHtml = plainTextToHtml(customTextPlain);
return ServiceResult.processAnyFailuresOrSucceed(simpleMap(
interviewInviteRepository.getByCompetitionIdAndStatus(competition.getId(), CREATED),
invite -> {
interviewParticipantRepository.save(
new InterviewParticipant(invite.send(loggedInUserSupplier.get(), now()))
);
return sendInviteNotification(
assessorInviteSendResource.getSubject(),
customTextPlain,
customTextHtml,
invite,
Notifications.INVITE_ASSESSOR_GROUP_TO_INTERVIEW
);
}
));
});
}
@Override
public ServiceResult<Void> resendInvites(List<Long> inviteIds, AssessorInviteSendResource assessorInviteSendResource) {
String customTextPlain = stripHtml(assessorInviteSendResource.getContent());
String customTextHtml = plainTextToHtml(customTextPlain);
return ServiceResult.processAnyFailuresOrSucceed(simpleMap(
interviewInviteRepository.getByIdIn(inviteIds),
invite -> sendInviteNotification(
assessorInviteSendResource.getSubject(),
customTextPlain,
customTextHtml,
invite.sendOrResend(loggedInUserSupplier.get(), now()),
Notifications.INVITE_ASSESSOR_GROUP_TO_INTERVIEW
)
));
}
@Override
public ServiceResult<AvailableAssessorPageResource> getAvailableAssessors(long competitionId, Pageable pageable) {
final Page<AssessmentParticipant> pagedResult = competitionParticipantRepository.findParticipantsNotOnInterviewPanel(competitionId, pageable);
return serviceSuccess(new AvailableAssessorPageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
simpleMap(pagedResult.getContent(), this::mapToAvailableAssessorResource),
pagedResult.getNumber(),
pagedResult.getSize()
));
}
@Override
public ServiceResult<List<Long>> getAvailableAssessorIds(long competitionId) {
List<AssessmentParticipant> result = competitionParticipantRepository.findParticipantsNotOnInterviewPanel(competitionId);
return serviceSuccess(simpleMap(result, competitionParticipant -> competitionParticipant.getUser().getId()));
}
private AvailableAssessorResource mapToAvailableAssessorResource(CompetitionParticipant participant) {
User assessor = participant.getUser();
Profile profile = profileRepository.findOne(assessor.getProfileId());
AvailableAssessorResource availableAssessor = new AvailableAssessorResource();
availableAssessor.setId(assessor.getId());
availableAssessor.setEmail(assessor.getEmail());
availableAssessor.setName(assessor.getName());
availableAssessor.setBusinessType(profile.getBusinessType());
availableAssessor.setCompliant(profile.isCompliant(assessor));
availableAssessor.setInnovationAreas(simpleMap(profile.getInnovationAreas(), innovationAreaMapper::mapToResource));
return availableAssessor;
}
@Override
public ServiceResult<AssessorCreatedInvitePageResource> getCreatedInvites(long competitionId, Pageable pageable) {
Page<InterviewInvite> pagedResult = interviewInviteRepository.getByCompetitionIdAndStatus(competitionId, CREATED, pageable);
List<AssessorCreatedInviteResource> createdInvites = simpleMap(
pagedResult.getContent(),
competitionInvite -> {
AssessorCreatedInviteResource assessorCreatedInvite = new AssessorCreatedInviteResource();
assessorCreatedInvite.setName(competitionInvite.getName());
assessorCreatedInvite.setInnovationAreas(getInnovationAreasForInvite(competitionInvite));
assessorCreatedInvite.setCompliant(isUserCompliant(competitionInvite));
assessorCreatedInvite.setEmail(competitionInvite.getEmail());
assessorCreatedInvite.setInviteId(competitionInvite.getId());
if (competitionInvite.getUser() != null) {
assessorCreatedInvite.setId(competitionInvite.getUser().getId());
}
return assessorCreatedInvite;
}
);
return serviceSuccess(new AssessorCreatedInvitePageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
createdInvites,
pagedResult.getNumber(),
pagedResult.getSize()
));
}
@Override
public ServiceResult<Void> inviteUsers(List<ExistingUserStagedInviteResource> stagedInvites) {
return serviceSuccess(mapWithIndex(stagedInvites, (i, invite) ->
getUserById(invite.getUserId()).andOnSuccess(user ->
getByEmailAndCompetition(user.getEmail(), invite.getCompetitionId()).andOnFailure(() ->
inviteUserToCompetition(user, invite.getCompetitionId())
)))).andOnSuccessReturnVoid();
}
@Override
public ServiceResult<AssessorInviteOverviewPageResource> getInvitationOverview(long competitionId,
Pageable pageable,
List<ParticipantStatus> statuses) {
Page<InterviewParticipant> pagedResult = interviewParticipantRepository.getInterviewPanelAssessorsByCompetitionAndStatusContains(
competitionId,
statuses,
pageable);
List<AssessorInviteOverviewResource> inviteOverviews = simpleMap(
pagedResult.getContent(),
participant -> {
AssessorInviteOverviewResource assessorInviteOverview = new AssessorInviteOverviewResource();
assessorInviteOverview.setName(participant.getInvite().getName());
assessorInviteOverview.setStatus(participantStatusMapper.mapToResource(participant.getStatus()));
assessorInviteOverview.setDetails(getDetails(participant));
assessorInviteOverview.setInviteId(participant.getInvite().getId());
if (participant.getUser() != null) {
Profile profile = profileRepository.findOne(participant.getUser().getProfileId());
assessorInviteOverview.setId(participant.getUser().getId());
assessorInviteOverview.setBusinessType(profile.getBusinessType());
assessorInviteOverview.setCompliant(profile.isCompliant(participant.getUser()));
assessorInviteOverview.setInnovationAreas(simpleMap(profile.getInnovationAreas(), innovationAreaMapper::mapToResource));
}
return assessorInviteOverview;
});
return serviceSuccess(new AssessorInviteOverviewPageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
inviteOverviews,
pagedResult.getNumber(),
pagedResult.getSize()
));
}
private String getDetails(InterviewParticipant participant) {
String details = null;
if (participant.getStatus() == REJECTED) {
details = "Invite declined";
} else if (participant.getStatus() == PENDING) {
if (participant.getInvite().getSentOn() != null) {
details = format("Invite sent: %s", participant.getInvite().getSentOn().format(detailsFormatter));
}
}
return details;
}
@Override
public ServiceResult<List<Long>> getNonAcceptedAssessorInviteIds(long competitionId) {
List<InterviewParticipant> participants = interviewParticipantRepository.getInterviewPanelAssessorsByCompetitionAndStatusContains(
competitionId,
asList(PENDING, REJECTED));
return serviceSuccess(simpleMap(participants, participant -> participant.getInvite().getId()));
}
private ServiceResult<InterviewInvite> inviteUserToCompetition(User user, long competitionId) {
return getCompetition(competitionId)
.andOnSuccessReturn(
competition -> interviewInviteRepository.save(new InterviewInvite(user, generateInviteHash(), competition))
);
}
@Override
public ServiceResult<List<InterviewParticipantResource>> getAllInvitesByUser(long userId) {
List<InterviewParticipantResource> interviewParticipantResources =
interviewParticipantRepository
.findByUserIdAndRole(userId, INTERVIEW_ASSESSOR)
.stream()
.filter(participant -> now().isBefore(participant.getInvite().getTarget().getPanelDate()))
.map(interviewParticipantMapper::mapToResource)
.collect(toList());
interviewParticipantResources.forEach(this::determineStatusOfPanelApplications);
return serviceSuccess(interviewParticipantResources);
}
private ServiceResult<Competition> getCompetition(long competitionId) {
return find(competitionRepository.findOne(competitionId), notFoundError(Competition.class, competitionId));
}
private String getInvitePreviewContent(NotificationTarget notificationTarget, Map<String, Object> arguments) {
return renderer.renderTemplate(systemNotificationSource, notificationTarget, "invite_assessors_to_interview_panel_text.txt",
arguments).getSuccess();
}
private String getInvitePreviewContent(Competition competition) {
NotificationTarget notificationTarget = new ExternalUserNotificationTarget("", "");
return getInvitePreviewContent(notificationTarget, asMap(
"competitionName", competition.getName()
));
}
private ServiceResult<Void> sendInviteNotification(String subject,
String customTextPlain,
String customTextHtml,
InterviewInvite invite,
Notifications notificationType) {
NotificationTarget recipient = new ExternalUserNotificationTarget(invite.getName(), invite.getEmail());
Notification notification = new Notification(
systemNotificationSource,
recipient,
notificationType,
asMap(
"subject", subject,
"name", invite.getName(),
"competitionName", invite.getTarget().getName(),
"inviteUrl", format("%s/invite/interview/%s", webBaseUrl + WEB_CONTEXT, invite.getHash()),
"customTextPlain", customTextPlain,
"customTextHtml", customTextHtml
));
return notificationSender.sendNotification(notification).andOnSuccessReturnVoid();
}
private ServiceResult<User> getUserById(long id) {
return find(userRepository.findOne(id), notFoundError(User.class, id));
}
private ServiceResult<InterviewInvite> getByEmailAndCompetition(String email, long competitionId) {
return find(interviewInviteRepository.getByEmailAndCompetitionId(email, competitionId), notFoundError(InterviewInvite.class, email, competitionId));
}
private boolean isUserCompliant(InterviewInvite competitionInvite) {
if (competitionInvite == null || competitionInvite.getUser() == null) {
return false;
}
Profile profile = profileRepository.findOne(competitionInvite.getUser().getProfileId());
return profile.isCompliant(competitionInvite.getUser());
}
private List<InnovationAreaResource> getInnovationAreasForInvite(InterviewInvite competitionInvite) {
return profileRepository.findOne(competitionInvite.getUser().getProfileId()).getInnovationAreas().stream()
.map(innovationAreaMapper::mapToResource)
.collect(toList());
}
@Override
public ServiceResult<InterviewInviteResource> openInvite(String inviteHash) {
return getByHashIfOpen(inviteHash)
.andOnSuccessReturn(this::openInvite)
.andOnSuccessReturn(interviewInviteMapper::mapToResource);
}
private InterviewInvite openInvite(InterviewInvite invite) {
return interviewInviteRepository.save(invite.open());
}
@Override
public ServiceResult<Void> acceptInvite(String inviteHash) {
return getParticipantByInviteHash(inviteHash)
.andOnSuccess(InterviewInviteServiceImpl::accept)
.andOnSuccessReturnVoid();
}
@Override
public ServiceResult<Void> rejectInvite(String inviteHash) {
return getParticipantByInviteHash(inviteHash)
.andOnSuccess(this::reject)
.andOnSuccessReturnVoid();
}
private ServiceResult<InterviewParticipant> getParticipantByInviteHash(String inviteHash) {
return find(interviewParticipantRepository.getByInviteHash(inviteHash), notFoundError(InterviewParticipant.class, inviteHash));
}
@Override
public ServiceResult<Boolean> checkExistingUser(@P("inviteHash") String inviteHash) {
return getByHash(inviteHash).andOnSuccessReturn(invite -> {
if (invite.getUser() != null) {
return TRUE;
}
return userRepository.findByEmail(invite.getEmail()).isPresent();
});
}
private ServiceResult<InterviewInvite> getByHash(String inviteHash) {
return find(interviewInviteRepository.getByHash(inviteHash), notFoundError(InterviewInvite.class, inviteHash));
}
private static ServiceResult<InterviewParticipant> accept(InterviewParticipant participant) {
User user = participant.getUser();
if (participant.getInvite().getStatus() != OPENED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_UNOPENED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == ACCEPTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_ALREADY_ACCEPTED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_ALREADY_REJECTED_INVITE, getInviteCompetitionName(participant)));
} else {
return serviceSuccess( participant.acceptAndAssignUser(user));
}
}
private ServiceResult<CompetitionParticipant> reject(InterviewParticipant participant) {
if (participant.getInvite().getStatus() != OPENED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_UNOPENED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == ACCEPTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_ALREADY_ACCEPTED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_ALREADY_REJECTED_INVITE, getInviteCompetitionName(participant)));
} else {
return serviceSuccess(participant.reject());
}
}
private static String getInviteCompetitionName(InterviewParticipant participant) {
return participant.getInvite().getTarget().getName();
}
private ServiceResult<InterviewInvite> getByHashIfOpen(String inviteHash) {
return getByHash(inviteHash).andOnSuccess(invite -> {
if (invite.getTarget().getPanelDate() == null || now().isAfter(invite.getTarget().getPanelDate())) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_EXPIRED, invite.getTarget().getName()));
}
InterviewParticipant participant = interviewParticipantRepository.getByInviteHash(inviteHash);
if (participant == null) {
return serviceSuccess(invite);
}
if (participant.getStatus() == ACCEPTED || participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_CLOSED, invite.getTarget().getName()));
}
return serviceSuccess(invite);
});
}
@Override
public ServiceResult<Void> deleteInvite(String email, long competitionId) {
return getByEmailAndCompetition(email, competitionId).andOnSuccess(this::deleteInvite);
}
@Override
public ServiceResult<Void> deleteAllInvites(long competitionId) {
return find(competitionRepository.findOne(competitionId), notFoundError(Competition.class, competitionId))
.andOnSuccessReturnVoid(competition ->
interviewInviteRepository.deleteByCompetitionIdAndStatus(competition.getId(), CREATED));
}
private ServiceResult<Void> deleteInvite(InterviewInvite invite) {
if (invite.getStatus() != CREATED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_CANNOT_DELETE_ONCE_SENT, invite.getEmail()));
}
interviewInviteRepository.delete(invite);
return serviceSuccess();
}
private void determineStatusOfPanelApplications(InterviewParticipantResource interviewParticipantResource) {
List<Interview> reviews = interviewRepository.
findByParticipantUserIdAndTargetCompetitionIdOrderByActivityStateStateAscIdAsc(
interviewParticipantResource.getUserId(),
interviewParticipantResource.getCompetitionId());
interviewParticipantResource.setAwaitingApplications(getApplicationsPendingForPanelCount(reviews));
}
private Long getApplicationsPendingForPanelCount(List<Interview> reviews) {
return reviews.stream().filter(review -> review.getActivityState().equals(InterviewState.PENDING)).count();
}
} | ifs-data-layer/ifs-data-service/src/main/java/org/innovateuk/ifs/interview/transactional/InterviewInviteServiceImpl.java | package org.innovateuk.ifs.interview.transactional;
import org.innovateuk.ifs.application.repository.ApplicationRepository;
import org.innovateuk.ifs.category.mapper.InnovationAreaMapper;
import org.innovateuk.ifs.category.resource.InnovationAreaResource;
import org.innovateuk.ifs.commons.error.Error;
import org.innovateuk.ifs.commons.service.ServiceResult;
import org.innovateuk.ifs.competition.domain.Competition;
import org.innovateuk.ifs.competition.repository.CompetitionRepository;
import org.innovateuk.ifs.interview.domain.Interview;
import org.innovateuk.ifs.interview.mapper.InterviewInviteMapper;
import org.innovateuk.ifs.interview.repository.InterviewRepository;
import org.innovateuk.ifs.interview.resource.InterviewState;
import org.innovateuk.ifs.invite.domain.ParticipantStatus;
import org.innovateuk.ifs.invite.domain.competition.*;
import org.innovateuk.ifs.invite.mapper.InterviewParticipantMapper;
import org.innovateuk.ifs.invite.mapper.ParticipantStatusMapper;
import org.innovateuk.ifs.invite.repository.CompetitionParticipantRepository;
import org.innovateuk.ifs.invite.repository.InterviewInviteRepository;
import org.innovateuk.ifs.invite.repository.InterviewParticipantRepository;
import org.innovateuk.ifs.invite.resource.*;
import org.innovateuk.ifs.notifications.resource.ExternalUserNotificationTarget;
import org.innovateuk.ifs.notifications.resource.Notification;
import org.innovateuk.ifs.notifications.resource.NotificationTarget;
import org.innovateuk.ifs.notifications.resource.SystemNotificationSource;
import org.innovateuk.ifs.notifications.service.NotificationTemplateRenderer;
import org.innovateuk.ifs.notifications.service.senders.NotificationSender;
import org.innovateuk.ifs.profile.domain.Profile;
import org.innovateuk.ifs.profile.repository.ProfileRepository;
import org.innovateuk.ifs.security.LoggedInUserSupplier;
import org.innovateuk.ifs.user.domain.User;
import org.innovateuk.ifs.user.repository.UserRepository;
import org.innovateuk.ifs.workflow.repository.ActivityStateRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.security.access.method.P;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.time.format.DateTimeFormatter;
import java.util.List;
import java.util.Map;
import static java.lang.Boolean.TRUE;
import static java.lang.String.format;
import static java.time.ZonedDateTime.now;
import static java.time.format.DateTimeFormatter.ofPattern;
import static java.util.Arrays.asList;
import static java.util.stream.Collectors.toList;
import static org.innovateuk.ifs.commons.error.CommonErrors.notFoundError;
import static org.innovateuk.ifs.commons.error.CommonFailureKeys.*;
import static org.innovateuk.ifs.commons.error.CommonFailureKeys.INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_UNOPENED_INVITE;
import static org.innovateuk.ifs.commons.service.ServiceResult.serviceSuccess;
import static org.innovateuk.ifs.invite.constant.InviteStatus.CREATED;
import static org.innovateuk.ifs.invite.constant.InviteStatus.OPENED;
import static org.innovateuk.ifs.invite.domain.Invite.generateInviteHash;
import static org.innovateuk.ifs.invite.domain.ParticipantStatus.*;
import static org.innovateuk.ifs.invite.domain.competition.CompetitionParticipantRole.INTERVIEW_ASSESSOR;
import static org.innovateuk.ifs.util.CollectionFunctions.mapWithIndex;
import static org.innovateuk.ifs.util.CollectionFunctions.simpleMap;
import static org.innovateuk.ifs.util.EntityLookupCallbacks.find;
import static org.innovateuk.ifs.util.MapFunctions.asMap;
import static org.innovateuk.ifs.util.StringFunctions.plainTextToHtml;
import static org.innovateuk.ifs.util.StringFunctions.stripHtml;
/*
* Service for managing {@link InterviewInvite}s.
*/
@Service
@Transactional
public class InterviewInviteServiceImpl implements InterviewInviteService {
private static final String WEB_CONTEXT = "/interview";
private static final DateTimeFormatter detailsFormatter = ofPattern("d MMM yyyy");
@Autowired
private InterviewInviteRepository interviewInviteRepository;
@Autowired
private CompetitionParticipantRepository competitionParticipantRepository;
@Autowired
private InterviewParticipantRepository interviewParticipantRepository;
@Autowired
private ApplicationRepository applicationRepository;
@Autowired
private ActivityStateRepository activityStateRepository;
@Autowired
private CompetitionRepository competitionRepository;
@Autowired
private InnovationAreaMapper innovationAreaMapper;
@Autowired
private InterviewInviteMapper interviewInviteMapper;
@Autowired
private ParticipantStatusMapper participantStatusMapper;
@Autowired
private InterviewParticipantMapper interviewParticipantMapper;
@Autowired
private UserRepository userRepository;
@Autowired
private ProfileRepository profileRepository;
@Autowired
private NotificationSender notificationSender;
@Autowired
private NotificationTemplateRenderer renderer;
@Autowired
private SystemNotificationSource systemNotificationSource;
@Autowired
private LoggedInUserSupplier loggedInUserSupplier;
@Autowired
private InterviewRepository interviewRepository;
enum Notifications {
INVITE_ASSESSOR_GROUP_TO_INTERVIEW
}
@Value("${ifs.web.baseURL}")
private String webBaseUrl;
@Override
public ServiceResult<AssessorInvitesToSendResource> getAllInvitesToSend(long competitionId) {
return getCompetition(competitionId).andOnSuccess(competition -> {
List<InterviewInvite> invites = interviewInviteRepository.getByCompetitionIdAndStatus(competition.getId(), CREATED);
List<String> recipients = simpleMap(invites, InterviewInvite::getName);
recipients.sort(String::compareTo);
return serviceSuccess(new AssessorInvitesToSendResource(
recipients,
competition.getId(),
competition.getName(),
getInvitePreviewContent(competition)
));
});
}
@Override
public ServiceResult<AssessorInvitesToSendResource> getAllInvitesToResend(long competitionId, List<Long> inviteIds) {
return getCompetition(competitionId).andOnSuccess(competition -> {
List<InterviewInvite> invites = interviewInviteRepository.getByIdIn(inviteIds);
List<String> recipients = simpleMap(invites, InterviewInvite::getName);
recipients.sort(String::compareTo);
return serviceSuccess(new AssessorInvitesToSendResource(
recipients,
competition.getId(),
competition.getName(),
getInvitePreviewContent(competition)
));
});
}
@Override
public ServiceResult<Void> sendAllInvites(long competitionId, AssessorInviteSendResource assessorInviteSendResource) {
return getCompetition(competitionId).andOnSuccess(competition -> {
String customTextPlain = stripHtml(assessorInviteSendResource.getContent());
String customTextHtml = plainTextToHtml(customTextPlain);
return ServiceResult.processAnyFailuresOrSucceed(simpleMap(
interviewInviteRepository.getByCompetitionIdAndStatus(competition.getId(), CREATED),
invite -> {
interviewParticipantRepository.save(
new InterviewParticipant(invite.send(loggedInUserSupplier.get(), now()))
);
return sendInviteNotification(
assessorInviteSendResource.getSubject(),
customTextPlain,
customTextHtml,
invite,
Notifications.INVITE_ASSESSOR_GROUP_TO_INTERVIEW
);
}
));
});
}
@Override
public ServiceResult<Void> resendInvites(List<Long> inviteIds, AssessorInviteSendResource assessorInviteSendResource) {
String customTextPlain = stripHtml(assessorInviteSendResource.getContent());
String customTextHtml = plainTextToHtml(customTextPlain);
return ServiceResult.processAnyFailuresOrSucceed(simpleMap(
interviewInviteRepository.getByIdIn(inviteIds),
invite -> sendInviteNotification(
assessorInviteSendResource.getSubject(),
customTextPlain,
customTextHtml,
invite.sendOrResend(loggedInUserSupplier.get(), now()),
Notifications.INVITE_ASSESSOR_GROUP_TO_INTERVIEW
)
));
}
@Override
public ServiceResult<AvailableAssessorPageResource> getAvailableAssessors(long competitionId, Pageable pageable) {
final Page<AssessmentParticipant> pagedResult = competitionParticipantRepository.findParticipantsNotOnInterviewPanel(competitionId, pageable);
return serviceSuccess(new AvailableAssessorPageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
simpleMap(pagedResult.getContent(), this::mapToAvailableAssessorResource),
pagedResult.getNumber(),
pagedResult.getSize()
));
}
@Override
public ServiceResult<List<Long>> getAvailableAssessorIds(long competitionId) {
List<AssessmentParticipant> result = competitionParticipantRepository.findParticipantsNotOnInterviewPanel(competitionId);
return serviceSuccess(simpleMap(result, competitionParticipant -> competitionParticipant.getUser().getId()));
}
private AvailableAssessorResource mapToAvailableAssessorResource(CompetitionParticipant participant) {
User assessor = participant.getUser();
Profile profile = profileRepository.findOne(assessor.getProfileId());
AvailableAssessorResource availableAssessor = new AvailableAssessorResource();
availableAssessor.setId(assessor.getId());
availableAssessor.setEmail(assessor.getEmail());
availableAssessor.setName(assessor.getName());
availableAssessor.setBusinessType(profile.getBusinessType());
availableAssessor.setCompliant(profile.isCompliant(assessor));
availableAssessor.setInnovationAreas(simpleMap(profile.getInnovationAreas(), innovationAreaMapper::mapToResource));
return availableAssessor;
}
@Override
public ServiceResult<AssessorCreatedInvitePageResource> getCreatedInvites(long competitionId, Pageable pageable) {
Page<InterviewInvite> pagedResult = interviewInviteRepository.getByCompetitionIdAndStatus(competitionId, CREATED, pageable);
List<AssessorCreatedInviteResource> createdInvites = simpleMap(
pagedResult.getContent(),
competitionInvite -> {
AssessorCreatedInviteResource assessorCreatedInvite = new AssessorCreatedInviteResource();
assessorCreatedInvite.setName(competitionInvite.getName());
assessorCreatedInvite.setInnovationAreas(getInnovationAreasForInvite(competitionInvite));
assessorCreatedInvite.setCompliant(isUserCompliant(competitionInvite));
assessorCreatedInvite.setEmail(competitionInvite.getEmail());
assessorCreatedInvite.setInviteId(competitionInvite.getId());
if (competitionInvite.getUser() != null) {
assessorCreatedInvite.setId(competitionInvite.getUser().getId());
}
return assessorCreatedInvite;
}
);
return serviceSuccess(new AssessorCreatedInvitePageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
createdInvites,
pagedResult.getNumber(),
pagedResult.getSize()
));
}
@Override
public ServiceResult<Void> inviteUsers(List<ExistingUserStagedInviteResource> stagedInvites) {
return serviceSuccess(mapWithIndex(stagedInvites, (i, invite) ->
getUserById(invite.getUserId()).andOnSuccess(user ->
getByEmailAndCompetition(user.getEmail(), invite.getCompetitionId()).andOnFailure(() ->
inviteUserToCompetition(user, invite.getCompetitionId())
)))).andOnSuccessReturnVoid();
}
@Override
public ServiceResult<AssessorInviteOverviewPageResource> getInvitationOverview(long competitionId,
Pageable pageable,
List<ParticipantStatus> statuses) {
Page<InterviewParticipant> pagedResult = interviewParticipantRepository.getInterviewPanelAssessorsByCompetitionAndStatusContains(
competitionId,
statuses,
pageable);
List<AssessorInviteOverviewResource> inviteOverviews = simpleMap(
pagedResult.getContent(),
participant -> {
AssessorInviteOverviewResource assessorInviteOverview = new AssessorInviteOverviewResource();
assessorInviteOverview.setName(participant.getInvite().getName());
assessorInviteOverview.setStatus(participantStatusMapper.mapToResource(participant.getStatus()));
assessorInviteOverview.setDetails(getDetails(participant));
assessorInviteOverview.setInviteId(participant.getInvite().getId());
if (participant.getUser() != null) {
Profile profile = profileRepository.findOne(participant.getUser().getProfileId());
assessorInviteOverview.setId(participant.getUser().getId());
assessorInviteOverview.setBusinessType(profile.getBusinessType());
assessorInviteOverview.setCompliant(profile.isCompliant(participant.getUser()));
assessorInviteOverview.setInnovationAreas(simpleMap(profile.getInnovationAreas(), innovationAreaMapper::mapToResource));
}
return assessorInviteOverview;
});
return serviceSuccess(new AssessorInviteOverviewPageResource(
pagedResult.getTotalElements(),
pagedResult.getTotalPages(),
inviteOverviews,
pagedResult.getNumber(),
pagedResult.getSize()
));
}
private String getDetails(InterviewParticipant participant) {
String details = null;
if (participant.getStatus() == REJECTED) {
details = "Invite declined";
} else if (participant.getStatus() == PENDING) {
if (participant.getInvite().getSentOn() != null) {
details = format("Invite sent: %s", participant.getInvite().getSentOn().format(detailsFormatter));
}
}
return details;
}
@Override
public ServiceResult<List<Long>> getNonAcceptedAssessorInviteIds(long competitionId) {
List<InterviewParticipant> participants = interviewParticipantRepository.getInterviewPanelAssessorsByCompetitionAndStatusContains(
competitionId,
asList(PENDING, REJECTED));
return serviceSuccess(simpleMap(participants, participant -> participant.getInvite().getId()));
}
private ServiceResult<InterviewInvite> inviteUserToCompetition(User user, long competitionId) {
return getCompetition(competitionId)
.andOnSuccessReturn(
competition -> interviewInviteRepository.save(new InterviewInvite(user, generateInviteHash(), competition))
);
}
@Override
public ServiceResult<List<InterviewParticipantResource>> getAllInvitesByUser(long userId) {
List<InterviewParticipantResource> interviewParticipantResources =
interviewParticipantRepository
.findByUserIdAndRole(userId, INTERVIEW_ASSESSOR)
.stream()
.filter(participant -> now().isBefore(participant.getInvite().getTarget().getPanelDate()))
.map(interviewParticipantMapper::mapToResource)
.collect(toList());
interviewParticipantResources.forEach(this::determineStatusOfPanelApplications);
return serviceSuccess(interviewParticipantResources);
}
private ServiceResult<Competition> getCompetition(long competitionId) {
return find(competitionRepository.findOne(competitionId), notFoundError(Competition.class, competitionId));
}
private String getInvitePreviewContent(NotificationTarget notificationTarget, Map<String, Object> arguments) {
return renderer.renderTemplate(systemNotificationSource, notificationTarget, "invite_assessors_to_interview_panel_text.txt",
arguments).getSuccess();
}
private String getInvitePreviewContent(Competition competition) {
NotificationTarget notificationTarget = new ExternalUserNotificationTarget("", "");
return getInvitePreviewContent(notificationTarget, asMap(
"competitionName", competition.getName()
));
}
private ServiceResult<Void> sendInviteNotification(String subject,
String customTextPlain,
String customTextHtml,
InterviewInvite invite,
Notifications notificationType) {
NotificationTarget recipient = new ExternalUserNotificationTarget(invite.getName(), invite.getEmail());
Notification notification = new Notification(
systemNotificationSource,
recipient,
notificationType,
asMap(
"subject", subject,
"name", invite.getName(),
"competitionName", invite.getTarget().getName(),
"inviteUrl", format("%s/invite/interview/%s", webBaseUrl + WEB_CONTEXT, invite.getHash()),
"customTextPlain", customTextPlain,
"customTextHtml", customTextHtml
));
return notificationSender.sendNotification(notification).andOnSuccessReturnVoid();
}
private ServiceResult<User> getUserById(long id) {
return find(userRepository.findOne(id), notFoundError(User.class, id));
}
private ServiceResult<InterviewInvite> getByEmailAndCompetition(String email, long competitionId) {
return find(interviewInviteRepository.getByEmailAndCompetitionId(email, competitionId), notFoundError(InterviewInvite.class, email, competitionId));
}
private boolean isUserCompliant(InterviewInvite competitionInvite) {
if (competitionInvite == null || competitionInvite.getUser() == null) {
return false;
}
Profile profile = profileRepository.findOne(competitionInvite.getUser().getProfileId());
return profile.isCompliant(competitionInvite.getUser());
}
private List<InnovationAreaResource> getInnovationAreasForInvite(InterviewInvite competitionInvite) {
return profileRepository.findOne(competitionInvite.getUser().getProfileId()).getInnovationAreas().stream()
.map(innovationAreaMapper::mapToResource)
.collect(toList());
}
@Override
public ServiceResult<InterviewInviteResource> openInvite(String inviteHash) {
return getByHashIfOpen(inviteHash)
.andOnSuccessReturn(this::openInvite)
.andOnSuccessReturn(interviewInviteMapper::mapToResource);
}
private InterviewInvite openInvite(InterviewInvite invite) {
return interviewInviteRepository.save(invite.open());
}
@Override
public ServiceResult<Void> acceptInvite(String inviteHash) {
return getParticipantByInviteHash(inviteHash)
.andOnSuccess(InterviewInviteServiceImpl::accept)
.andOnSuccessReturnVoid();
}
@Override
public ServiceResult<Void> rejectInvite(String inviteHash) {
return getParticipantByInviteHash(inviteHash)
.andOnSuccess(this::reject)
.andOnSuccessReturnVoid();
}
private ServiceResult<InterviewParticipant> getParticipantByInviteHash(String inviteHash) {
return find(interviewParticipantRepository.getByInviteHash(inviteHash), notFoundError(InterviewParticipant.class, inviteHash));
}
@Override
public ServiceResult<Boolean> checkExistingUser(@P("inviteHash") String inviteHash) {
return getByHash(inviteHash).andOnSuccessReturn(invite -> {
if (invite.getUser() != null) {
return TRUE;
}
return userRepository.findByEmail(invite.getEmail()).isPresent();
});
}
private ServiceResult<InterviewInvite> getByHash(String inviteHash) {
return find(interviewInviteRepository.getByHash(inviteHash), notFoundError(InterviewInvite.class, inviteHash));
}
private static ServiceResult<InterviewParticipant> accept(InterviewParticipant participant) {
User user = participant.getUser();
if (participant.getInvite().getStatus() != OPENED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_UNOPENED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == ACCEPTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_ALREADY_ACCEPTED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_ACCEPT_ALREADY_REJECTED_INVITE, getInviteCompetitionName(participant)));
} else {
return serviceSuccess( participant.acceptAndAssignUser(user));
}
}
private ServiceResult<CompetitionParticipant> reject(InterviewParticipant participant) {
if (participant.getInvite().getStatus() != OPENED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_UNOPENED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == ACCEPTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_ALREADY_ACCEPTED_INVITE, getInviteCompetitionName(participant)));
} else if (participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_PARTICIPANT_CANNOT_REJECT_ALREADY_REJECTED_INVITE, getInviteCompetitionName(participant)));
} else {
return serviceSuccess(participant.reject());
}
}
private static String getInviteCompetitionName(InterviewParticipant participant) {
return participant.getInvite().getTarget().getName();
}
private ServiceResult<InterviewInvite> getByHashIfOpen(String inviteHash) {
return getByHash(inviteHash).andOnSuccess(invite -> {
if (invite.getTarget().getPanelDate() == null || now().isAfter(invite.getTarget().getPanelDate())) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_EXPIRED, invite.getTarget().getName()));
}
InterviewParticipant participant = interviewParticipantRepository.getByInviteHash(inviteHash);
if (participant == null) {
return serviceSuccess(invite);
}
if (participant.getStatus() == ACCEPTED || participant.getStatus() == REJECTED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_CLOSED, invite.getTarget().getName()));
}
return serviceSuccess(invite);
});
}
@Override
public ServiceResult<Void> deleteInvite(String email, long competitionId) {
return getByEmailAndCompetition(email, competitionId).andOnSuccess(this::deleteInvite);
}
@Override
public ServiceResult<Void> deleteAllInvites(long competitionId) {
return find(competitionRepository.findOne(competitionId), notFoundError(Competition.class, competitionId))
.andOnSuccessReturnVoid(competition ->
interviewInviteRepository.deleteByCompetitionIdAndStatus(competition.getId(), CREATED));
}
private ServiceResult<Void> deleteInvite(InterviewInvite invite) {
if (invite.getStatus() != CREATED) {
return ServiceResult.serviceFailure(new Error(INTERVIEW_PANEL_INVITE_CANNOT_DELETE_ONCE_SENT, invite.getEmail()));
}
interviewInviteRepository.delete(invite);
return serviceSuccess();
}
private void determineStatusOfPanelApplications(InterviewParticipantResource interviewParticipantResource) {
List<Interview> reviews = interviewRepository.
findByParticipantUserIdAndTargetCompetitionIdOrderByActivityStateStateAscIdAsc(
interviewParticipantResource.getUserId(),
interviewParticipantResource.getCompetitionId());
interviewParticipantResource.setAwaitingApplications(getApplicationsPendingForPanelCount(reviews));
}
private Long getApplicationsPendingForPanelCount(List<Interview> reviews) {
return reviews.stream().filter(review -> review.getActivityState().equals(InterviewState.PENDING)).count();
}
} | IFS-3055 code tidy
| ifs-data-layer/ifs-data-service/src/main/java/org/innovateuk/ifs/interview/transactional/InterviewInviteServiceImpl.java | IFS-3055 code tidy | <ide><path>fs-data-layer/ifs-data-service/src/main/java/org/innovateuk/ifs/interview/transactional/InterviewInviteServiceImpl.java
<ide> private InterviewParticipantRepository interviewParticipantRepository;
<ide>
<ide> @Autowired
<del> private ApplicationRepository applicationRepository;
<del>
<del> @Autowired
<del> private ActivityStateRepository activityStateRepository;
<del>
<del> @Autowired
<ide> private CompetitionRepository competitionRepository;
<ide>
<ide> @Autowired |
|
JavaScript | mit | ea19a1025ff7fa44a139914d6c40045ff48169d4 | 0 | neofreko/whistle | HOST = null; // localhost
PORT = process.env.VMC_APP_PORT || 8001;
// when the daemon started
var starttime = (new Date()).getTime();
var mem = process.memoryUsage();
// every 10 seconds poll for the memory.
setInterval(function() {
mem = process.memoryUsage();
}, 10 * 1000);
var fu = require("./fu"),
sys = require("util"),
url = require("url"),
qs = require("querystring"),
http = require("http")
$ = require('jquery');
var MESSAGE_BACKLOG = 200,
SESSION_TIMEOUT = 60 * 1000;
var channel = new function() {
var messages = [],
callbacks = [];
this.appendMessage = function(nick, type, text) {
var m = {nick: nick
, type: type // "msg", "join", "part"
, text: text
, timestamp: (new Date()).getTime()
};
switch (type) {
case "msg":
sys.puts("<" + nick + "> " + text);
break;
case "queue":
sys.puts("<" + nick + "> queue " + text);
break;
case "join":
sys.puts(nick + " join");
break;
case "part":
sys.puts(nick + " part");
break;
}
messages.push(m);
while (callbacks.length > 0) {
callbacks.shift().callback([m]);
}
while (messages.length > MESSAGE_BACKLOG)
messages.shift();
};
this.query = function(since, callback) {
var matching = [];
for (var i = 0; i < messages.length; i++) {
var message = messages[i];
if (message.timestamp > since)
matching.push(message)
}
if (matching.length != 0) {
callback(matching);
} else {
callbacks.push({timestamp: new Date(), callback: callback});
}
};
// clear old callbacks
// they can hang around for at most 30 seconds.
setInterval(function() {
var now = new Date();
while (callbacks.length > 0 && now - callbacks[0].timestamp > 30 * 1000) {
callbacks.shift().callback([]);
}
}, 3000);
};
var welcomeMedia = "http://ec-media.soundcloud.com/mS7BfTeKbteG.128.mp3?ff61182e3c2ecefa438cd02102d0e385713f0c1faf3b0339595666fe0c07e9176e2615f66b4feb65275988d14654226b9ba4f4a1634cc012c47e7d90a18b5bf067dadbbfa9&AWSAccessKeyId=AKIAJ4IAZE5EOI7PA7VQ&Expires=1354322349&Signature=eRBmOZuhrLOATaif9%2BptAgkg8zg%3D";//"http://api.soundcloud.com/tracks/61083298/stream?client_id=7752b2872de45cce9104b6feaa1e3582";//http://www.youtube.com/watch?v=0UIB9Y4OFPs";
var mediaPlaylist = [];
var currentDJSessionID = false;
var nowPlaying = false;
var sessions = {};
var sessions_length = 0;
function createSession(nick) {
if (nick.length > 50)
return null;
if (/[^\w_\-^!]/.exec(nick))
return null;
for (var i in sessions) {
var session = sessions[i];
if (session && session.nick === nick)
return null;
}
var session = {
nick: nick,
isDJ: sessions_length == 0,
lastQueue: false,
id: Math.floor(Math.random() * 99999999999).toString(),
timestamp: new Date(),
poke: function() {
session.timestamp = new Date();
},
destroy: function() {
channel.appendMessage(session.nick, "part");
delete sessions[session.id];
}
};
sys.puts('session length: ' + sessions.length)
if (session.isDJ) {
currentDJSessionID = session.id
sys.puts("We got a DJ here: " + session.nick + "!")
}
sessions[session.id] = session;
sessions_length++
return session;
}
// interval to kill off old sessions
setInterval(function() {
var now = new Date();
for (var id in sessions) {
if (!sessions.hasOwnProperty(id))
continue;
var session = sessions[id];
if (now - session.timestamp > SESSION_TIMEOUT) {
session.destroy();
}
}
}, 1000);
fu.listen(Number(process.env.PORT || PORT), HOST);
fu.get("/", fu.staticHandler("index.html"));
fu.get("/style.css", fu.staticHandler("style.css"));
fu.get("/client.js", fu.staticHandler("client.js"));
fu.get("/jquery-1.2.6.min.js", fu.staticHandler("jquery-1.2.6.min.js"));
fu.get("/jwplayer/jwplayer.flash.swf", fu.staticHandler("jwplayer/jwplayer.flash.swf"));
fu.get("/jwplayer/jwplayer.html5.js", fu.staticHandler("jwplayer/jwplayer.html5.js"));
fu.get("/jwplayer/jwplayer.js", fu.staticHandler("jwplayer/jwplayer.js"));
fu.get("/css/bootstrap.min.css", fu.staticHandler("css/bootstrap.min.css"));
fu.get("/js/bootstrap.min.js", fu.staticHandler("js/bootstrap.min.js"));
function getNicks() {
var nicks = [];
for (var id in sessions) {
if (!sessions.hasOwnProperty(id))
continue;
var session = sessions[id];
nicks.push(session.nick);
}
return nicks;
}
function pickNewDJ() {
var idx = Math.floor(Math.random() * sessions.length);
return sessions[idx].nick;
currentDJSessionID = session.id;
}
fu.get("/who", function(req, res) {
var nicks = getNicks();
res.simpleJSON(200, {nicks: nicks
, rss: mem.rss
});
});
fu.get("/join", function(req, res) {
var nick = qs.parse(url.parse(req.url).query).nick;
if (nick == null || nick.length == 0) {
res.simpleJSON(400, {error: "Bad nick."});
return;
}
var session = createSession(nick);
if (session == null) {
res.simpleJSON(400, {error: "Nick in use"});
return;
}
//sys.puts("connection: " + nick + "@" + res.connection.remoteAddress);
// FIXME: use media from current playlist if availabl
channel.appendMessage(session.nick, "join");
var media = nowPlaying ? nowPlaying : welcomeMedia;
res.simpleJSON(200, {id: session.id
, nick: session.nick
, rss: mem.rss
, starttime: starttime
, media: media
});
sys.puts("tell client " + session.id + " to play " + media + "...");
});
fu.get("/part", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var session;
if (id && sessions[id]) {
session = sessions[id];
session.destroy();
sessions_length--;
}
var newDJ = pickNewDJ();
channel.appendMessage('chatmaster', "msg", newDJ + ' is the new DJ. Yay!');
res.simpleJSON(200, {rss: mem.rss});
});
fu.get("/recv", function(req, res) {
if (!qs.parse(url.parse(req.url).query).since) {
res.simpleJSON(400, {error: "Must supply since parameter"});
return;
}
var id = qs.parse(url.parse(req.url).query).id;
var session;
if (id && sessions[id]) {
session = sessions[id];
session.poke();
}
var since = parseInt(qs.parse(url.parse(req.url).query).since, 10);
channel.query(since, function(messages) {
if (session)
session.poke();
res.simpleJSON(200, {messages: messages, rss: mem.rss});
});
});
fu.get("/send", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var text = qs.parse(url.parse(req.url).query).text;
var session = sessions[id];
if (!session || !text) {
res.simpleJSON(400, {error: "No such session id"});
return;
}
session.poke();
var media_resolvers = [
{
re: /(http(s*):\/\/(www\.)?youtube\.com\/watch\?v=\S+)/,
resolver: function(text_url, callback) {
var medias = /(http(s*):\/\/(www\.)?youtube\.com\/watch\?v=\S+)/.exec(text_url)
callback(medias[0])
}
},
{
//http://soundcloud.com/runtlalala/dont-know-why-norah-jones
re: /(http:\/\/soundcloud\.com\/\S+?\/\S+)/,
resolver: function(text_url, callback) {
var medias = /(http:\/\/soundcloud\.com\/\S+?\/\S+)/.exec(text_url)
sys.puts('http://api.soundcloud.com/resolve.json?url=' + medias[0] + '&client_id=7752b2872de45cce9104b6feaa1e3582')
$.ajax({
url: 'http://api.soundcloud.com/resolve.json?url=' + medias[0] + '&client_id=7752b2872de45cce9104b6feaa1e3582',
dataType: 'json',
success: function(data) {
sys.puts('got data from soundcloud')
console.log(data)
callback(data.stream_url)
},
error: function (jqxhr, errorStatus, errorThrown) {
sys.puts('error resolving soundcloud url: '+jqxhr.responseText)
},
statusCode: {
302: function(jqxhr, errorStatus, errorThrown) {
var new_location = $.parseJSON(jqxhr.responseText);
sys.puts('new location: ' + new_location.location)
$.ajax({
url: new_location.location,
dataType: 'json',
success: function(data) {
sys.puts('Will fetch playable URL from: '+data.stream_url+'?client_id=7752b2872de45cce9104b6feaa1e3582')
// but jwplayer cannot handle the redirect, so we'll gonna help it fetch the real stream url
var surl = url.parse(data.stream_url+'?client_id=7752b2872de45cce9104b6feaa1e3582')
http.get({host: surl.host, path: surl.path}, function(res) {
console.log("Got response: " + res.statusCode);
for(var item in res.headers) {
console.log(item + ": " + res.headers[item]);
}
console.log('Yay, REAL soundcloud jwplayer-playable url: ', res.headers['location'])
callback(res.headers['location']);
}).on('error', function(e) {
console.log("Got error: " + e.message);
});
}
})
}
}
});
}
},
]
var media_resolver_callback = function(media) {
console.log('nowPlaying: ', nowPlaying, ' playlist: ', mediaPlaylist.length,' items')
if (nowPlaying == false && mediaPlaylist.length == 0) {
//skip playlist
channel.appendMessage(session.nick, "play", media)
nowPlaying = media
} else {
channel.appendMessage(session.nick, "queue", media);
mediaPlaylist.push(media);
}
}
var resolved = false
for (idx in media_resolvers) {
var re = media_resolvers[idx]
console.log(re)
if (re.re.test(text)) {
var diff = (session.lastQueue - new Date())/1000
console.log('lastQueue: ', session.lastQueue, ' diff: ',diff,' seconds')
var canQueue = (session.lastQueue == false) || (session.lastQueue && diff > 2) || mediaPlaylist.length==0// two second ban
if (canQueue) {
media = re.resolver(text, media_resolver_callback)
resolved = true
session.lastQueue = new Date();
} else {
channel.appendMessage('chatmaster', 'msg', session.nick + ', no queue flooding please')
resolved = true
}
break
}
}
if (!resolved)
channel.appendMessage(session.nick, "msg", text);
res.simpleJSON(200, {rss: mem.rss});
});
fu.get("/notify", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var text = qs.parse(url.parse(req.url).query).text;
var session = sessions[id];
switch (text) {
case "media-next":
sys.puts('sender session: ' + session.nick + ' ' + session.idDJ ? 'is DJ' : 'not DJ')
if (id == currentDJSessionID) {
if (mediaPlaylist.length > 0) {
var nextMedia = mediaPlaylist.shift();
channel.appendMessage(session.nick, "play", nextMedia)
nowPlaying = nextMedia;
sys.puts("notify " + text + ": " + nextMedia);
} else {
nowPlaying = false;
sys.puts("notify " + text + ": playlist is empty. Waiting for new media queue");
channel.appendMessage('chatmaster', 'msg', 'Playlist is empty, queue some more!')
}
}
break;
}
res.simpleJSON(200, {rss: mem.rss});
});
| server.js | HOST = null; // localhost
PORT = process.env.VMC_APP_PORT || 8001;
// when the daemon started
var starttime = (new Date()).getTime();
var mem = process.memoryUsage();
// every 10 seconds poll for the memory.
setInterval(function() {
mem = process.memoryUsage();
}, 10 * 1000);
var fu = require("./fu"),
sys = require("util"),
url = require("url"),
qs = require("querystring"),
http = require("http")
$ = require('jquery');
var MESSAGE_BACKLOG = 200,
SESSION_TIMEOUT = 60 * 1000;
var channel = new function() {
var messages = [],
callbacks = [];
this.appendMessage = function(nick, type, text) {
var m = {nick: nick
, type: type // "msg", "join", "part"
, text: text
, timestamp: (new Date()).getTime()
};
switch (type) {
case "msg":
sys.puts("<" + nick + "> " + text);
break;
case "queue":
sys.puts("<" + nick + "> queue " + text);
break;
case "join":
sys.puts(nick + " join");
break;
case "part":
sys.puts(nick + " part");
break;
}
messages.push(m);
while (callbacks.length > 0) {
callbacks.shift().callback([m]);
}
while (messages.length > MESSAGE_BACKLOG)
messages.shift();
};
this.query = function(since, callback) {
var matching = [];
for (var i = 0; i < messages.length; i++) {
var message = messages[i];
if (message.timestamp > since)
matching.push(message)
}
if (matching.length != 0) {
callback(matching);
} else {
callbacks.push({timestamp: new Date(), callback: callback});
}
};
// clear old callbacks
// they can hang around for at most 30 seconds.
setInterval(function() {
var now = new Date();
while (callbacks.length > 0 && now - callbacks[0].timestamp > 30 * 1000) {
callbacks.shift().callback([]);
}
}, 3000);
};
var welcomeMedia = "http://ec-media.soundcloud.com/mS7BfTeKbteG.128.mp3?ff61182e3c2ecefa438cd02102d0e385713f0c1faf3b0339595666fe0c07e9176e2615f66b4feb65275988d14654226b9ba4f4a1634cc012c47e7d90a18b5bf067dadbbfa9&AWSAccessKeyId=AKIAJ4IAZE5EOI7PA7VQ&Expires=1354322349&Signature=eRBmOZuhrLOATaif9%2BptAgkg8zg%3D";//"http://api.soundcloud.com/tracks/61083298/stream?client_id=7752b2872de45cce9104b6feaa1e3582";//http://www.youtube.com/watch?v=0UIB9Y4OFPs";
var mediaPlaylist = [];
var currentDJSessionID = false;
var nowPlaying = false;
var sessions = {};
var sessions_length = 0;
function createSession(nick) {
if (nick.length > 50)
return null;
if (/[^\w_\-^!]/.exec(nick))
return null;
for (var i in sessions) {
var session = sessions[i];
if (session && session.nick === nick)
return null;
}
var session = {
nick: nick,
isDJ: sessions_length == 0,
lastQueue: false,
id: Math.floor(Math.random() * 99999999999).toString(),
timestamp: new Date(),
poke: function() {
session.timestamp = new Date();
},
destroy: function() {
channel.appendMessage(session.nick, "part");
delete sessions[session.id];
}
};
sys.puts('session length: ' + sessions.length)
if (session.isDJ) {
currentDJSessionID = session.id
sys.puts("We got a DJ here: " + session.nick + "!")
}
sessions[session.id] = session;
sessions_length++
return session;
}
// interval to kill off old sessions
setInterval(function() {
var now = new Date();
for (var id in sessions) {
if (!sessions.hasOwnProperty(id))
continue;
var session = sessions[id];
if (now - session.timestamp > SESSION_TIMEOUT) {
session.destroy();
}
}
}, 1000);
fu.listen(Number(process.env.PORT || PORT), HOST);
fu.get("/", fu.staticHandler("index.html"));
fu.get("/style.css", fu.staticHandler("style.css"));
fu.get("/client.js", fu.staticHandler("client.js"));
fu.get("/jquery-1.2.6.min.js", fu.staticHandler("jquery-1.2.6.min.js"));
fu.get("/jwplayer/jwplayer.flash.swf", fu.staticHandler("jwplayer/jwplayer.flash.swf"));
fu.get("/jwplayer/jwplayer.html5.js", fu.staticHandler("jwplayer/jwplayer.html5.js"));
fu.get("/jwplayer/jwplayer.js", fu.staticHandler("jwplayer/jwplayer.js"));
fu.get("/css/bootstrap.min.css", fu.staticHandler("css/bootstrap.min.css"));
fu.get("/js/bootstrap.min.js", fu.staticHandler("js/bootstrap.min.js"));
function getNicks() {
var nicks = [];
for (var id in sessions) {
if (!sessions.hasOwnProperty(id))
continue;
var session = sessions[id];
nicks.push(session.nick);
}
return nicks;
}
function pickNewDJ() {
var idx = Math.floor(Math.random() * sessions.length);
return sessions[idx].nick;
currentDJSessionID = session.id;
}
fu.get("/who", function(req, res) {
var nicks = getNicks();
res.simpleJSON(200, {nicks: nicks
, rss: mem.rss
});
});
fu.get("/join", function(req, res) {
var nick = qs.parse(url.parse(req.url).query).nick;
if (nick == null || nick.length == 0) {
res.simpleJSON(400, {error: "Bad nick."});
return;
}
var session = createSession(nick);
if (session == null) {
res.simpleJSON(400, {error: "Nick in use"});
return;
}
//sys.puts("connection: " + nick + "@" + res.connection.remoteAddress);
// FIXME: use media from current playlist if availabl
channel.appendMessage(session.nick, "join");
var media = nowPlaying ? nowPlaying : welcomeMedia;
res.simpleJSON(200, {id: session.id
, nick: session.nick
, rss: mem.rss
, starttime: starttime
, media: media
});
sys.puts("tell client " + session.id + " to play " + media + "...");
});
fu.get("/part", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var session;
if (id && sessions[id]) {
session = sessions[id];
session.destroy();
sessions_length--;
}
var newDJ = pickNewDJ();
channel.appendMessage('chatmaster', "msg", newDJ + ' is the new DJ. Yay!');
res.simpleJSON(200, {rss: mem.rss});
});
fu.get("/recv", function(req, res) {
if (!qs.parse(url.parse(req.url).query).since) {
res.simpleJSON(400, {error: "Must supply since parameter"});
return;
}
var id = qs.parse(url.parse(req.url).query).id;
var session;
if (id && sessions[id]) {
session = sessions[id];
session.poke();
}
var since = parseInt(qs.parse(url.parse(req.url).query).since, 10);
channel.query(since, function(messages) {
if (session)
session.poke();
res.simpleJSON(200, {messages: messages, rss: mem.rss});
});
});
fu.get("/send", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var text = qs.parse(url.parse(req.url).query).text;
var session = sessions[id];
if (!session || !text) {
res.simpleJSON(400, {error: "No such session id"});
return;
}
session.poke();
var media_resolvers = [
{
re: /(http(s*):\/\/(www\.)?youtube\.com\/watch\?v=\S+)/,
resolver: function(text_url, callback) {
var medias = /(http(s*):\/\/(www\.)?youtube\.com\/watch\?v=\S+)/.exec(text_url)
callback(medias[0])
}
},
{
//http://soundcloud.com/runtlalala/dont-know-why-norah-jones
re: /(http:\/\/soundcloud\.com\/\S+?\/\S+)/,
resolver: function(text_url, callback) {
var medias = /(http:\/\/soundcloud\.com\/\S+?\/\S+)/.exec(text_url)
sys.puts('http://api.soundcloud.com/resolve.json?url=' + medias[0] + '&client_id=7752b2872de45cce9104b6feaa1e3582')
$.ajax({
url: 'http://api.soundcloud.com/resolve.json?url=' + medias[0] + '&client_id=7752b2872de45cce9104b6feaa1e3582',
dataType: 'json',
success: function(data) {
sys.puts('got data from soundcloud')
console.log(data)
callback(data.stream_url)
},
error: function (jqxhr, errorStatus, errorThrown) {
sys.puts('error resolving soundcloud url: '+jqxhr.responseText)
},
statusCode: {
302: function(jqxhr, errorStatus, errorThrown) {
var new_location = $.parseJSON(jqxhr.responseText);
sys.puts('new location: ' + new_location.location)
$.ajax({
url: new_location.location,
dataType: 'json',
success: function(data) {
sys.puts('Will fetch playable URL from: '+data.stream_url+'?client_id=7752b2872de45cce9104b6feaa1e3582')
// but jwplayer cannot handle the redirect, so we'll gonna help it fetch the real stream url
var surl = url.parse(data.stream_url+'?client_id=7752b2872de45cce9104b6feaa1e3582')
http.get({host: surl.host, path: surl.path}, function(res) {
console.log("Got response: " + res.statusCode);
for(var item in res.headers) {
console.log(item + ": " + res.headers[item]);
}
console.log('Yay, REAL soundcloud jwplayer-playable url: ', res.headers['location'])
callback(res.headers['location']);
}).on('error', function(e) {
console.log("Got error: " + e.message);
});
}
})
}
}
});
}
},
]
var media_resolver_callback = function(media) {
console.log('nowPlaying: ', nowPlaying, ' playlist: ', mediaPlaylist.length,' items')
if (nowPlaying == false && mediaPlaylist.length == 0) {
//skip playlist
channel.appendMessage(session.nick, "play", media)
nowPlaying = media
} else {
channel.appendMessage(session.nick, "queue", media);
mediaPlaylist.push(media);
}
}
var resolved = false
for (idx in media_resolvers) {
var re = media_resolvers[idx]
console.log(re)
if (re.re.test(text)) {
var diff = (session.lastQueue - new Date())/1000
console.log('lastQueue: ', session.lastQueue, ' diff: ',diff,' seconds')
var canQueue = (session.lastQueue == false) || (session.lastQueue && diff > 2) // two second ban
if (canQueue) {
media = re.resolver(text, media_resolver_callback)
resolved = true
session.lastQueue = new Date();
} else {
channel.appendMessage('chatmaster', 'msg', session.nick + ', no queue flooding please')
resolved = true
}
break
}
}
if (!resolved)
channel.appendMessage(session.nick, "msg", text);
res.simpleJSON(200, {rss: mem.rss});
});
fu.get("/notify", function(req, res) {
var id = qs.parse(url.parse(req.url).query).id;
var text = qs.parse(url.parse(req.url).query).text;
var session = sessions[id];
switch (text) {
case "media-next":
sys.puts('sender session: ' + session.nick + ' ' + session.idDJ ? 'is DJ' : 'not DJ')
if (id == currentDJSessionID) {
if (mediaPlaylist.length > 0) {
var nextMedia = mediaPlaylist.shift();
channel.appendMessage(session.nick, "play", nextMedia)
nowPlaying = nextMedia;
sys.puts("notify " + text + ": " + nextMedia);
} else {
nowPlaying = false;
sys.puts("notify " + text + ": playlist is empty. Waiting for new media queue");
channel.appendMessage('chatmaster', 'msg', 'Playlist is empty, queue some more!')
}
}
break;
}
res.simpleJSON(200, {rss: mem.rss});
});
| allow queue when playlist is empty
| server.js | allow queue when playlist is empty | <ide><path>erver.js
<ide> if (re.re.test(text)) {
<ide> var diff = (session.lastQueue - new Date())/1000
<ide> console.log('lastQueue: ', session.lastQueue, ' diff: ',diff,' seconds')
<del> var canQueue = (session.lastQueue == false) || (session.lastQueue && diff > 2) // two second ban
<add> var canQueue = (session.lastQueue == false) || (session.lastQueue && diff > 2) || mediaPlaylist.length==0// two second ban
<ide> if (canQueue) {
<ide> media = re.resolver(text, media_resolver_callback)
<ide> resolved = true |
|
JavaScript | mit | ed454dfd7ba49475894f74ee0d79639625258107 | 0 | jdivy/meteor,lorensr/meteor,nuvipannu/meteor,AnthonyAstige/meteor,AnthonyAstige/meteor,Hansoft/meteor,mjmasn/meteor,jdivy/meteor,DAB0mB/meteor,DAB0mB/meteor,nuvipannu/meteor,Hansoft/meteor,nuvipannu/meteor,Hansoft/meteor,nuvipannu/meteor,nuvipannu/meteor,DAB0mB/meteor,chasertech/meteor,DAB0mB/meteor,AnthonyAstige/meteor,AnthonyAstige/meteor,lorensr/meteor,AnthonyAstige/meteor,jdivy/meteor,chasertech/meteor,chasertech/meteor,chasertech/meteor,AnthonyAstige/meteor,DAB0mB/meteor,mjmasn/meteor,mjmasn/meteor,4commerce-technologies-AG/meteor,DAB0mB/meteor,lorensr/meteor,Hansoft/meteor,jdivy/meteor,4commerce-technologies-AG/meteor,4commerce-technologies-AG/meteor,mjmasn/meteor,lorensr/meteor,nuvipannu/meteor,Hansoft/meteor,AnthonyAstige/meteor,jdivy/meteor,chasertech/meteor,chasertech/meteor,lorensr/meteor,4commerce-technologies-AG/meteor,mjmasn/meteor,4commerce-technologies-AG/meteor,chasertech/meteor,Hansoft/meteor,lorensr/meteor,Hansoft/meteor,lorensr/meteor,AnthonyAstige/meteor,jdivy/meteor,jdivy/meteor,DAB0mB/meteor,4commerce-technologies-AG/meteor,mjmasn/meteor,mjmasn/meteor,nuvipannu/meteor,4commerce-technologies-AG/meteor | import moment from "moment";
import shared from "./imports/shared";
import {Meteor as ImportedMeteor} from "meteor/meteor";
describe("app modules", () => {
it("can be imported using absolute identifiers", () => {
assert.strictEqual(require("/tests"), exports);
});
it("can have different file extensions", () => {
assert.strictEqual(
require("./eager.jsx").extension,
".jsx"
);
assert.strictEqual(
require("./eager.coffee").extension,
".coffee"
);
});
it("are eagerly evaluated if outside imports/", () => {
assert.strictEqual(shared["/eager.jsx"], "eager jsx");
assert.strictEqual(shared["/eager.coffee"], "eager coffee");
});
it("are lazily evaluated if inside imports/", (done) => {
const delayMs = 200;
setTimeout(() => {
assert.strictEqual(shared["/imports/lazy1.js"], void 0);
assert.strictEqual(shared["/imports/lazy2.js"], void 0);
var reset1 = require("./imports/lazy1").reset;
assert.strictEqual(shared["/imports/lazy1.js"], 1);
assert.strictEqual(shared["/imports/lazy2.js"], 2);
// Make sure this test can run again without starting a new process.
require("./imports/lazy2").reset();
reset1();
done();
}, delayMs);
});
it("cannot import server modules on client", () => {
let error;
let result;
try {
result = require("./server/only").default;
} catch (expectedOnClient) {
error = expectedOnClient;
}
if (Meteor.isServer) {
assert.strictEqual(typeof error, "undefined");
assert.strictEqual(result, "/server/only.js");
assert.strictEqual(require("./server/only"),
require("/server/only"));
}
if (Meteor.isClient) {
assert.ok(error instanceof Error);
}
});
it("cannot import client modules on server", () => {
let error;
let result;
try {
result = require("./client/only").default;
} catch (expectedOnServer) {
error = expectedOnServer;
}
if (Meteor.isClient) {
assert.strictEqual(typeof error, "undefined");
assert.strictEqual(result, "/client/only.js");
assert.strictEqual(require("./client/only"),
require("/client/only"));
}
if (Meteor.isServer) {
assert.ok(error instanceof Error);
}
});
it("should not be parsed in strictMode", () => {
let foo = 1234;
delete foo;
});
it("should have access to filename and dirname", () => {
assert.strictEqual(require(__filename), exports);
assert.strictEqual(
require("path").relative(__dirname, __filename),
"tests.js"
);
});
});
describe("template modules", () => {
Meteor.isClient &&
it("should be importable on the client", () => {
assert.strictEqual(typeof Template, "function");
assert.ok(! _.has(Template, "lazy"));
require("./imports/lazy.html");
assert.ok(_.has(Template, "lazy"));
assert.ok(Template.lazy instanceof Template);
});
Meteor.isServer &&
it("should not be importable on the server", () => {
let error;
try {
require("./imports/lazy.html");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
});
Meteor.isClient &&
describe("css modules", () => {
it("should be loaded eagerly unless lazy", () => {
assert.strictEqual(
$(".app-eager-css").css("display"),
"none"
);
let error;
try {
require("./eager.css");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
it("should be importable by an app", () => {
assert.strictEqual(
$(".app-lazy-css").css("display"),
"block"
);
require("./imports/lazy.css");
assert.strictEqual(
$(".app-lazy-css").css("display"),
"none"
);
});
it("should be importable by a package", () => {
assert.strictEqual(
$(".pkg-lazy-css.imported").css("display"),
"none"
);
assert.strictEqual(
$(".pkg-lazy-css.not-imported").css("display"),
"block"
);
});
});
describe("native node_modules", () => {
Meteor.isServer &&
it("can be imported on the server", () => {
assert.strictEqual(typeof require("fs").readFile, "function");
});
Meteor.isClient &&
it("are imported as stubs on the client", () => {
const inherits = require("util").inherits;
assert.strictEqual(typeof inherits, "function");
assert.strictEqual(require("util"),
require("util/util.js"));
});
Meteor.isServer &&
it("cannot be overridden on the server", () => {
assert.strictEqual(typeof require("repl").start, "function");
});
Meteor.isClient &&
it("can be overridden on the client", () => {
assert.strictEqual(require("repl").notEmpty, true);
});
it("can be implemented by wrapper npm packages", () => {
const Stream = require("stream");
assert.strictEqual(typeof Stream, "function");
assert.strictEqual(typeof Stream.Readable, "function");
});
Meteor.isClient &&
it("can be installed with aliases", () => {
meteorInstall({
node_modules: {
http: "stream-http"
}
});
assert.strictEqual(require("http"), require("stream-http"));
});
});
describe("local node_modules", () => {
it("should be importable", () => {
assert.strictEqual(require("moment"), moment);
const cal = moment().calendar();
assert.ok(cal.match(/\bat\b/));
});
it("can be imported using absolute identifiers", () => {
assert.strictEqual(
require("moment"),
require("/node_modules/moment")
);
});
it("should be importable by packages", () => {
// Defined in packages/modules-test-package/common.js.
assert.strictEqual(typeof regeneratorRuntime, "object");
});
it('should expose "version" field of package.json', () => {
const pkg = require("moment/package.json");
assert.strictEqual(pkg.version, "2.11.1");
});
});
describe("Meteor packages", () => {
it("api.export should create named exports", () => {
assert.strictEqual(typeof ImportedMeteor, "object");
assert.strictEqual(Meteor, ImportedMeteor);
});
it("should be importable", () => {
assert.strictEqual(require("meteor/underscore")._, _);
const Blaze = require("meteor/blaze").Blaze;
assert.strictEqual(typeof Blaze, "object");
let error;
try {
require("meteor/nonexistent");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
it("can be local", () => {
assert.strictEqual(ModulesTestPackage, "loaded");
const mtp = require("meteor/modules-test-package");
assert.strictEqual(mtp.where, Meteor.isServer ? "server" : "client");
});
it("should expose their files for import", () => {
const osStub = require("meteor/modules-test-package/os-stub");
assert.strictEqual(
osStub.platform(),
"browser"
);
assert.strictEqual(
osStub.name,
"/node_modules/meteor/modules-test-package/os-stub.js"
);
});
});
describe("ecmascript miscellany", () => {
it("JSX should work in .js files on both client and server", () => {
const React = {
createElement: function (name, attrs, children) {
assert.strictEqual(name, "div");
assert.strictEqual(attrs, null);
assert.strictEqual(children, "hi");
return "all good";
}
};
assert.strictEqual(<div>hi</div>, "all good");
});
it("async functions should work on the client and server", async () => {
assert.strictEqual(
await 2 + 2,
await new Promise(resolve => resolve(4))
);
});
it("rest paramters in inner arrow functions (#6312)", () => {
const rev = (...args) => args.reverse();
assert.deepEqual(rev(1, 2, 3), [3, 2, 1]);
assert.ok(rev.toString().match(/\barguments\b/));
});
});
Meteor.isClient &&
describe("client/compatibility directories", () => {
it("should contain bare files", () => {
assert.strictEqual(topLevelVariable, 1234);
});
});
describe(".es5.js files", () => {
it("should not be transpiled", () => {
assert.strictEqual(require("./imports/plain.es5.js").let, "ok");
});
});
describe("return statements at top level", () => {
it("should be legal", () => {
var ret = require("./imports/return.js");
assert.strictEqual(ret.a, 1234);
assert.strictEqual(ret.b, void 0);
});
});
describe("circular package.json resolution chains", () => {
it("should be broken appropriately", () => {
assert.strictEqual(
require("./lib").aMain,
"/lib/a/index.js"
);
});
});
| tools/tests/apps/modules/tests.js | import moment from "moment";
import shared from "./imports/shared";
import {Meteor as ImportedMeteor} from "meteor/meteor";
describe("app modules", () => {
it("can be imported using absolute identifiers", () => {
assert.strictEqual(require("/tests"), exports);
});
it("can have different file extensions", () => {
assert.strictEqual(
require("./eager.jsx").extension,
".jsx"
);
assert.strictEqual(
require("./eager.coffee").extension,
".coffee"
);
});
it("are eagerly evaluated if outside imports/", () => {
assert.strictEqual(shared["/eager.jsx"], "eager jsx");
assert.strictEqual(shared["/eager.coffee"], "eager coffee");
});
it("are lazily evaluated if inside imports/", (done) => {
const delayMs = 200;
setTimeout(() => {
assert.strictEqual(shared["/imports/lazy1.js"], void 0);
assert.strictEqual(shared["/imports/lazy2.js"], void 0);
var reset1 = require("./imports/lazy1").reset;
assert.strictEqual(shared["/imports/lazy1.js"], 1);
assert.strictEqual(shared["/imports/lazy2.js"], 2);
// Make sure this test can run again without starting a new process.
require("./imports/lazy2").reset();
reset1();
done();
}, delayMs);
});
it("cannot import server modules on client", () => {
let error;
let result;
try {
result = require("./server/only").default;
} catch (expectedOnClient) {
error = expectedOnClient;
}
if (Meteor.isServer) {
assert.strictEqual(typeof error, "undefined");
assert.strictEqual(result, "/server/only.js");
assert.strictEqual(require("./server/only"),
require("/server/only"));
}
if (Meteor.isClient) {
assert.ok(error instanceof Error);
}
});
it("cannot import client modules on server", () => {
let error;
let result;
try {
result = require("./client/only").default;
} catch (expectedOnServer) {
error = expectedOnServer;
}
if (Meteor.isClient) {
assert.strictEqual(typeof error, "undefined");
assert.strictEqual(result, "/client/only.js");
assert.strictEqual(require("./client/only"),
require("/client/only"));
}
if (Meteor.isServer) {
assert.ok(error instanceof Error);
}
});
it("should not be parsed in strictMode", () => {
let foo = 1234;
delete foo;
});
it("should have access to filename and dirname", () => {
assert.strictEqual(require(__filename), exports);
assert.strictEqual(
require("path").relative(__dirname, __filename),
"tests.js"
);
});
});
describe("template modules", () => {
Meteor.isClient &&
it("should be importable on the client", () => {
assert.strictEqual(typeof Template, "function");
assert.ok(! _.has(Template, "lazy"));
require("./imports/lazy.html");
assert.ok(_.has(Template, "lazy"));
assert.ok(Template.lazy instanceof Template);
});
Meteor.isServer &&
it("should not be importable on the server", () => {
let error;
try {
require("./imports/lazy.html");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
});
Meteor.isClient &&
describe("css modules", () => {
it("should be loaded eagerly unless lazy", () => {
assert.strictEqual(
$(".app-eager-css").css("display"),
"none"
);
let error;
try {
require("./eager.css");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
it("should be importable by an app", () => {
assert.strictEqual(
$(".app-lazy-css").css("display"),
"block"
);
require("./imports/lazy.css");
assert.strictEqual(
$(".app-lazy-css").css("display"),
"none"
);
});
it("should be importable by a package", () => {
assert.strictEqual(
$(".pkg-lazy-css.imported").css("display"),
"none"
);
assert.strictEqual(
$(".pkg-lazy-css.not-imported").css("display"),
"block"
);
});
});
describe("native node_modules", () => {
Meteor.isServer &&
it("can be imported on the server", () => {
assert.strictEqual(typeof require("fs").readFile, "function");
});
Meteor.isClient &&
it("are imported as stubs on the client", () => {
const inherits = require("util").inherits;
assert.strictEqual(typeof inherits, "function");
assert.strictEqual(require("util"),
require("util/util.js"));
});
Meteor.isServer &&
it("cannot be overridden on the server", () => {
assert.strictEqual(typeof require("repl").start, "function");
});
Meteor.isClient &&
it("can be overridden on the client", () => {
assert.strictEqual(require("repl").notEmpty, true);
});
it("can be implemented by wrapper npm packages", () => {
const Stream = require("stream");
assert.strictEqual(typeof Stream, "function");
assert.strictEqual(typeof Stream.Readable, "function");
});
Meteor.isClient &&
it("can be installed with aliases", () => {
meteorInstall({
node_modules: {
http: "stream-http"
}
});
assert.strictEqual(require("http"), require("stream-http"));
});
});
describe("local node_modules", () => {
it("should be importable", () => {
assert.strictEqual(require("moment"), moment);
const cal = moment().calendar();
assert.ok(cal.match(/\bat\b/));
});
it("can be imported using absolute identifiers", () => {
assert.strictEqual(
require("moment"),
require("/node_modules/moment")
);
});
it("should be importable by packages", () => {
// Defined in packages/modules-test-package/common.js.
assert.strictEqual(typeof regeneratorRuntime, "object");
});
it('should expose "version" field of package.json', () => {
const pkg = require("moment/package.json");
assert.strictEqual(pkg.version, "2.11.1");
});
});
describe("Meteor packages", () => {
it("api.export should create named exports", () => {
assert.strictEqual(typeof ImportedMeteor, "object");
assert.strictEqual(Meteor, ImportedMeteor);
});
it("should be importable", () => {
assert.strictEqual(require("meteor/underscore")._, _);
const Blaze = require("meteor/blaze").Blaze;
assert.strictEqual(typeof Blaze, "object");
let error;
try {
require("meteor/nonexistent");
} catch (expected) {
error = expected;
}
assert.ok(error instanceof Error);
});
it("can be local", () => {
assert.strictEqual(ModulesTestPackage, "loaded");
const mtp = require("meteor/modules-test-package");
assert.strictEqual(mtp.where, Meteor.isServer ? "server" : "client");
});
it("should expose their files for import", () => {
const osStub = require("meteor/modules-test-package/os-stub");
assert.strictEqual(
osStub.platform(),
"browser"
);
assert.strictEqual(
osStub.name,
"/node_modules/meteor/modules-test-package/os-stub.js"
);
});
});
describe("JSX syntax", () => {
it("should work in .js files on both client and server", () => {
const React = {
createElement: function (name, attrs, children) {
assert.strictEqual(name, "div");
assert.strictEqual(attrs, null);
assert.strictEqual(children, "hi");
return "all good";
}
};
assert.strictEqual(<div>hi</div>, "all good");
});
});
describe("async functions", () => {
it("should work on the client and server", async () => {
assert.strictEqual(
await 2 + 2,
await new Promise(resolve => resolve(4))
);
});
});
Meteor.isClient &&
describe("client/compatibility directories", () => {
it("should contain bare files", () => {
assert.strictEqual(topLevelVariable, 1234);
});
});
describe(".es5.js files", () => {
it("should not be transpiled", () => {
assert.strictEqual(require("./imports/plain.es5.js").let, "ok");
});
});
describe("return statements at top level", () => {
it("should be legal", () => {
var ret = require("./imports/return.js");
assert.strictEqual(ret.a, 1234);
assert.strictEqual(ret.b, void 0);
});
});
describe("circular package.json resolution chains", () => {
it("should be broken appropriately", () => {
assert.strictEqual(
require("./lib").aMain,
"/lib/a/index.js"
);
});
});
| Test that #6312 was fixed by the recent Babel upgrade.
Closes #6312.
| tools/tests/apps/modules/tests.js | Test that #6312 was fixed by the recent Babel upgrade. | <ide><path>ools/tests/apps/modules/tests.js
<ide> });
<ide> });
<ide>
<del>describe("JSX syntax", () => {
<del> it("should work in .js files on both client and server", () => {
<add>describe("ecmascript miscellany", () => {
<add> it("JSX should work in .js files on both client and server", () => {
<ide> const React = {
<ide> createElement: function (name, attrs, children) {
<ide> assert.strictEqual(name, "div");
<ide>
<ide> assert.strictEqual(<div>hi</div>, "all good");
<ide> });
<del>});
<del>
<del>describe("async functions", () => {
<del> it("should work on the client and server", async () => {
<add>
<add> it("async functions should work on the client and server", async () => {
<ide> assert.strictEqual(
<ide> await 2 + 2,
<ide> await new Promise(resolve => resolve(4))
<ide> );
<add> });
<add>
<add> it("rest paramters in inner arrow functions (#6312)", () => {
<add> const rev = (...args) => args.reverse();
<add> assert.deepEqual(rev(1, 2, 3), [3, 2, 1]);
<add> assert.ok(rev.toString().match(/\barguments\b/));
<ide> });
<ide> });
<ide> |
|
Java | apache-2.0 | a8c4306ffe1a3e71f465a0120c35353fc8cca491 | 0 | apache/incubator-shardingsphere,leeyazhou/sharding-jdbc,apache/incubator-shardingsphere,leeyazhou/sharding-jdbc,leeyazhou/sharding-jdbc,apache/incubator-shardingsphere,leeyazhou/sharding-jdbc,apache/incubator-shardingsphere | /*
* Copyright 2016-2018 shardingsphere.io.
* <p>
* 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.
* </p>
*/
package io.shardingsphere.orchestration.internal.yaml.representer;
import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.nodes.CollectionNode;
import org.yaml.snakeyaml.nodes.MappingNode;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.NodeTuple;
import org.yaml.snakeyaml.nodes.ScalarNode;
import org.yaml.snakeyaml.nodes.SequenceNode;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.representer.Representer;
import java.util.Collection;
import java.util.HashSet;
/**
* Sharding configuration representer.
*
* @author panjuan
*/
public final class ShardingConfigurationRepresenter extends Representer {
private static Collection<String> eliminatedNodeNames = new HashSet<>();
static {
eliminatedNodeNames.add("configMap");
eliminatedNodeNames.add("props");
}
@Override
protected NodeTuple representJavaBeanProperty(final Object javaBean, final Property property, final Object propertyValue, final Tag customTag) {
NodeTuple tuple = super.representJavaBeanProperty(javaBean, property, propertyValue, customTag);
return isUnwantedNodeTuple(tuple) ? null : tuple;
}
private boolean isUnwantedNodeTuple(final NodeTuple tuple) {
return isEliminatedNode(tuple.getKeyNode()) || isNullNode(tuple.getValueNode()) || isEmptyCollectionNode(tuple.getValueNode());
}
private boolean isEliminatedNode(final Node keyNode) {
return keyNode instanceof ScalarNode && eliminatedNodeNames.contains(((ScalarNode) keyNode).getValue());
}
private boolean isNullNode(final Node valueNode) {
return Tag.NULL.equals(valueNode.getTag());
}
private boolean isEmptyCollectionNode(final Node valueNode) {
return valueNode instanceof CollectionNode && (isEmptySequenceNode(valueNode) || isEmptyMappingNode(valueNode));
}
private boolean isEmptySequenceNode(final Node valueNode) {
return Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty();
}
private boolean isEmptyMappingNode(final Node valueNode) {
return Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty();
}
}
| sharding-orchestration/sharding-orchestration-core/src/main/java/io/shardingsphere/orchestration/internal/yaml/representer/ShardingConfigurationRepresenter.java | /*
* Copyright 2016-2018 shardingsphere.io.
* <p>
* 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.
* </p>
*/
package io.shardingsphere.orchestration.internal.yaml.representer;
import org.yaml.snakeyaml.introspector.Property;
import org.yaml.snakeyaml.nodes.CollectionNode;
import org.yaml.snakeyaml.nodes.MappingNode;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.NodeTuple;
import org.yaml.snakeyaml.nodes.ScalarNode;
import org.yaml.snakeyaml.nodes.SequenceNode;
import org.yaml.snakeyaml.nodes.Tag;
import org.yaml.snakeyaml.representer.Representer;
import java.util.Collection;
import java.util.HashSet;
/**
* Sharding configuration representer.
*
* @author panjuan
*/
public final class ShardingConfigurationRepresenter extends Representer {
private static Collection<String> eliminatedNodeNames = new HashSet<>();
static {
eliminatedNodeNames.add("configMap");
eliminatedNodeNames.add("props");
}
@Override
protected NodeTuple representJavaBeanProperty(final Object javaBean, final Property property, final Object propertyValue, final Tag customTag) {
NodeTuple tuple = super.representJavaBeanProperty(javaBean, property, propertyValue, customTag);
Node valueNode = tuple.getValueNode();
Node keyNode = tuple.getKeyNode();
if (isEliminatedNode(keyNode)) {
return null;
}
if (Tag.NULL.equals(valueNode.getTag())) {
return null;
}
if (valueNode instanceof CollectionNode) {
if (Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty()) {
return null;
}
if (Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty()) {
return null;
}
}
return tuple;
}
private boolean isUnwantedNodeTuple(final NodeTuple tuple) {
}
private boolean isEliminatedNode(final Node keyNode) {
return keyNode instanceof ScalarNode && eliminatedNodeNames.contains(((ScalarNode) keyNode).getValue());
}
private boolean isNullNode(final Node valueNode) {
return Tag.NULL.equals(valueNode.getTag());
}
private boolean isEmptyCollectionNode(final Node valueNode) {
return valueNode instanceof CollectionNode && (isEmptySequenceNode(valueNode))
if (valueNode instanceof CollectionNode) {
return (Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty()) || (Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty());
}
return false;
}
private boolean isEmptySequenceNode(final Node valueNode) {
return Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty();
}
private boolean isEmptyMappingNode(final Node valueNode) {
return Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty();
}
}
| isUnwantedNodeTuple
| sharding-orchestration/sharding-orchestration-core/src/main/java/io/shardingsphere/orchestration/internal/yaml/representer/ShardingConfigurationRepresenter.java | isUnwantedNodeTuple | <ide><path>harding-orchestration/sharding-orchestration-core/src/main/java/io/shardingsphere/orchestration/internal/yaml/representer/ShardingConfigurationRepresenter.java
<ide> @Override
<ide> protected NodeTuple representJavaBeanProperty(final Object javaBean, final Property property, final Object propertyValue, final Tag customTag) {
<ide> NodeTuple tuple = super.representJavaBeanProperty(javaBean, property, propertyValue, customTag);
<del> Node valueNode = tuple.getValueNode();
<del> Node keyNode = tuple.getKeyNode();
<del> if (isEliminatedNode(keyNode)) {
<del> return null;
<del> }
<del> if (Tag.NULL.equals(valueNode.getTag())) {
<del> return null;
<del> }
<del> if (valueNode instanceof CollectionNode) {
<del> if (Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty()) {
<del> return null;
<del> }
<del> if (Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty()) {
<del> return null;
<del> }
<del> }
<del> return tuple;
<add> return isUnwantedNodeTuple(tuple) ? null : tuple;
<ide> }
<ide>
<ide> private boolean isUnwantedNodeTuple(final NodeTuple tuple) {
<del>
<add> return isEliminatedNode(tuple.getKeyNode()) || isNullNode(tuple.getValueNode()) || isEmptyCollectionNode(tuple.getValueNode());
<ide> }
<ide>
<ide> private boolean isEliminatedNode(final Node keyNode) {
<ide> }
<ide>
<ide> private boolean isEmptyCollectionNode(final Node valueNode) {
<del> return valueNode instanceof CollectionNode && (isEmptySequenceNode(valueNode))
<del> if (valueNode instanceof CollectionNode) {
<del> return (Tag.SEQ.equals(valueNode.getTag()) && ((SequenceNode) valueNode).getValue().isEmpty()) || (Tag.MAP.equals(valueNode.getTag()) && ((MappingNode) valueNode).getValue().isEmpty());
<del> }
<del> return false;
<add> return valueNode instanceof CollectionNode && (isEmptySequenceNode(valueNode) || isEmptyMappingNode(valueNode));
<ide> }
<ide>
<ide> private boolean isEmptySequenceNode(final Node valueNode) { |
|
Java | mit | 4a798d5e3e88fcbc60c7c2fdb3896e7ffd6c0f23 | 0 | mhcrnl/java-swing-tips,aterai/java-swing-tips,mhcrnl/java-swing-tips,mhcrnl/java-swing-tips,aoguren/java-swing-tips,aterai/java-swing-tips,aterai/java-swing-tips,aoguren/java-swing-tips,aterai/java-swing-tips,aoguren/java-swing-tips | package example;
//-*- mode:java; encoding:utf-8 -*-
// vim:set fileencoding=utf-8:
//@homepage@
import java.awt.*;
import java.awt.event.*;
import java.awt.image.*;
import java.beans.*;
import java.util.Arrays;
import java.util.List;
import javax.swing.*;
import javax.swing.plaf.LayerUI;
public final class MainPanel extends JPanel implements HierarchyListener {
private final BoundedRangeModel model = new DefaultBoundedRangeModel();
private final JProgressBar progress01 = new JProgressBar(model);
private final JProgressBar progress02 = new JProgressBar(model);
private final JProgressBar progress03 = new JProgressBar(model);
private final JProgressBar progress04 = new JProgressBar(model);
private final BlockedColorLayerUI layerUI = new BlockedColorLayerUI();
private final JPanel p = new JPanel(new GridLayout(2, 1));
private SwingWorker<String, Void> worker;
public MainPanel() {
super(new BorderLayout());
progress01.setStringPainted(true);
progress02.setStringPainted(true);
progress04.setOpaque(true); //for NimbusLookAndFeel
p.add(makeTitlePanel("setStringPainted(true)", Arrays.asList(progress01, progress02)));
p.add(makeTitlePanel("setStringPainted(false)", Arrays.asList(progress03, new JLayer<JProgressBar>(progress04, layerUI))));
Box box = Box.createHorizontalBox();
box.add(Box.createHorizontalGlue());
box.add(new JCheckBox(new AbstractAction("Turn the progress bar red") {
@Override public void actionPerformed(ActionEvent e) {
boolean b = ((JCheckBox) e.getSource()).isSelected();
progress02.setForeground(b ? new Color(255, 0, 0, 100) : progress01.getForeground());
layerUI.isPreventing = b;
p.repaint();
}
}));
box.add(Box.createHorizontalStrut(2));
box.add(new JButton(new AbstractAction("Start") {
@Override public void actionPerformed(ActionEvent e) {
if (worker != null && !worker.isDone()) {
worker.cancel(true);
}
worker = new Task();
worker.addPropertyChangeListener(new ProgressListener(progress01));
worker.execute();
}
}));
box.add(Box.createHorizontalStrut(2));
addHierarchyListener(this);
add(p);
add(box, BorderLayout.SOUTH);
setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
setPreferredSize(new Dimension(320, 240));
}
@Override public void hierarchyChanged(HierarchyEvent he) {
JComponent c = (JComponent) he.getComponent();
if ((he.getChangeFlags() & HierarchyEvent.DISPLAYABILITY_CHANGED) != 0 && !c.isDisplayable() && worker != null) {
System.out.println("DISPOSE_ON_CLOSE");
worker.cancel(true);
worker = null;
}
}
private JComponent makeTitlePanel(String title, List<? extends JComponent> list) {
JPanel p = new JPanel(new GridBagLayout());
p.setBorder(BorderFactory.createTitledBorder(title));
GridBagConstraints c = new GridBagConstraints();
c.fill = GridBagConstraints.HORIZONTAL;
c.insets = new Insets(5, 5, 5, 5);
c.weightx = 1d;
c.gridy = 0;
for (JComponent cmp: list) {
p.add(cmp, c);
c.gridy++;
}
return p;
}
public static void main(String... args) {
EventQueue.invokeLater(new Runnable() {
@Override public void run() {
createAndShowGUI();
}
});
}
public static void createAndShowGUI() {
try {
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (ClassNotFoundException | InstantiationException
| IllegalAccessException | UnsupportedLookAndFeelException ex) {
ex.printStackTrace();
}
JFrame frame = new JFrame("@title@");
frame.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
//frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
frame.getContentPane().add(new MainPanel());
frame.pack();
frame.setLocationRelativeTo(null);
frame.setVisible(true);
}
}
class BlockedColorLayerUI extends LayerUI<JProgressBar> {
public boolean isPreventing;
private transient BufferedImage bi;
private int prevw = -1;
private int prevh = -1;
@Override public void paint(Graphics g, JComponent c) {
if (isPreventing && c instanceof JLayer) {
JLayer jlayer = (JLayer) c;
JProgressBar progress = (JProgressBar) jlayer.getView();
int w = progress.getSize().width;
int h = progress.getSize().height;
if (bi == null || w != prevw || h != prevh) {
bi = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
}
prevw = w;
prevh = h;
Graphics2D g2 = bi.createGraphics();
super.paint(g2, c);
g2.dispose();
Image image = c.createImage(new FilteredImageSource(bi.getSource(), new RedGreenChannelSwapFilter()));
//BUG: cause an infinite repaint loop: g.drawImage(image, 0, 0, c);
g.drawImage(image, 0, 0, null);
} else {
super.paint(g, c);
}
}
}
class RedGreenChannelSwapFilter extends RGBImageFilter {
@Override public int filterRGB(int x, int y, int argb) {
int r = (int) ((argb >> 16) & 0xff);
int g = (int) ((argb >> 8) & 0xff);
int b = (int) ((argb) & 0xff);
return (argb & 0xff000000) | (g << 16) | (r << 8) | (b);
}
}
class Task extends SwingWorker<String, Void> {
@Override public String doInBackground() {
int current = 0;
int lengthOfTask = 100;
while (current <= lengthOfTask && !isCancelled()) {
try { // dummy task
Thread.sleep(50);
} catch (InterruptedException ie) {
return "Interrupted";
}
setProgress(100 * current / lengthOfTask);
current++;
}
return "Done";
}
}
class ProgressListener implements PropertyChangeListener {
private final JProgressBar progressBar;
ProgressListener(JProgressBar progressBar) {
this.progressBar = progressBar;
this.progressBar.setValue(0);
}
@Override public void propertyChange(PropertyChangeEvent evt) {
String strPropertyName = evt.getPropertyName();
if ("progress".equals(strPropertyName)) {
progressBar.setIndeterminate(false);
int progress = (Integer) evt.getNewValue();
progressBar.setValue(progress);
}
}
}
| ColorChannelSwapFilter/src/java/example/MainPanel.java | package example;
//-*- mode:java; encoding:utf-8 -*-
// vim:set fileencoding=utf-8:
//@homepage@
import java.awt.*;
import java.awt.event.*;
import java.awt.image.*;
import java.beans.*;
import java.util.Arrays;
import java.util.List;
import javax.swing.*;
import javax.swing.plaf.LayerUI;
public final class MainPanel extends JPanel implements HierarchyListener {
private final BoundedRangeModel model = new DefaultBoundedRangeModel();
private final JProgressBar progress01 = new JProgressBar(model);
private final JProgressBar progress02 = new JProgressBar(model);
private final JProgressBar progress03 = new JProgressBar(model);
private final JProgressBar progress04 = new JProgressBar(model);
private final BlockedColorLayerUI layerUI = new BlockedColorLayerUI();
private final JPanel p = new JPanel(new GridLayout(2, 1));
private SwingWorker<String, Void> worker;
public MainPanel() {
super(new BorderLayout());
progress01.setStringPainted(true);
progress02.setStringPainted(true);
progress04.setOpaque(true); //for NimbusLookAndFeel
p.add(makeTitlePanel("setStringPainted(true)", Arrays.asList(progress01, progress02)));
p.add(makeTitlePanel("setStringPainted(false)", Arrays.asList(progress03, new JLayer<JProgressBar>(progress04, layerUI))));
Box box = Box.createHorizontalBox();
box.add(Box.createHorizontalGlue());
box.add(new JCheckBox(new AbstractAction("Turn the progress bar red") {
@Override public void actionPerformed(ActionEvent e) {
boolean b = ((JCheckBox) e.getSource()).isSelected();
progress02.setForeground(b ? new Color(255, 0, 0, 100) : progress01.getForeground());
layerUI.isPreventing = b;
p.repaint();
}
}));
box.add(Box.createHorizontalStrut(2));
box.add(new JButton(new AbstractAction("Start") {
@Override public void actionPerformed(ActionEvent e) {
if (worker != null && !worker.isDone()) {
worker.cancel(true);
}
worker = new Task();
worker.addPropertyChangeListener(new ProgressListener(progress01));
worker.execute();
}
}));
box.add(Box.createHorizontalStrut(2));
addHierarchyListener(this);
add(p);
add(box, BorderLayout.SOUTH);
setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));
setPreferredSize(new Dimension(320, 240));
}
@Override public void hierarchyChanged(HierarchyEvent he) {
JComponent c = (JComponent) he.getComponent();
if ((he.getChangeFlags() & HierarchyEvent.DISPLAYABILITY_CHANGED) != 0 && !c.isDisplayable() && worker != null) {
System.out.println("DISPOSE_ON_CLOSE");
worker.cancel(true);
worker = null;
}
}
private JComponent makeTitlePanel(String title, List<? extends JComponent> list) {
JPanel p = new JPanel(new GridBagLayout());
p.setBorder(BorderFactory.createTitledBorder(title));
GridBagConstraints c = new GridBagConstraints();
c.fill = GridBagConstraints.HORIZONTAL;
c.insets = new Insets(5, 5, 5, 5);
c.weightx = 1d;
c.gridy = 0;
for (JComponent cmp: list) {
p.add(cmp, c);
c.gridy++;
}
return p;
}
public static void main(String... args) {
EventQueue.invokeLater(new Runnable() {
@Override public void run() {
createAndShowGUI();
}
});
}
public static void createAndShowGUI() {
try {
UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
} catch (ClassNotFoundException | InstantiationException
| IllegalAccessException | UnsupportedLookAndFeelException ex) {
ex.printStackTrace();
}
JFrame frame = new JFrame("@title@");
frame.setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);
//frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
frame.getContentPane().add(new MainPanel());
frame.pack();
frame.setLocationRelativeTo(null);
frame.setVisible(true);
}
}
class BlockedColorLayerUI extends LayerUI<JProgressBar> {
public boolean isPreventing;
private transient BufferedImage bi;
private int prevw = -1;
private int prevh = -1;
@Override public void paint(Graphics g, JComponent c) {
if (isPreventing && c instanceof JLayer) {
JLayer jlayer = (JLayer) c;
JProgressBar progress = (JProgressBar) jlayer.getView();
int w = progress.getSize().width;
int h = progress.getSize().height;
if (bi == null || w != prevw || h != prevh) {
bi = new BufferedImage(w, h, BufferedImage.TYPE_INT_ARGB);
}
prevw = w;
prevh = h;
Graphics2D g2 = bi.createGraphics();
super.paint(g2, c);
g2.dispose();
Image image = c.createImage(new FilteredImageSource(bi.getSource(), new RedGreenChannelSwapFilter()));
g.drawImage(image, 0, 0, c);
} else {
super.paint(g, c);
}
}
}
class RedGreenChannelSwapFilter extends RGBImageFilter {
@Override public int filterRGB(int x, int y, int argb) {
int r = (int) ((argb >> 16) & 0xff);
int g = (int) ((argb >> 8) & 0xff);
int b = (int) ((argb) & 0xff);
return (argb & 0xff000000) | (g << 16) | (r << 8) | (b);
}
}
class Task extends SwingWorker<String, Void> {
@Override public String doInBackground() {
int current = 0;
int lengthOfTask = 100;
while (current <= lengthOfTask && !isCancelled()) {
try { // dummy task
Thread.sleep(50);
} catch (InterruptedException ie) {
return "Interrupted";
}
setProgress(100 * current / lengthOfTask);
current++;
}
return "Done";
}
}
class ProgressListener implements PropertyChangeListener {
private final JProgressBar progressBar;
ProgressListener(JProgressBar progressBar) {
this.progressBar = progressBar;
this.progressBar.setValue(0);
}
@Override public void propertyChange(PropertyChangeEvent evt) {
String strPropertyName = evt.getPropertyName();
if ("progress".equals(strPropertyName)) {
progressBar.setIndeterminate(false);
int progress = (Integer) evt.getNewValue();
progressBar.setValue(progress);
}
}
}
| fix: an infinite repaint loop
| ColorChannelSwapFilter/src/java/example/MainPanel.java | fix: an infinite repaint loop | <ide><path>olorChannelSwapFilter/src/java/example/MainPanel.java
<ide> g2.dispose();
<ide>
<ide> Image image = c.createImage(new FilteredImageSource(bi.getSource(), new RedGreenChannelSwapFilter()));
<del> g.drawImage(image, 0, 0, c);
<add> //BUG: cause an infinite repaint loop: g.drawImage(image, 0, 0, c);
<add> g.drawImage(image, 0, 0, null);
<ide> } else {
<ide> super.paint(g, c);
<ide> } |
|
Java | mit | error: pathspec 'Java/TopCoder/BettingMoney.java' did not match any file(s) known to git
| aee40deb03b7c5de336eb255e607027c3aa1f905 | 1 | dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey,dvt32/cpp-journey | // https://community.topcoder.com/stat?c=problem_statement&pm=2297
public class BettingMoney {
public static int moneyMade(int[] amounts, int[] centsPerDollar, int finalResult) {
int moneyMade = 0;
for (int margin = 0; margin < amounts.length; ++margin) {
if (margin == finalResult) {
moneyMade -= amounts[margin] * centsPerDollar[margin];
}
else {
moneyMade += amounts[margin] * 100;
}
}
return moneyMade;
}
}
| Java/TopCoder/BettingMoney.java | Create BettingMoney.java | Java/TopCoder/BettingMoney.java | Create BettingMoney.java | <ide><path>ava/TopCoder/BettingMoney.java
<add>// https://community.topcoder.com/stat?c=problem_statement&pm=2297
<add>
<add>public class BettingMoney {
<add> public static int moneyMade(int[] amounts, int[] centsPerDollar, int finalResult) {
<add> int moneyMade = 0;
<add>
<add> for (int margin = 0; margin < amounts.length; ++margin) {
<add> if (margin == finalResult) {
<add> moneyMade -= amounts[margin] * centsPerDollar[margin];
<add> }
<add> else {
<add> moneyMade += amounts[margin] * 100;
<add> }
<add> }
<add>
<add> return moneyMade;
<add> }
<add>} |
|
Java | mit | 73aefba9cdddec1699202b65fcc5c95ae6ed4e06 | 0 | JCThePants/NucleusFramework,JCThePants/NucleusFramework | /*
* This file is part of GenericsLib for Bukkit, licensed under the MIT License (MIT).
*
* Copyright (c) JCThePants (www.jcwhatever.com)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.jcwhatever.bukkit.generic.regions;
import com.jcwhatever.bukkit.generic.GenericsLib;
import com.jcwhatever.bukkit.generic.collections.EntryCounter;
import com.jcwhatever.bukkit.generic.collections.EntryCounter.RemovalPolicy;
import com.jcwhatever.bukkit.generic.messaging.Messenger;
import com.jcwhatever.bukkit.generic.player.collections.PlayerMap;
import com.jcwhatever.bukkit.generic.utils.PreCon;
import com.jcwhatever.bukkit.generic.utils.Scheduler;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
/**
* Global Region Manager
*/
public class RegionManager {
// Player watcher regions chunk map. String key is chunk coordinates
private final Map<String, Set<ReadOnlyRegion>> _listenerRegionsMap = new HashMap<>(500);
// All regions chunk map. String key is chunk coordinates
private final Map<String, Set<ReadOnlyRegion>> _allRegionsMap = new HashMap<>(500);
// worlds that have regions
private EntryCounter<World> _listenerWorlds = new EntryCounter<>(RemovalPolicy.REMOVE);
// cached regions the player was detected in in last player watcher cycle.
private Map<UUID, Set<ReadOnlyRegion>> _playerCacheMap;
// locations the player was detected in between player watcher cycles.
private Map<UUID, LinkedList<Location>> _playerLocationCache;
// hash set of all registered regions
private Set<ReadOnlyRegion> _regions = new HashSet<>(500);
// synchronization object
private final Object _sync = new Object();
/**
* Constructor. Used by GenericsLib to initialize RegionEventManager.
*
* <p>Not meant for public instantiation. For internal use only.</p>
*/
public RegionManager(Plugin plugin) {
if (!(plugin instanceof GenericsLib)) {
throw new RuntimeException("RegionManager is for GenericsLib internal use only.");
}
_playerCacheMap = new PlayerMap<>(plugin);
_playerLocationCache = new PlayerMap<>(plugin);
PlayerWatcher _playerWatcher = new PlayerWatcher();
Scheduler.runTaskRepeat(plugin, 3, 3, _playerWatcher);
}
/**
* Get number of regions registered.
*/
public int getRegionCount() {
return _regions.size();
}
/**
* Get a set of regions that contain the specified location.
*
* @param location The location to check.
*/
public Set<ReadOnlyRegion> getRegions(Location location) {
PreCon.notNull(location);
return getRegion(location, _allRegionsMap);
}
/**
* Get a set of regions that the specified location
* is inside of and are player watchers/listeners.
*
* @param location The location to check.
*/
public Set<ReadOnlyRegion> getListenerRegions(Location location) {
return getRegion(location, _listenerRegionsMap);
}
/**
* Get all regions that intersect with the specified chunk.
*
* @param chunk The chunk to check.
*/
public Set<ReadOnlyRegion> getRegionsInChunk(Chunk chunk) {
synchronized(_sync) {
if (getRegionCount() == 0)
return new HashSet<>(0);
String key = getChunkKey(chunk.getWorld(), chunk.getX(), chunk.getZ());
Set<ReadOnlyRegion> regions = _allRegionsMap.get(key);
if (regions == null)
return new HashSet<>(0);
_sync.notifyAll();
return new HashSet<>(regions);
}
}
/**
* Get all regions that player is currently in.
*
* @param p The player to check.
*/
public List<ReadOnlyRegion> getPlayerRegions(Player p) {
PreCon.notNull(p);
if (_playerCacheMap == null)
return new ArrayList<ReadOnlyRegion>(0);
synchronized(_sync) {
Set<ReadOnlyRegion> regions = _playerCacheMap.get(p.getUniqueId());
if (regions == null)
return new ArrayList<>(0);
_sync.notifyAll();
return new ArrayList<>(regions);
}
}
/**
* Add a location that the player has moved to so it can be
* cached and processed by the player watcher the next time it
* runs.
*
* @param p The player.
* @param location The location to cache.
*/
public void updatePlayerLocation(Player p, Location location) {
PreCon.notNull(p);
PreCon.notNull(location);
if (!_listenerWorlds.contains(location.getWorld()))
return;
// ignore NPC's
if (p.hasMetadata("NPC"))
return;
LinkedList<Location> locations = getPlayerLocations(p.getUniqueId());
locations.add(location);
}
/**
* Causes a region to re-fire the onPlayerEnter event
* if the player is already in it
* .
* @param p The player.
* @param region The region.
*/
public void resetPlayerRegion(Player p, Region region) {
PreCon.notNull(p);
PreCon.notNull(region);
if (_playerCacheMap == null)
return;
synchronized(_sync) {
Set<ReadOnlyRegion> regions = _playerCacheMap.get(p.getUniqueId());
if (regions == null)
return;
regions.remove(new ReadOnlyRegion(region));
_sync.notifyAll();
}
}
/*
* Get all regions contained in the specified location using
* the supplied region map.
*/
private Set<ReadOnlyRegion> getRegion(Location location, Map<String, Set<ReadOnlyRegion>> map) {
synchronized(_sync) {
Set<ReadOnlyRegion> results = new HashSet<>(10);
if (getRegionCount() == 0)
return results;
// calculate chunk location instead of getting it from chunk
// to prevent asynchronous issues
int chunkX = (int)Math.floor(location.getX() / 16);
int chunkZ = (int)Math.floor(location.getZ() / 16);
String key = getChunkKey(location.getWorld(), chunkX, chunkZ);
Set<ReadOnlyRegion> regions = map.get(key);
if (regions == null)
return results;
for (ReadOnlyRegion region : regions) {
if (region.contains(location))
results.add(region);
}
_sync.notifyAll();
return results;
}
}
/**
* Register a region so it can be found in searches
* and its events called if it is a player watcher.
*
* @param region The Region to register.
*/
void register(Region region) {
PreCon.notNull(region);
if (!region.isDefined()) {
Messenger.debug(GenericsLib.getLib(),
"Failed to register region '{0}' with RegionManager because " +
"it's coords are undefined.", region.getName());
return;
}
ReadOnlyRegion readOnlyRegion = new ReadOnlyRegion(region);
_regions.add(readOnlyRegion);
synchronized(_sync) {
int xMax = region.getChunkX() + region.getChunkXWidth();
int zMax = region.getChunkZ() + region.getChunkZWidth();
boolean hasRegion = false;
for (int x= region.getChunkX(); x < xMax; x++) {
for (int z= region.getChunkZ(); z < zMax; z++) {
//noinspection ConstantConditions
String key = getChunkKey(region.getWorld(), x, z);
if (region.isPlayerWatcher()) {
addToMap(_listenerRegionsMap, key, readOnlyRegion);
}
else {
hasRegion = removeFromMap(_listenerRegionsMap, key, readOnlyRegion);
}
addToMap(_allRegionsMap, key, readOnlyRegion);
}
}
if (region.isPlayerWatcher()) {
//noinspection ConstantConditions
_listenerWorlds.add(region.getWorld());
}
else if (hasRegion){
//noinspection ConstantConditions
_listenerWorlds.subtract(region.getWorld());
}
_sync.notifyAll();
}
}
/**
* Unregister a region and its events completely.
*
* <p>Called when a region is disposed.</p>
*
* @param region The Region to unregister.
*/
void unregister(Region region) {
PreCon.notNull(region);
if (!region.isDefined())
return;
ReadOnlyRegion readOnlyRegion = new ReadOnlyRegion(region);
synchronized(_sync) {
int xMax = region.getChunkX() + region.getChunkXWidth();
int zMax = region.getChunkZ() + region.getChunkZWidth();
for (int x= region.getChunkX(); x < xMax; x++) {
for (int z= region.getChunkZ(); z < zMax; z++) {
//noinspection ConstantConditions
String key = getChunkKey(region.getWorld(), x, z);
removeFromMap(_listenerRegionsMap, key, readOnlyRegion);
removeFromMap(_allRegionsMap, key, readOnlyRegion);
}
}
if (_regions.remove(readOnlyRegion) && region.isPlayerWatcher()) {
//noinspection ConstantConditions
_listenerWorlds.subtract(region.getWorld());
}
_sync.notifyAll();
}
}
/*
* Get the cached movement locations of a player that have not been processed
* by the PlayerWatcher task yet.
*/
private LinkedList<Location> getPlayerLocations(UUID playerId) {
LinkedList<Location> locations = _playerLocationCache.get(playerId);
if (locations == null) {
locations = new LinkedList<Location>();
_playerLocationCache.put(playerId, locations);
}
return locations;
}
/*
* Clear cached movement locations of a player
*/
private void clearPlayerLocations(UUID playerId) {
LinkedList<Location> locations = getPlayerLocations(playerId);
locations.clear();
}
/*
* Executes doPlayerLeave method in the specified region on the main thread.
*/
private void onPlayerLeave(final Region region, final Player p) {
Scheduler.runTaskSync(GenericsLib.getLib(), new Runnable() {
@Override
public void run() {
region.doPlayerLeave(p);
}
});
}
/*
* Executes doPlayerEnter method in the specified region on the main thread.
*/
private void onPlayerEnter(final Region region, final Player p) {
Scheduler.runTaskSync(GenericsLib.getLib(), new Runnable() {
@Override
public void run() {
region.doPlayerEnter(p);
}
});
}
/*
* Add a region to a region map.
*/
private void addToMap(Map<String, Set<ReadOnlyRegion>> map, String key, ReadOnlyRegion region) {
Set<ReadOnlyRegion> regions = map.get(key);
if (regions == null) {
regions = new HashSet<>(10);
map.put(key, regions);
}
regions.add(region);
}
/*
* Remove a region from a region map.
*/
private boolean removeFromMap(Map<String, Set<ReadOnlyRegion>> map, String key, ReadOnlyRegion region) {
Set<ReadOnlyRegion> regions = map.get(key);
return regions != null && regions.remove(region);
}
/*
* Get a regions chunk map key.
*/
private String getChunkKey(World world, int x, int z) {
return world.getName() + '.' + String.valueOf(x) + '.' + String.valueOf(z);
}
/*
* Repeating task that determines which regions need events fired.
*/
private final class PlayerWatcher implements Runnable {
@Override
public void run() {
List<World> worlds = new ArrayList<World>(_listenerWorlds.getEntries());
final List<WorldPlayers> worldPlayers = new ArrayList<WorldPlayers>(worlds.size());
// get players in worlds with regions
for (World world : worlds) {
if (world == null)
continue;
List<Player> players = world.getPlayers();
if (players == null || players.isEmpty())
continue;
worldPlayers.add(new WorldPlayers(world, players));
}
// end if there are no players in region worlds
if (worldPlayers.isEmpty())
return;
Scheduler.runTaskLaterAsync(GenericsLib.getLib(), 1, new Runnable() {
@Override
public void run() {
for (WorldPlayers wp : worldPlayers) {
synchronized (_sync) {
// get players in world
List<WorldPlayer> worldPlayers = wp.players;
// iterate players
for (WorldPlayer worldPlayer : worldPlayers) {
UUID playerId = worldPlayer.player.getUniqueId();
// get regions the player is in (cached from previous check)
Set<ReadOnlyRegion> cachedRegions = _playerCacheMap.get(playerId);
if (cachedRegions == null) {
cachedRegions = new HashSet<>(10);
_playerCacheMap.put(playerId, cachedRegions);
}
// iterate cached locations
while (!worldPlayer.locations.isEmpty()) {
Location location = worldPlayer.locations.removeFirst();
// see which regions a player actually is in
Set<ReadOnlyRegion> inRegions = getListenerRegions(location);
// check for entered regions
if (inRegions != null && !inRegions.isEmpty()) {
for (ReadOnlyRegion region : inRegions) {
if (!cachedRegions.contains(region)) {
onPlayerEnter(region.getHandle(), worldPlayer.player);
cachedRegions.add(region);
}
}
}
// check for regions player has left
if (!cachedRegions.isEmpty()) {
Iterator<ReadOnlyRegion> iterator = cachedRegions.iterator();
while(iterator.hasNext()) {
ReadOnlyRegion region = iterator.next();
if (inRegions == null || !inRegions.contains(region)) {
onPlayerLeave(region.getHandle(), worldPlayer.player);
iterator.remove();
}
}
}
}
} // END for (Player
_sync.notifyAll();
} // END synchronized
} // END for (WorldPlayers
} // END run()
});
}
}
/*
* Stores a collection of players that are in a world.
*/
private class WorldPlayers {
public final World world;
public final List<WorldPlayer> players;
public WorldPlayers (World world, List<Player> players) {
this.world = world;
List<WorldPlayer> worldPlayers = new ArrayList<WorldPlayer>(players.size());
for (Player p : players) {
LinkedList<Location> locations = getPlayerLocations(p.getUniqueId());
if (locations.isEmpty())
continue;
WorldPlayer worldPlayer = new WorldPlayer(p, new LinkedList<Location>(locations));
worldPlayers.add(worldPlayer);
clearPlayerLocations(p.getUniqueId());
}
this.players = worldPlayers;
}
}
/**
* Represents a player and the locations they have been
* since the last player watcher update.
*/
private static class WorldPlayer {
public final Player player;
public final LinkedList<Location> locations;
public WorldPlayer(Player p, LinkedList<Location> locations) {
this.player = p;
this.locations = locations;
}
}
}
| src/com/jcwhatever/bukkit/generic/regions/RegionManager.java | /*
* This file is part of GenericsLib for Bukkit, licensed under the MIT License (MIT).
*
* Copyright (c) JCThePants (www.jcwhatever.com)
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package com.jcwhatever.bukkit.generic.regions;
import com.jcwhatever.bukkit.generic.GenericsLib;
import com.jcwhatever.bukkit.generic.collections.EntryCounter;
import com.jcwhatever.bukkit.generic.collections.EntryCounter.RemovalPolicy;
import com.jcwhatever.bukkit.generic.messaging.Messenger;
import com.jcwhatever.bukkit.generic.player.collections.PlayerMap;
import com.jcwhatever.bukkit.generic.utils.PreCon;
import com.jcwhatever.bukkit.generic.utils.Scheduler;
import org.bukkit.Chunk;
import org.bukkit.Location;
import org.bukkit.World;
import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
/**
* Global Region Manager
*/
public class RegionManager {
// Player watcher regions chunk map. String key is chunk coordinates
private final Map<String, Set<ReadOnlyRegion>> _listenerRegionsMap = new HashMap<>(500);
// All regions chunk map. String key is chunk coordinates
private final Map<String, Set<ReadOnlyRegion>> _allRegionsMap = new HashMap<>(500);
// worlds that have regions
private EntryCounter<World> _listenerWorlds = new EntryCounter<>(RemovalPolicy.REMOVE);
// cached regions the player was detected in in last player watcher cycle.
private Map<UUID, Set<ReadOnlyRegion>> _playerCacheMap;
// locations the player was detected in between player watcher cycles.
private Map<UUID, LinkedList<Location>> _playerLocationCache;
// hash set of all registered regions
private Set<ReadOnlyRegion> _regions = new HashSet<>(500);
// synchronization object
private final Object _sync = new Object();
/**
* Constructor. Used by GenericsLib to initialize RegionEventManager.
*
* <p>Not meant for public instantiation. For internal use only.</p>
*/
public RegionManager(Plugin plugin) {
if (!(plugin instanceof GenericsLib)) {
throw new RuntimeException("RegionManager is for GenericsLib internal use only.");
}
_playerCacheMap = new PlayerMap<>(plugin);
_playerLocationCache = new PlayerMap<>(plugin);
PlayerWatcher _playerWatcher = new PlayerWatcher();
Scheduler.runTaskRepeat(plugin, 7, 7, _playerWatcher);
}
/**
* Get number of regions registered.
*/
public int getRegionCount() {
return _regions.size();
}
/**
* Get a set of regions that contain the specified location.
*
* @param location The location to check.
*/
public Set<ReadOnlyRegion> getRegions(Location location) {
PreCon.notNull(location);
return getRegion(location, _allRegionsMap);
}
/**
* Get a set of regions that the specified location
* is inside of and are player watchers/listeners.
*
* @param location The location to check.
*/
public Set<ReadOnlyRegion> getListenerRegions(Location location) {
return getRegion(location, _listenerRegionsMap);
}
/**
* Get all regions that intersect with the specified chunk.
*
* @param chunk The chunk to check.
*/
public Set<ReadOnlyRegion> getRegionsInChunk(Chunk chunk) {
synchronized(_sync) {
if (getRegionCount() == 0)
return new HashSet<>(0);
String key = getChunkKey(chunk.getWorld(), chunk.getX(), chunk.getZ());
Set<ReadOnlyRegion> regions = _allRegionsMap.get(key);
if (regions == null)
return new HashSet<>(0);
_sync.notifyAll();
return new HashSet<>(regions);
}
}
/**
* Get all regions that player is currently in.
*
* @param p The player to check.
*/
public List<ReadOnlyRegion> getPlayerRegions(Player p) {
PreCon.notNull(p);
if (_playerCacheMap == null)
return new ArrayList<ReadOnlyRegion>(0);
synchronized(_sync) {
Set<ReadOnlyRegion> regions = _playerCacheMap.get(p.getUniqueId());
if (regions == null)
return new ArrayList<>(0);
_sync.notifyAll();
return new ArrayList<>(regions);
}
}
/**
* Add a location that the player has moved to so it can be
* cached and processed by the player watcher the next time it
* runs.
*
* @param p The player.
* @param location The location to cache.
*/
public void updatePlayerLocation(Player p, Location location) {
PreCon.notNull(p);
PreCon.notNull(location);
if (!_listenerWorlds.contains(location.getWorld()))
return;
// ignore NPC's
if (p.hasMetadata("NPC"))
return;
LinkedList<Location> locations = getPlayerLocations(p.getUniqueId());
locations.add(location);
}
/**
* Causes a region to re-fire the onPlayerEnter event
* if the player is already in it
* .
* @param p The player.
* @param region The region.
*/
public void resetPlayerRegion(Player p, Region region) {
PreCon.notNull(p);
PreCon.notNull(region);
if (_playerCacheMap == null)
return;
synchronized(_sync) {
Set<ReadOnlyRegion> regions = _playerCacheMap.get(p.getUniqueId());
if (regions == null)
return;
regions.remove(new ReadOnlyRegion(region));
_sync.notifyAll();
}
}
/*
* Get all regions contained in the specified location using
* the supplied region map.
*/
private Set<ReadOnlyRegion> getRegion(Location location, Map<String, Set<ReadOnlyRegion>> map) {
synchronized(_sync) {
Set<ReadOnlyRegion> results = new HashSet<>(10);
if (getRegionCount() == 0)
return results;
// calculate chunk location instead of getting it from chunk
// to prevent asynchronous issues
int chunkX = (int)Math.floor(location.getX() / 16);
int chunkZ = (int)Math.floor(location.getZ() / 16);
String key = getChunkKey(location.getWorld(), chunkX, chunkZ);
Set<ReadOnlyRegion> regions = map.get(key);
if (regions == null)
return results;
for (ReadOnlyRegion region : regions) {
if (region.contains(location))
results.add(region);
}
_sync.notifyAll();
return results;
}
}
/**
* Register a region so it can be found in searches
* and its events called if it is a player watcher.
*
* @param region The Region to register.
*/
void register(Region region) {
PreCon.notNull(region);
if (!region.isDefined()) {
Messenger.debug(GenericsLib.getLib(),
"Failed to register region '{0}' with RegionManager because " +
"it's coords are undefined.", region.getName());
return;
}
ReadOnlyRegion readOnlyRegion = new ReadOnlyRegion(region);
_regions.add(readOnlyRegion);
synchronized(_sync) {
int xMax = region.getChunkX() + region.getChunkXWidth();
int zMax = region.getChunkZ() + region.getChunkZWidth();
boolean hasRegion = false;
for (int x= region.getChunkX(); x < xMax; x++) {
for (int z= region.getChunkZ(); z < zMax; z++) {
//noinspection ConstantConditions
String key = getChunkKey(region.getWorld(), x, z);
if (region.isPlayerWatcher()) {
addToMap(_listenerRegionsMap, key, readOnlyRegion);
}
else {
hasRegion = removeFromMap(_listenerRegionsMap, key, readOnlyRegion);
}
addToMap(_allRegionsMap, key, readOnlyRegion);
}
}
if (region.isPlayerWatcher()) {
//noinspection ConstantConditions
_listenerWorlds.add(region.getWorld());
}
else if (hasRegion){
//noinspection ConstantConditions
_listenerWorlds.subtract(region.getWorld());
}
_sync.notifyAll();
}
}
/**
* Unregister a region and its events completely.
*
* <p>Called when a region is disposed.</p>
*
* @param region The Region to unregister.
*/
void unregister(Region region) {
PreCon.notNull(region);
if (!region.isDefined())
return;
ReadOnlyRegion readOnlyRegion = new ReadOnlyRegion(region);
synchronized(_sync) {
int xMax = region.getChunkX() + region.getChunkXWidth();
int zMax = region.getChunkZ() + region.getChunkZWidth();
for (int x= region.getChunkX(); x < xMax; x++) {
for (int z= region.getChunkZ(); z < zMax; z++) {
//noinspection ConstantConditions
String key = getChunkKey(region.getWorld(), x, z);
removeFromMap(_listenerRegionsMap, key, readOnlyRegion);
removeFromMap(_allRegionsMap, key, readOnlyRegion);
}
}
if (_regions.remove(readOnlyRegion) && region.isPlayerWatcher()) {
//noinspection ConstantConditions
_listenerWorlds.subtract(region.getWorld());
}
_sync.notifyAll();
}
}
/*
* Get the cached movement locations of a player that have not been processed
* by the PlayerWatcher task yet.
*/
private LinkedList<Location> getPlayerLocations(UUID playerId) {
LinkedList<Location> locations = _playerLocationCache.get(playerId);
if (locations == null) {
locations = new LinkedList<Location>();
_playerLocationCache.put(playerId, locations);
}
return locations;
}
/*
* Clear cached movement locations of a player
*/
private void clearPlayerLocations(UUID playerId) {
LinkedList<Location> locations = getPlayerLocations(playerId);
locations.clear();
}
/*
* Executes doPlayerLeave method in the specified region on the main thread.
*/
private void onPlayerLeave(final Region region, final Player p) {
Scheduler.runTaskSync(GenericsLib.getLib(), new Runnable() {
@Override
public void run() {
region.doPlayerLeave(p);
}
});
}
/*
* Executes doPlayerEnter method in the specified region on the main thread.
*/
private void onPlayerEnter(final Region region, final Player p) {
Scheduler.runTaskSync(GenericsLib.getLib(), new Runnable() {
@Override
public void run() {
region.doPlayerEnter(p);
}
});
}
/*
* Add a region to a region map.
*/
private void addToMap(Map<String, Set<ReadOnlyRegion>> map, String key, ReadOnlyRegion region) {
Set<ReadOnlyRegion> regions = map.get(key);
if (regions == null) {
regions = new HashSet<>(10);
map.put(key, regions);
}
regions.add(region);
}
/*
* Remove a region from a region map.
*/
private boolean removeFromMap(Map<String, Set<ReadOnlyRegion>> map, String key, ReadOnlyRegion region) {
Set<ReadOnlyRegion> regions = map.get(key);
return regions != null && regions.remove(region);
}
/*
* Get a regions chunk map key.
*/
private String getChunkKey(World world, int x, int z) {
return world.getName() + '.' + String.valueOf(x) + '.' + String.valueOf(z);
}
/*
* Repeating task that determines which regions need events fired.
*/
private final class PlayerWatcher implements Runnable {
@Override
public void run() {
List<World> worlds = new ArrayList<World>(_listenerWorlds.getEntries());
final List<WorldPlayers> worldPlayers = new ArrayList<WorldPlayers>(worlds.size());
// get players in worlds with regions
for (World world : worlds) {
if (world == null)
continue;
List<Player> players = world.getPlayers();
if (players == null || players.isEmpty())
continue;
worldPlayers.add(new WorldPlayers(world, players));
}
// end if there are no players in region worlds
if (worldPlayers.isEmpty())
return;
Scheduler.runTaskLaterAsync(GenericsLib.getLib(), 1, new Runnable() {
@Override
public void run() {
for (WorldPlayers wp : worldPlayers) {
synchronized (_sync) {
// get players in world
List<WorldPlayer> worldPlayers = wp.players;
// iterate players
for (WorldPlayer worldPlayer : worldPlayers) {
UUID playerId = worldPlayer.player.getUniqueId();
// get regions the player is in (cached from previous check)
Set<ReadOnlyRegion> cachedRegions = _playerCacheMap.get(playerId);
if (cachedRegions == null) {
cachedRegions = new HashSet<>(10);
_playerCacheMap.put(playerId, cachedRegions);
}
// iterate cached locations
while (!worldPlayer.locations.isEmpty()) {
Location location = worldPlayer.locations.removeFirst();
// see which regions a player actually is in
Set<ReadOnlyRegion> inRegions = getListenerRegions(location);
// check for entered regions
if (inRegions != null && !inRegions.isEmpty()) {
for (ReadOnlyRegion region : inRegions) {
if (!cachedRegions.contains(region)) {
onPlayerEnter(region.getHandle(), worldPlayer.player);
cachedRegions.add(region);
}
}
}
// check for regions player has left
if (!cachedRegions.isEmpty()) {
Iterator<ReadOnlyRegion> iterator = cachedRegions.iterator();
while(iterator.hasNext()) {
ReadOnlyRegion region = iterator.next();
if (inRegions == null || !inRegions.contains(region)) {
onPlayerLeave(region.getHandle(), worldPlayer.player);
iterator.remove();
}
}
}
}
} // END for (Player
_sync.notifyAll();
} // END synchronized
} // END for (WorldPlayers
} // END run()
});
}
}
/*
* Stores a collection of players that are in a world.
*/
private class WorldPlayers {
public final World world;
public final List<WorldPlayer> players;
public WorldPlayers (World world, List<Player> players) {
this.world = world;
List<WorldPlayer> worldPlayers = new ArrayList<WorldPlayer>(players.size());
for (Player p : players) {
LinkedList<Location> locations = getPlayerLocations(p.getUniqueId());
if (locations.isEmpty())
continue;
WorldPlayer worldPlayer = new WorldPlayer(p, new LinkedList<Location>(locations));
worldPlayers.add(worldPlayer);
clearPlayerLocations(p.getUniqueId());
}
this.players = worldPlayers;
}
}
/**
* Represents a player and the locations they have been
* since the last player watcher update.
*/
private static class WorldPlayer {
public final Player player;
public final LinkedList<Location> locations;
public WorldPlayer(Player p, LinkedList<Location> locations) {
this.player = p;
this.locations = locations;
}
}
}
| reduce watcher interval (from 7 ticks to 3) to prevent buildup of locations to process (increases performance according to timings)
| src/com/jcwhatever/bukkit/generic/regions/RegionManager.java | reduce watcher interval (from 7 ticks to 3) to prevent buildup of locations to process (increases performance according to timings) | <ide><path>rc/com/jcwhatever/bukkit/generic/regions/RegionManager.java
<ide> _playerCacheMap = new PlayerMap<>(plugin);
<ide> _playerLocationCache = new PlayerMap<>(plugin);
<ide> PlayerWatcher _playerWatcher = new PlayerWatcher();
<del> Scheduler.runTaskRepeat(plugin, 7, 7, _playerWatcher);
<add> Scheduler.runTaskRepeat(plugin, 3, 3, _playerWatcher);
<ide> }
<ide>
<ide> /** |
|
Java | mit | 22e2e836ea3d9c772fb9ce60caa93af1858a60e9 | 0 | elBukkit/MagicPlugin,elBukkit/MagicPlugin,elBukkit/MagicPlugin | package com.elmakers.mine.bukkit.wand;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.bukkit.Location;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Entity;
import com.elmakers.mine.bukkit.api.effect.EffectContext;
import com.elmakers.mine.bukkit.api.effect.EffectPlayer;
import com.elmakers.mine.bukkit.api.item.ItemData;
import com.elmakers.mine.bukkit.api.magic.Mage;
import com.elmakers.mine.bukkit.api.magic.MageController;
import com.elmakers.mine.bukkit.api.wand.Wand;
import com.elmakers.mine.bukkit.block.MaterialAndData;
import com.elmakers.mine.bukkit.configuration.MageParameters;
import com.elmakers.mine.bukkit.magic.TemplateProperties;
import com.elmakers.mine.bukkit.utility.ConfigurationUtils;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
public class WandTemplate extends TemplateProperties implements com.elmakers.mine.bukkit.api.wand.WandTemplate {
private Map<String, Collection<EffectPlayer>> effects = new HashMap<>();
private Set<String> tags;
private @Nonnull Set<String> categories = ImmutableSet.of();
private String creator;
private String creatorId;
private String migrateTemplate;
private String migrateIcon;
private String icon;
private boolean restorable;
private Map<String, String> migrateIcons;
private ConfigurationSection attributes;
private String attributeSlot;
private String parentKey;
private Map<String, String> messageKeys = new HashMap<>();
public WandTemplate(MageController controller, String key, ConfigurationSection node) {
super(controller, key, node);
effects.clear();
creator = node.getString("creator");
creatorId = node.getString("creator_id");
migrateTemplate = node.getString("migrate_to");
migrateIcon = node.getString("migrate_icon");
restorable = node.getBoolean("restorable", true);
icon = node.getString("icon");
attributeSlot = node.getString("item_attribute_slot", node.getString("attribute_slot"));
parentKey = node.getString("inherit");
// Remove some properties that should not transfer to wands
clearProperty("creator");
clearProperty("creator_id");
clearProperty("migrate_to");
clearProperty("migrate_icon");
clearProperty("restorable");
clearProperty("hidden");
clearProperty("enabled");
clearProperty("inherit");
ConfigurationSection migrateConfig = node.getConfigurationSection("migrate_icons");
// This ! may look odd, but we only want to use legacy icon migration if we're *not* using legacy icons,
// since the intention is to migrate the legacy icons to the new icons.
if (!controller.isLegacyIconsEnabled()) {
ConfigurationSection migrateLegacyConfig = node.getConfigurationSection("migrate_legacy_icons");
if (migrateLegacyConfig != null) {
migrateConfig = migrateLegacyConfig;
}
String legacyIcon = node.getString("legacy_icon");
if (legacyIcon != null && !legacyIcon.isEmpty() && icon != null) {
migrateIcons = new HashMap<>();
migrateIcons.put(legacyIcon, icon);
// This is unfortunately needed to handle aliases like wand_icon being converted to their
// base item
ItemData converted = controller.getItem(legacyIcon);
if (converted != null) {
MaterialAndData convertedItem = new MaterialAndData(converted.getItemStack());
String convertedIcon = convertedItem.getKey();
if (!convertedIcon.equals(legacyIcon)) {
migrateIcons.put(convertedIcon, icon);
}
}
}
} else {
icon = node.getString("legacy_icon", icon);
}
if (migrateConfig != null) {
if (migrateIcons == null) {
migrateIcons = new HashMap<>();
}
Set<String> keys = migrateConfig.getKeys(false);
for (String migrateKey : keys) {
migrateIcons.put(migrateKey, migrateConfig.getString(migrateKey));
}
clearProperty("migrate_icons");
}
if (node.contains("effects")) {
ConfigurationSection effectsNode = node.getConfigurationSection("effects");
Collection<String> effectKeys = effectsNode.getKeys(false);
for (String effectKey : effectKeys) {
if (effectsNode.isString(effectKey)) {
String referenceKey = effectsNode.getString(effectKey);
if (effects.containsKey(referenceKey)) {
effects.put(effectKey, new ArrayList<>(effects.get(referenceKey)));
} else {
Collection<EffectPlayer> baseEffects = controller.getEffects(referenceKey);
effects.put(effectKey, baseEffects);
}
} else {
effects.put(effectKey, controller.loadEffects(effectsNode, effectKey));
}
}
}
Collection<String> tagList = ConfigurationUtils.getStringList(node, "tags");
if (tagList != null) {
tags = new HashSet<>(tagList);
clearProperty("tags");
} else {
tags = null;
}
Collection<String> categoriesList = ConfigurationUtils.getStringList(node, "categories");
if (categoriesList != null) {
clearProperty("categories");
categories = ImmutableSet.copyOf(categoriesList);
}
}
protected WandTemplate(WandTemplate copy, ConfigurationSection configuration) {
super(copy.controller, copy.getKey(), configuration);
load(configuration);
this.effects = copy.effects;
this.tags = copy.tags;
this.categories = copy.categories;
this.creator = copy.creator;
this.creatorId = copy.creatorId;
this.migrateTemplate = copy.migrateTemplate;
this.migrateIcon = copy.migrateIcon;
this.icon = copy.icon;
this.restorable = copy.restorable;
this.migrateIcons = copy.migrateIcons;
this.attributes = copy.attributes;
this.attributeSlot = copy.attributeSlot;
this.parentKey = copy.parentKey;
}
public WandTemplate getMageTemplate(Mage mage) {
MageParameters parameters = new MageParameters(mage, "Wand " + getKey());
ConfigurationUtils.addConfigurations(parameters, configuration);
return new WandTemplate(this, parameters);
}
@Override
public String getName() {
return controller.getMessages().get("wands." + getKey() + ".name", getKey());
}
@Override
public String getDescription() {
return controller.getMessages().get("wands." + getKey() + ".description", "?");
}
@Override
public Collection<com.elmakers.mine.bukkit.api.effect.EffectPlayer> getEffects(String key) {
Collection<EffectPlayer> effectList = effects.get(key);
if (effectList == null) {
return new ArrayList<>();
}
return new ArrayList<>(effectList);
}
@Override
public boolean playEffects(Wand wand, String key)
{
return playEffects(wand.getMage(), wand, key, 1.0f);
}
@Override
public boolean playEffects(Wand wand, String effectName, float scale) {
return playEffects(wand.getMage(), wand, getKey(), scale);
}
@Override
@Deprecated
public boolean playEffects(Mage mage, String key)
{
return playEffects(mage, mage.getActiveWand(), key, 1.0f);
}
@Override
@Deprecated
public boolean playEffects(Mage mage, String effectName, float scale) {
return playEffects(mage, mage.getActiveWand(), effectName, scale);
}
private boolean playEffects(Mage mage, Wand wand, String effectName, float scale)
{
Preconditions.checkNotNull(mage, "mage");
// First check the wand for overridden effects
Collection<com.elmakers.mine.bukkit.api.effect.EffectPlayer> effects = null;
String effectKey = wand.getString("effects." + effectName);
if (effectKey != null && !effectKey.isEmpty()) {
effects = controller.getEffects(effectKey);
}
if (effects == null || effects.isEmpty()) {
effects = getEffects(effectName);
}
if (effects.isEmpty()) return false;
Entity sourceEntity = mage.getEntity();
for (com.elmakers.mine.bukkit.api.effect.EffectPlayer player : effects)
{
EffectContext context = wand.getContext();
// Track effect plays for cancelling
context.trackEffects(player);
// Set scale
player.setScale(scale);
// Set material and color
player.setColor(wand.getEffectColor());
String overrideParticle = wand.getEffectParticleName();
player.setParticleOverride(overrideParticle);
Location source = player.getSourceLocation(context);
if (source == null) {
source = mage.getLocation();
}
player.start(source, sourceEntity, null, null, null);
}
return true;
}
@Override
public boolean hasTag(String tag) {
return tags != null && tags.contains(tag);
}
@Override
public String getCreatorId() {
return creatorId;
}
@Override
public String getCreator() {
return creator;
}
@Override
public Set<String> getCategories() {
return categories;
}
@Nullable
@Override
public WandTemplate getMigrateTemplate() {
return migrateTemplate == null ? null : controller.getWandTemplate(migrateTemplate);
}
@Override
public String migrateIcon(String currentIcon) {
if (icon != null && migrateIcon != null && migrateIcon.equals(currentIcon)) {
return icon;
}
if (migrateIcons != null) {
String newIcon = migrateIcons.get(currentIcon);
if (newIcon != null) {
return newIcon;
}
}
return currentIcon;
}
@Override
@Deprecated
public boolean isSoul() {
return false;
}
@Override
public boolean isRestorable() {
return restorable;
}
@Override
public ConfigurationSection getAttributes() {
return attributes;
}
@Override
public String getAttributeSlot() {
return attributeSlot;
}
@Nullable
@Override
public WandTemplate getParent() {
if (parentKey != null && !parentKey.isEmpty() && !parentKey.equalsIgnoreCase("false")) {
return controller.getWandTemplate(parentKey);
}
return null;
}
@Override
public String getMessageKey(String key) {
if (!messageKeys.containsKey(key)) {
String wandKey = "wands." + this.getKey() + "." + key;
if (controller.getMessages().containsKey(wandKey)) {
messageKeys.put(key, wandKey);
} else {
WandTemplate parent = parentKey == null || parentKey.isEmpty() ? null : controller.getWandTemplate(parentKey);
String parentMessageKey = parent == null ? null : parent.getMessageKey(key);
messageKeys.put(key, parentMessageKey);
}
}
return messageKeys.get(key);
}
}
| Magic/src/main/java/com/elmakers/mine/bukkit/wand/WandTemplate.java | package com.elmakers.mine.bukkit.wand;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.bukkit.Location;
import org.bukkit.configuration.ConfigurationSection;
import org.bukkit.entity.Entity;
import com.elmakers.mine.bukkit.api.effect.EffectContext;
import com.elmakers.mine.bukkit.api.effect.EffectPlayer;
import com.elmakers.mine.bukkit.api.item.ItemData;
import com.elmakers.mine.bukkit.api.magic.Mage;
import com.elmakers.mine.bukkit.api.magic.MageController;
import com.elmakers.mine.bukkit.api.wand.Wand;
import com.elmakers.mine.bukkit.block.MaterialAndData;
import com.elmakers.mine.bukkit.configuration.MageParameters;
import com.elmakers.mine.bukkit.magic.TemplateProperties;
import com.elmakers.mine.bukkit.utility.ConfigurationUtils;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableSet;
public class WandTemplate extends TemplateProperties implements com.elmakers.mine.bukkit.api.wand.WandTemplate {
private Map<String, Collection<EffectPlayer>> effects = new HashMap<>();
private Set<String> tags;
private @Nonnull Set<String> categories = ImmutableSet.of();
private String creator;
private String creatorId;
private String migrateTemplate;
private String migrateIcon;
private String icon;
private boolean restorable;
private Map<String, String> migrateIcons;
private ConfigurationSection attributes;
private String attributeSlot;
private String parentKey;
private Map<String, String> messageKeys = new HashMap<>();
public WandTemplate(MageController controller, String key, ConfigurationSection node) {
super(controller, key, node);
effects.clear();
creator = node.getString("creator");
creatorId = node.getString("creator_id");
migrateTemplate = node.getString("migrate_to");
migrateIcon = node.getString("migrate_icon");
restorable = node.getBoolean("restorable", true);
icon = node.getString("icon");
attributeSlot = node.getString("item_attribute_slot", node.getString("attribute_slot"));
parentKey = node.getString("inherit");
// Remove some properties that should not transfer to wands
clearProperty("creator");
clearProperty("creator_id");
clearProperty("migrate_to");
clearProperty("migrate_icon");
clearProperty("restorable");
clearProperty("hidden");
clearProperty("enabled");
clearProperty("inherit");
ConfigurationSection migrateConfig = node.getConfigurationSection("migrate_icons");
// This ! may look odd, but we only want to use legacy icon migration if we're *not* using legacy icons,
// since the intention is to migrate the legacy icons to the new icons.
if (!controller.isLegacyIconsEnabled()) {
ConfigurationSection migrateLegacyConfig = node.getConfigurationSection("migrate_legacy_icons");
if (migrateLegacyConfig != null) {
migrateConfig = migrateLegacyConfig;
}
String legacyIcon = node.getString("legacy_icon");
if (legacyIcon != null && !legacyIcon.isEmpty() && icon != null) {
migrateIcons = new HashMap<>();
migrateIcons.put(legacyIcon, icon);
// This is unfortunately needed to handle aliases like wand_icon being converted to their
// base item
ItemData converted = controller.getItem(legacyIcon);
if (converted != null) {
MaterialAndData convertedItem = new MaterialAndData(converted.getItemStack());
String convertedIcon = convertedItem.getKey();
if (!convertedIcon.equals(legacyIcon)) {
migrateIcons.put(convertedIcon, icon);
}
}
}
} else {
icon = node.getString("legacy_icon", icon);
}
if (migrateConfig != null) {
if (migrateIcons == null) {
migrateIcons = new HashMap<>();
}
Set<String> keys = migrateConfig.getKeys(false);
for (String migrateKey : keys) {
migrateIcons.put(migrateKey, migrateConfig.getString(migrateKey));
}
clearProperty("migrate_icons");
}
if (node.contains("effects")) {
ConfigurationSection effectsNode = node.getConfigurationSection("effects");
Collection<String> effectKeys = effectsNode.getKeys(false);
for (String effectKey : effectKeys) {
if (effectsNode.isString(effectKey)) {
String referenceKey = effectsNode.getString(effectKey);
if (effects.containsKey(referenceKey)) {
effects.put(effectKey, new ArrayList<>(effects.get(referenceKey)));
} else {
Collection<EffectPlayer> baseEffects = controller.getEffects(referenceKey);
effects.put(effectKey, baseEffects);
}
} else {
effects.put(effectKey, controller.loadEffects(effectsNode, effectKey));
}
}
}
Collection<String> tagList = ConfigurationUtils.getStringList(node, "tags");
if (tagList != null) {
tags = new HashSet<>(tagList);
clearProperty("tags");
} else {
tags = null;
}
Collection<String> categoriesList = ConfigurationUtils.getStringList(node, "categories");
if (categoriesList != null) {
clearProperty("categories");
categories = ImmutableSet.copyOf(categoriesList);
}
}
protected WandTemplate(WandTemplate copy, ConfigurationSection configuration) {
super(copy.controller, copy.getKey(), configuration);
load(configuration);
this.effects = copy.effects;
this.tags = copy.tags;
this.categories = copy.categories;
this.creator = copy.creator;
this.creatorId = copy.creatorId;
this.migrateTemplate = copy.migrateTemplate;
this.migrateIcon = copy.migrateIcon;
this.icon = copy.icon;
this.restorable = copy.restorable;
this.migrateIcons = copy.migrateIcons;
this.attributes = copy.attributes;
this.attributeSlot = copy.attributeSlot;
this.parentKey = copy.parentKey;
}
public WandTemplate getMageTemplate(Mage mage) {
MageParameters parameters = new MageParameters(mage, "Wand " + getKey());
ConfigurationUtils.addConfigurations(parameters, configuration);
return new WandTemplate(this, parameters);
}
@Override
public String getName() {
return controller.getMessages().get("wands." + getKey() + ".name", "?");
}
@Override
public String getDescription() {
return controller.getMessages().get("wands." + getKey() + ".description", "?");
}
@Override
public Collection<com.elmakers.mine.bukkit.api.effect.EffectPlayer> getEffects(String key) {
Collection<EffectPlayer> effectList = effects.get(key);
if (effectList == null) {
return new ArrayList<>();
}
return new ArrayList<>(effectList);
}
@Override
public boolean playEffects(Wand wand, String key)
{
return playEffects(wand.getMage(), wand, key, 1.0f);
}
@Override
public boolean playEffects(Wand wand, String effectName, float scale) {
return playEffects(wand.getMage(), wand, getKey(), scale);
}
@Override
@Deprecated
public boolean playEffects(Mage mage, String key)
{
return playEffects(mage, mage.getActiveWand(), key, 1.0f);
}
@Override
@Deprecated
public boolean playEffects(Mage mage, String effectName, float scale) {
return playEffects(mage, mage.getActiveWand(), effectName, scale);
}
private boolean playEffects(Mage mage, Wand wand, String effectName, float scale)
{
Preconditions.checkNotNull(mage, "mage");
// First check the wand for overridden effects
Collection<com.elmakers.mine.bukkit.api.effect.EffectPlayer> effects = null;
String effectKey = wand.getString("effects." + effectName);
if (effectKey != null && !effectKey.isEmpty()) {
effects = controller.getEffects(effectKey);
}
if (effects == null || effects.isEmpty()) {
effects = getEffects(effectName);
}
if (effects.isEmpty()) return false;
Entity sourceEntity = mage.getEntity();
for (com.elmakers.mine.bukkit.api.effect.EffectPlayer player : effects)
{
EffectContext context = wand.getContext();
// Track effect plays for cancelling
context.trackEffects(player);
// Set scale
player.setScale(scale);
// Set material and color
player.setColor(wand.getEffectColor());
String overrideParticle = wand.getEffectParticleName();
player.setParticleOverride(overrideParticle);
Location source = player.getSourceLocation(context);
if (source == null) {
source = mage.getLocation();
}
player.start(source, sourceEntity, null, null, null);
}
return true;
}
@Override
public boolean hasTag(String tag) {
return tags != null && tags.contains(tag);
}
@Override
public String getCreatorId() {
return creatorId;
}
@Override
public String getCreator() {
return creator;
}
@Override
public Set<String> getCategories() {
return categories;
}
@Nullable
@Override
public WandTemplate getMigrateTemplate() {
return migrateTemplate == null ? null : controller.getWandTemplate(migrateTemplate);
}
@Override
public String migrateIcon(String currentIcon) {
if (icon != null && migrateIcon != null && migrateIcon.equals(currentIcon)) {
return icon;
}
if (migrateIcons != null) {
String newIcon = migrateIcons.get(currentIcon);
if (newIcon != null) {
return newIcon;
}
}
return currentIcon;
}
@Override
@Deprecated
public boolean isSoul() {
return false;
}
@Override
public boolean isRestorable() {
return restorable;
}
@Override
public ConfigurationSection getAttributes() {
return attributes;
}
@Override
public String getAttributeSlot() {
return attributeSlot;
}
@Nullable
@Override
public WandTemplate getParent() {
if (parentKey != null && !parentKey.isEmpty() && !parentKey.equalsIgnoreCase("false")) {
return controller.getWandTemplate(parentKey);
}
return null;
}
@Override
public String getMessageKey(String key) {
if (!messageKeys.containsKey(key)) {
String wandKey = "wands." + this.getKey() + "." + key;
if (controller.getMessages().containsKey(wandKey)) {
messageKeys.put(key, wandKey);
} else {
WandTemplate parent = parentKey == null || parentKey.isEmpty() ? null : controller.getWandTemplate(parentKey);
String parentMessageKey = parent == null ? null : parent.getMessageKey(key);
messageKeys.put(key, parentMessageKey);
}
}
return messageKeys.get(key);
}
}
| Default wand template names to the template key
| Magic/src/main/java/com/elmakers/mine/bukkit/wand/WandTemplate.java | Default wand template names to the template key | <ide><path>agic/src/main/java/com/elmakers/mine/bukkit/wand/WandTemplate.java
<ide>
<ide> @Override
<ide> public String getName() {
<del> return controller.getMessages().get("wands." + getKey() + ".name", "?");
<add> return controller.getMessages().get("wands." + getKey() + ".name", getKey());
<ide> }
<ide>
<ide> @Override |
|
Java | apache-2.0 | 88db6b796d73ccda73aedd4bf13b6ca0efbf7806 | 0 | puneetjaiswal/crate,EvilMcJerkface/crate,puneetjaiswal/crate,gmrodrigues/crate,gmrodrigues/crate,EvilMcJerkface/crate,adrpar/crate,husky-koglhof/crate,adrpar/crate,aslanbekirov/crate,puneetjaiswal/crate,gmrodrigues/crate,crate/crate,aslanbekirov/crate,adrpar/crate,aslanbekirov/crate,husky-koglhof/crate,crate/crate,crate/crate,husky-koglhof/crate,EvilMcJerkface/crate | /*
* Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
* license agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership. Crate licenses
* this file to you 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.
*
* However, if you have executed another commercial license agreement
* with Crate these terms will supersede the license and you may use the
* software solely pursuant to the terms of the relevant commercial agreement.
*/
package io.crate.integrationtests;
import io.crate.action.sql.SQLActionException;
import io.crate.exceptions.Exceptions;
import org.elasticsearch.common.settings.ImmutableSettings;
import org.elasticsearch.common.settings.Settings;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
import javax.annotation.Nullable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.instanceOf;
public class KillIntegrationTest extends SQLTransportIntegrationTest {
private Setup setup = new Setup(sqlExecutor);
@Rule
public ExpectedException expectedException = ExpectedException.none();
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Override
protected Settings nodeSettings(int nodeOrdinal) {
ImmutableSettings.Builder builder = ImmutableSettings.builder();
builder.put(super.nodeSettings(nodeOrdinal));
// disable auto-creation of indexes because this can lead to flaky killAll tests
// if a insert is killed, pending insert operations could still exists and
// would re-create the table after it was dropped by test cleanUp routines
builder.put("action.auto_create_index", false);
return builder.build();
}
@Test
public void testKillInsertFromSubQuery() throws Exception {
setup.setUpEmployees();
execute("create table new_employees (" +
" name string, " +
" department string," +
" hired timestamp, " +
" age short," +
" income double, " +
" good boolean" +
") with (number_of_replicas=1)");
ensureYellow();
assertGotCancelled("insert into new_employees (select * from employees)", null);
}
private void assertGotCancelled(final String statement, @Nullable final Object[] params) throws Exception {
ExecutorService executor = Executors.newSingleThreadExecutor();
final AtomicReference<Throwable> thrown = new AtomicReference<>();
final CountDownLatch happened = new CountDownLatch(1);
try {
executor.submit(new Runnable() {
@Override
public void run() {
while (thrown.get() == null) {
try {
execute(statement, params);
} catch (Throwable e) {
Throwable unwrapped = Exceptions.unwrap(e);
thrown.compareAndSet(null, unwrapped);
} finally {
happened.countDown();
}
}
}
});
happened.await();
execute("kill all");
executor.shutdown();
executor.awaitTermination(2, TimeUnit.SECONDS);
// if killed, then cancellationException, nothing else
Throwable exception = thrown.get();
if (exception != null) {
assertThat(exception, instanceOf(SQLActionException.class));
assertThat(((SQLActionException)exception).stackTrace(), containsString("Job killed by user"));
}
} finally {
executor.shutdownNow();
}
}
@Test
public void testKillUpdateByQuery() throws Exception {
setup.setUpEmployees();
assertGotCancelled("update employees set income=income+100 where department='management'", null);
}
@Test
public void testKillCopyTo() throws Exception {
String path = temporaryFolder.newFolder().getAbsolutePath();
setup.setUpEmployees();
assertGotCancelled("copy employees to directory ?", new Object[]{path});
}
@Test
public void testKillGroupBy() throws Exception {
setup.setUpEmployees();
assertGotCancelled("SELECT sum(income) as summed_income, count(distinct name), department " +
"from employees " +
"group by department " +
"having avg(income) > 100 " +
"order by department desc nulls first " +
"limit 10", null);
runJobContextReapers();
}
}
| sql/src/test/java/io/crate/integrationtests/KillIntegrationTest.java | /*
* Licensed to CRATE Technology GmbH ("Crate") under one or more contributor
* license agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership. Crate licenses
* this file to you 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.
*
* However, if you have executed another commercial license agreement
* with Crate these terms will supersede the license and you may use the
* software solely pursuant to the terms of the relevant commercial agreement.
*/
package io.crate.integrationtests;
import io.crate.action.sql.SQLActionException;
import io.crate.exceptions.Exceptions;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
import javax.annotation.Nullable;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicReference;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.instanceOf;
public class KillIntegrationTest extends SQLTransportIntegrationTest {
private Setup setup = new Setup(sqlExecutor);
@Rule
public ExpectedException expectedException = ExpectedException.none();
@Rule
public TemporaryFolder temporaryFolder = new TemporaryFolder();
@Test
public void testKillInsertFromSubQuery() throws Exception {
setup.setUpEmployees();
execute("create table new_employees (" +
" name string, " +
" department string," +
" hired timestamp, " +
" age short," +
" income double, " +
" good boolean" +
") with (number_of_replicas=1)");
ensureYellow();
assertGotCancelled("insert into new_employees (select * from employees)", null);
// if the insert is killed there will still be pending insert operations,
// the refresh seems to block long enough that those operations can be finished,
// otherwise the test would be flaky.
refresh();
}
private void assertGotCancelled(final String statement, @Nullable final Object[] params) throws Exception {
ExecutorService executor = Executors.newSingleThreadExecutor();
final AtomicReference<Throwable> thrown = new AtomicReference<>();
final CountDownLatch happened = new CountDownLatch(1);
try {
executor.submit(new Runnable() {
@Override
public void run() {
while (thrown.get() == null) {
try {
execute(statement, params);
} catch (Throwable e) {
Throwable unwrapped = Exceptions.unwrap(e);
thrown.compareAndSet(null, unwrapped);
} finally {
happened.countDown();
}
}
}
});
happened.await();
execute("kill all");
executor.shutdown();
executor.awaitTermination(2, TimeUnit.SECONDS);
// if killed, then cancellationException, nothing else
Throwable exception = thrown.get();
if (exception != null) {
assertThat(exception, instanceOf(SQLActionException.class));
assertThat(((SQLActionException)exception).stackTrace(), containsString("Job killed by user"));
}
} finally {
executor.shutdownNow();
}
}
@Test
public void testKillUpdateByQuery() throws Exception {
setup.setUpEmployees();
assertGotCancelled("update employees set income=income+100 where department='management'", null);
}
@Test
public void testKillCopyTo() throws Exception {
String path = temporaryFolder.newFolder().getAbsolutePath();
setup.setUpEmployees();
assertGotCancelled("copy employees to directory ?", new Object[]{path});
}
@Test
public void testKillGroupBy() throws Exception {
setup.setUpEmployees();
assertGotCancelled("SELECT sum(income) as summed_income, count(distinct name), department " +
"from employees " +
"group by department " +
"having avg(income) > 100 " +
"order by department desc nulls first " +
"limit 10", null);
runJobContextReapers();
}
}
| disable auto-create index for killAll integration tests
| sql/src/test/java/io/crate/integrationtests/KillIntegrationTest.java | disable auto-create index for killAll integration tests | <ide><path>ql/src/test/java/io/crate/integrationtests/KillIntegrationTest.java
<ide>
<ide> import io.crate.action.sql.SQLActionException;
<ide> import io.crate.exceptions.Exceptions;
<add>import org.elasticsearch.common.settings.ImmutableSettings;
<add>import org.elasticsearch.common.settings.Settings;
<ide> import org.junit.Rule;
<ide> import org.junit.Test;
<ide> import org.junit.rules.ExpectedException;
<ide> @Rule
<ide> public TemporaryFolder temporaryFolder = new TemporaryFolder();
<ide>
<add> @Override
<add> protected Settings nodeSettings(int nodeOrdinal) {
<add> ImmutableSettings.Builder builder = ImmutableSettings.builder();
<add> builder.put(super.nodeSettings(nodeOrdinal));
<add>
<add> // disable auto-creation of indexes because this can lead to flaky killAll tests
<add> // if a insert is killed, pending insert operations could still exists and
<add> // would re-create the table after it was dropped by test cleanUp routines
<add> builder.put("action.auto_create_index", false);
<add>
<add> return builder.build();
<add> }
<add>
<ide> @Test
<ide> public void testKillInsertFromSubQuery() throws Exception {
<ide> setup.setUpEmployees();
<ide> ") with (number_of_replicas=1)");
<ide> ensureYellow();
<ide> assertGotCancelled("insert into new_employees (select * from employees)", null);
<del>
<del> // if the insert is killed there will still be pending insert operations,
<del> // the refresh seems to block long enough that those operations can be finished,
<del> // otherwise the test would be flaky.
<del> refresh();
<ide> }
<ide>
<ide> private void assertGotCancelled(final String statement, @Nullable final Object[] params) throws Exception { |
|
Java | agpl-3.0 | baca8096dd32d44cb068740aab453a5c03a96c0e | 0 | SoftInstigate/restheart,SoftInstigate/restheart,SoftInstigate/restheart,SoftInstigate/restheart | package org.restheart.graphql.models;
import java.util.ArrayList;
import java.util.List;
import org.bson.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonString;
import org.bson.BsonValue;
import org.dataloader.DataLoader;
import org.dataloader.DataLoaderOptions;
import org.restheart.exchange.QueryVariableNotBoundException;
import org.restheart.graphql.datafetchers.GQLAggregationDataFetcher;
import org.restheart.graphql.datafetchers.GQLBatchAggregationDataFetcher;
import org.restheart.graphql.datafetchers.GraphQLDataFetcher;
import org.restheart.graphql.dataloaders.AggregationBatchLoader;
import graphql.schema.DataFetchingEnvironment;
public class AggregationMapping extends FieldMapping implements Batchable {
private BsonArray stages;
private BsonString db;
private BsonString collection;
private BsonBoolean allowDiskUse = new BsonBoolean(false);
private DataLoaderSettings dataLoaderSettings;
public AggregationMapping(String fieldName, BsonString db, BsonString collection, BsonArray stages,
BsonBoolean allowDiskUse, DataLoaderSettings settings) {
super(fieldName);
this.stages = stages;
this.db = db;
this.collection = collection;
this.allowDiskUse = allowDiskUse;
this.dataLoaderSettings = settings;
}
@Override
public GraphQLDataFetcher getDataFetcher() {
return this.dataLoaderSettings.getBatching()
? new GQLBatchAggregationDataFetcher(this)
: new GQLAggregationDataFetcher(this);
}
@Override
public DataLoader<BsonValue, BsonValue> getDataloader() {
if (this.dataLoaderSettings.getCaching() || this.dataLoaderSettings.getBatching()) {
DataLoaderOptions options = new DataLoaderOptions()
.setCacheKeyFunction(bsonVal -> String.valueOf(bsonVal.hashCode()));
if (this.dataLoaderSettings.getMax_batch_size() > 0) {
options.setMaxBatchSize(this.dataLoaderSettings.getMax_batch_size());
}
options.setBatchingEnabled(this.dataLoaderSettings.getBatching());
options.setCachingEnabled(this.dataLoaderSettings.getCaching());
return new DataLoader<BsonValue, BsonValue>(
new AggregationBatchLoader(this.db.getValue(), this.collection.getValue()), options);
}
return null;
}
public List<BsonDocument> getResolvedStagesAsList(DataFetchingEnvironment env)
throws QueryVariableNotBoundException {
List<BsonDocument> resultList = new ArrayList<>();
for (BsonValue stage : this.stages) {
if (stage.isDocument()) {
resultList.add(searchOperators(stage.asDocument(), env).asDocument());
}
}
return resultList;
}
public DataLoaderSettings getDataLoaderSettings() {
return dataLoaderSettings;
}
public void setDataLoaderSettings(DataLoaderSettings dataLoaderSettings) {
this.dataLoaderSettings = dataLoaderSettings;
}
public BsonArray getStages() {
return this.stages;
}
public void setStages(BsonArray stages) {
this.stages = stages;
}
public BsonString getDb() {
return db;
}
public void setDb(BsonString db) {
this.db = db;
}
public BsonString getCollection() {
return collection;
}
public void setCollection(BsonString collection) {
this.collection = collection;
}
public BsonBoolean getAllowDiskUse() {
return allowDiskUse;
}
public void setAllowDiskUse(BsonBoolean allowDiskUse) {
this.allowDiskUse = allowDiskUse;
}
public static class Builder {
private String fieldName;
private BsonArray stages;
private BsonString db;
private BsonString collection;
private BsonBoolean allowDiskUse = new BsonBoolean(false);
private DataLoaderSettings dataLoaderSettings;
public Builder() {
}
public Builder fieldName(String fieldName) {
this.fieldName = fieldName;
return this;
}
public Builder stages(BsonArray stages) {
this.stages = stages;
return this;
}
public Builder db(BsonString db) {
this.db = db;
return this;
}
public Builder collection(BsonString collection) {
this.collection = collection;
return this;
}
public Builder allowDiskUse(BsonBoolean allowDiskUse) {
this.allowDiskUse = allowDiskUse;
return this;
}
public Builder dataLoaderSettings(DataLoaderSettings dataLoaderSettings) {
this.dataLoaderSettings = dataLoaderSettings;
return this;
}
public AggregationMapping build() {
if (this.dataLoaderSettings == null) {
this.dataLoaderSettings = DataLoaderSettings.newBuilder().build();
}
return new AggregationMapping(
this.fieldName,
this.db,
this.collection,
this.stages,
this.allowDiskUse,
this.dataLoaderSettings);
}
}
}
| graphql/src/main/java/org/restheart/graphql/models/AggregationMapping.java | package org.restheart.graphql.models;
import java.util.ArrayList;
import java.util.List;
import org.bson.BsonArray;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonString;
import org.bson.BsonValue;
import org.bson.conversions.Bson;
import org.restheart.exchange.QueryVariableNotBoundException;
import org.restheart.graphql.datafetchers.GQLAggregationDataFetcher;
import org.restheart.graphql.datafetchers.GraphQLDataFetcher;
import graphql.schema.DataFetchingEnvironment;
public class AggregationMapping extends FieldMapping {
private BsonArray stages;
private BsonString db;
private BsonString collection;
private BsonBoolean allowDiskUse = new BsonBoolean(false);
public AggregationMapping(String fieldName, BsonString db, BsonString collection, BsonArray stages,
BsonBoolean allowDiskUse) {
super(fieldName);
this.stages = stages;
this.db = db;
this.collection = collection;
this.allowDiskUse = allowDiskUse;
}
public AggregationMapping(String fieldName, BsonString db, BsonString collection, BsonArray stages) {
super(fieldName);
this.stages = stages;
this.db = db;
this.collection = collection;
}
@Override
public GraphQLDataFetcher getDataFetcher() {
return new GQLAggregationDataFetcher(this);
}
public List<? extends Bson> getResolvedStagesAsList(DataFetchingEnvironment env)
throws QueryVariableNotBoundException {
List<BsonDocument> resultList = new ArrayList<>();
for (BsonValue stage : this.stages) {
if (stage.isDocument()) {
resultList.add(searchOperators(stage.asDocument(), env).asDocument());
}
}
return resultList;
}
public BsonArray getStages() {
return this.stages;
}
public void setStages(BsonArray stages) {
this.stages = stages;
}
public BsonString getDb() {
return db;
}
public void setDb(BsonString db) {
this.db = db;
}
public BsonString getCollection() {
return collection;
}
public void setCollection(BsonString collection) {
this.collection = collection;
}
public BsonBoolean getAllowDiskUse() {
return allowDiskUse;
}
public void setAllowDiskUse(BsonBoolean allowDiskUse) {
this.allowDiskUse = allowDiskUse;
}
}
| Added data loader settings to AggregationMapping model
| graphql/src/main/java/org/restheart/graphql/models/AggregationMapping.java | Added data loader settings to AggregationMapping model | <ide><path>raphql/src/main/java/org/restheart/graphql/models/AggregationMapping.java
<ide> import org.bson.BsonDocument;
<ide> import org.bson.BsonString;
<ide> import org.bson.BsonValue;
<del>import org.bson.conversions.Bson;
<add>import org.dataloader.DataLoader;
<add>import org.dataloader.DataLoaderOptions;
<ide> import org.restheart.exchange.QueryVariableNotBoundException;
<ide> import org.restheart.graphql.datafetchers.GQLAggregationDataFetcher;
<add>import org.restheart.graphql.datafetchers.GQLBatchAggregationDataFetcher;
<ide> import org.restheart.graphql.datafetchers.GraphQLDataFetcher;
<add>import org.restheart.graphql.dataloaders.AggregationBatchLoader;
<ide>
<ide> import graphql.schema.DataFetchingEnvironment;
<ide>
<del>public class AggregationMapping extends FieldMapping {
<del>
<add>public class AggregationMapping extends FieldMapping implements Batchable {
<add>
<ide> private BsonArray stages;
<ide> private BsonString db;
<ide> private BsonString collection;
<ide> private BsonBoolean allowDiskUse = new BsonBoolean(false);
<del>
<add> private DataLoaderSettings dataLoaderSettings;
<ide>
<ide> public AggregationMapping(String fieldName, BsonString db, BsonString collection, BsonArray stages,
<del> BsonBoolean allowDiskUse) {
<add> BsonBoolean allowDiskUse, DataLoaderSettings settings) {
<ide>
<ide> super(fieldName);
<ide> this.stages = stages;
<ide> this.db = db;
<ide> this.collection = collection;
<ide> this.allowDiskUse = allowDiskUse;
<del> }
<del>
<del> public AggregationMapping(String fieldName, BsonString db, BsonString collection, BsonArray stages) {
<del>
<del> super(fieldName);
<del> this.stages = stages;
<del> this.db = db;
<del> this.collection = collection;
<add> this.dataLoaderSettings = settings;
<ide> }
<ide>
<ide> @Override
<ide> public GraphQLDataFetcher getDataFetcher() {
<del>
<del> return new GQLAggregationDataFetcher(this);
<add> return this.dataLoaderSettings.getBatching()
<add> ? new GQLBatchAggregationDataFetcher(this)
<add> : new GQLAggregationDataFetcher(this);
<ide> }
<ide>
<del> public List<? extends Bson> getResolvedStagesAsList(DataFetchingEnvironment env)
<add> @Override
<add> public DataLoader<BsonValue, BsonValue> getDataloader() {
<add> if (this.dataLoaderSettings.getCaching() || this.dataLoaderSettings.getBatching()) {
<add> DataLoaderOptions options = new DataLoaderOptions()
<add> .setCacheKeyFunction(bsonVal -> String.valueOf(bsonVal.hashCode()));
<add>
<add> if (this.dataLoaderSettings.getMax_batch_size() > 0) {
<add> options.setMaxBatchSize(this.dataLoaderSettings.getMax_batch_size());
<add> }
<add>
<add> options.setBatchingEnabled(this.dataLoaderSettings.getBatching());
<add> options.setCachingEnabled(this.dataLoaderSettings.getCaching());
<add>
<add> return new DataLoader<BsonValue, BsonValue>(
<add> new AggregationBatchLoader(this.db.getValue(), this.collection.getValue()), options);
<add>
<add> }
<add> return null;
<add> }
<add>
<add> public List<BsonDocument> getResolvedStagesAsList(DataFetchingEnvironment env)
<ide> throws QueryVariableNotBoundException {
<ide>
<ide> List<BsonDocument> resultList = new ArrayList<>();
<ide> }
<ide>
<ide> return resultList;
<add> }
<add>
<add> public DataLoaderSettings getDataLoaderSettings() {
<add> return dataLoaderSettings;
<add> }
<add>
<add> public void setDataLoaderSettings(DataLoaderSettings dataLoaderSettings) {
<add> this.dataLoaderSettings = dataLoaderSettings;
<ide> }
<ide>
<ide> public BsonArray getStages() {
<ide> this.allowDiskUse = allowDiskUse;
<ide> }
<ide>
<add> public static class Builder {
<add>
<add> private String fieldName;
<add> private BsonArray stages;
<add> private BsonString db;
<add> private BsonString collection;
<add> private BsonBoolean allowDiskUse = new BsonBoolean(false);
<add> private DataLoaderSettings dataLoaderSettings;
<add>
<add> public Builder() {
<add> }
<add>
<add> public Builder fieldName(String fieldName) {
<add> this.fieldName = fieldName;
<add> return this;
<add> }
<add>
<add> public Builder stages(BsonArray stages) {
<add> this.stages = stages;
<add> return this;
<add> }
<add>
<add> public Builder db(BsonString db) {
<add> this.db = db;
<add> return this;
<add> }
<add>
<add> public Builder collection(BsonString collection) {
<add> this.collection = collection;
<add> return this;
<add> }
<add>
<add> public Builder allowDiskUse(BsonBoolean allowDiskUse) {
<add> this.allowDiskUse = allowDiskUse;
<add> return this;
<add> }
<add>
<add> public Builder dataLoaderSettings(DataLoaderSettings dataLoaderSettings) {
<add> this.dataLoaderSettings = dataLoaderSettings;
<add> return this;
<add> }
<add>
<add> public AggregationMapping build() {
<add>
<add> if (this.dataLoaderSettings == null) {
<add> this.dataLoaderSettings = DataLoaderSettings.newBuilder().build();
<add> }
<add> return new AggregationMapping(
<add> this.fieldName,
<add> this.db,
<add> this.collection,
<add> this.stages,
<add> this.allowDiskUse,
<add> this.dataLoaderSettings);
<add> }
<add>
<add> }
<add>
<ide> } |
|
Java | mit | b3c90f7c330501b593297cb6b20174c1f4e68b08 | 0 | VersatileVelociraptors/SafeVelociraptorServer | package com.github.versatilevelociraptor.safevelociraptorserver;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.ServerSocket;
import java.net.Socket;
public class Server {
public static final int PORT = 2585;
private ServerSocket serverSocket;
private Controller controller;
private RobotController roboController;
public static final int MAX_CLIENTS = 2;
public Server() {
try {
serverSocket = new ServerSocket(PORT);
serverSocket.setReuseAddress(true);
} catch (IOException e) {
e.printStackTrace();
}
initializeConnections();
}
public void initializeConnections() {
Socket client;
int connectedClients = 0;
boolean controlerConnected = false , robotControllerConnected = false;
while(connectedClients < MAX_CLIENTS) {
try {
System.out.println("Looking for clients..");
client = serverSocket.accept();
System.out.println("Loocking for clients");
BufferedReader reader = new BufferedReader(new InputStreamReader(client.getInputStream()));
String ID = reader.readLine();
System.out.println(ID);
if(ID.equals("" + Controller.ID) && !controlerConnected) {
controller = new Controller(client);
controller.sendCommand("Michael is a gypsy");
System.out.println("Client Connected!");
connectedClients++;
controlerConnected = true;
} else if(ID.equals("" + RobotController.ID) && !robotControllerConnected) {
roboController = new RobotController(client);
System.out.println("Client Connected!");
roboController.sendCommand("Michael is a gypsy");
connectedClients++;
robotControllerConnected = true;
} else {
System.out.println("NOT CORRECT ID");
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
public void restart() {
initializeConnections();
createCommunicationSession();
}
public synchronized void setController() {
}
public void createCommunicationSession() {
new Thread(new ServerThread(roboController, controller)).start();
new Thread(new ServerThread(controller, roboController)).start();
}
public static void main(String[] args) {
Server server = new Server();
server.createCommunicationSession();
}
private class ServerThread implements Runnable{
private Client send;
private Client recieve;
public ServerThread(Client send, Client recieve) {
this.send = send;
this.recieve = recieve;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run()
*/
@Override
public void run() {
recieve.sendCommand(send.recieveCommand());
}
}
}
| src/com/github/versatilevelociraptor/safevelociraptorserver/Server.java | package com.github.versatilevelociraptor.safevelociraptorserver;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.ServerSocket;
import java.net.Socket;
public class Server {
public static final int PORT = 2585;
private ServerSocket serverSocket;
private Controller controller;
private RobotController roboController;
public static final int MAX_CLIENTS = 2;
public Server() {
try {
serverSocket = new ServerSocket(PORT);
serverSocket.setReuseAddress(true);
} catch (IOException e) {
e.printStackTrace();
}
initializeConnections();
}
public void initializeConnections() {
Socket client;
int connectedClients = 0;
boolean controlerConnected = false , robotControllerConnected = false;
while(connectedClients < MAX_CLIENTS) {
try {
System.out.println("Looking for clients..");
client = serverSocket.accept();
System.out.println("Loocking for clients");
BufferedReader reader = new BufferedReader(new InputStreamReader(client.getInputStream()));
String ID = reader.readLine();
System.out.println(ID);
if(Integer.parseInt(ID) == Controller.ID && !controlerConnected) {
controller = new Controller(client);
System.out.println("Client Connected!");
connectedClients++;
controlerConnected = true;
} else if(Integer.parseInt(ID) == RobotController.ID && !robotControllerConnected) {
roboController = new RobotController(client);
System.out.println("Client Connected!");
connectedClients++;
robotControllerConnected = true;
} else {
System.out.println("NOT CORRECT ID");
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
public void restart() {
initializeConnections();
createCommunicationSession();
}
public void createCommunicationSession() {
new Thread(new ServerThread(roboController, controller)).start();
new Thread(new ServerThread(controller, roboController)).start();
}
public static void main(String[] args) {
Server server = new Server();
server.createCommunicationSession();
}
private class ServerThread implements Runnable{
private Client send;
private Client recieve;
public ServerThread(Client send, Client recieve) {
this.send = send;
this.recieve = recieve;
}
/* (non-Javadoc)
* @see java.lang.Runnable#run()
*/
@Override
public void run() {
recieve.sendCommand(send.recieveCommand());
}
}
}
| Remove parse ints
| src/com/github/versatilevelociraptor/safevelociraptorserver/Server.java | Remove parse ints | <ide><path>rc/com/github/versatilevelociraptor/safevelociraptorserver/Server.java
<ide> BufferedReader reader = new BufferedReader(new InputStreamReader(client.getInputStream()));
<ide> String ID = reader.readLine();
<ide> System.out.println(ID);
<del> if(Integer.parseInt(ID) == Controller.ID && !controlerConnected) {
<add> if(ID.equals("" + Controller.ID) && !controlerConnected) {
<ide> controller = new Controller(client);
<add> controller.sendCommand("Michael is a gypsy");
<ide> System.out.println("Client Connected!");
<ide> connectedClients++;
<ide> controlerConnected = true;
<del> } else if(Integer.parseInt(ID) == RobotController.ID && !robotControllerConnected) {
<add> } else if(ID.equals("" + RobotController.ID) && !robotControllerConnected) {
<ide> roboController = new RobotController(client);
<ide> System.out.println("Client Connected!");
<add> roboController.sendCommand("Michael is a gypsy");
<ide> connectedClients++;
<ide> robotControllerConnected = true;
<ide> } else {
<ide> public void restart() {
<ide> initializeConnections();
<ide> createCommunicationSession();
<add> }
<add>
<add> public synchronized void setController() {
<add>
<ide> }
<ide>
<ide> public void createCommunicationSession() { |
|
Java | mit | 41584c8c20993c04cd596dcb1a34b3d43cd6bf3a | 0 | jqk6/cordova-plugin-admob,aliokan/cordova-plugin-admob,jqk6/cordova-plugin-admob,aliokan/cordova-plugin-admob | package com.google.cordova.plugin;
import java.util.Iterator;
import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaInterface;
import org.apache.cordova.CordovaPlugin;
import org.apache.cordova.LinearLayoutSoftKeyboardDetect;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import android.util.Log;
import com.google.ads.Ad;
import com.google.ads.AdListener;
import com.google.ads.AdRequest;
import com.google.ads.AdRequest.ErrorCode;
import com.google.ads.AdSize;
import com.google.ads.doubleclick.DfpAdView;
import com.google.ads.doubleclick.DfpInterstitialAd;
import com.google.ads.mediation.admob.AdMobAdapterExtras;
/**
* This class represents the native implementation for the AdMob Cordova plugin.
* This plugin can be used to request AdMob ads natively via the Google AdMob
* SDK. The Google AdMob SDK is a dependency for this plugin.
*/
public class AdMobPlugin extends CordovaPlugin {
/** The adView to display to the user. */
private DfpAdView adView;
private DfpInterstitialAd intertitial;
/** Whether or not the ad should be positioned at top or bottom of screen. */
private boolean positionAtTop;
/** Common tag used for logging statements. */
private static final String LOGTAG = "AdMobPlugin";
/** Cordova Actions. */
public static final String ACTION_CREATE_BANNER_VIEW = "createBannerView";
public static final String ACTION_CREATE_INTERSTITIAL_VIEW = "createInterstitialView";
public static final String ACTION_REQUEST_AD = "requestAd";
public static final String KILL_AD = "killAd";
/**
* This is the main method for the AdMob plugin. All API calls go through
* here. This method determines the action, and executes the appropriate
* call.
*
* @param action
* The action that the plugin should execute.
* @param inputs
* The input parameters for the action.
* @param callbackId
* The callback ID. This is currently unused.
* @return A PluginResult representing the result of the provided action. A
* status of INVALID_ACTION is returned if the action is not
* recognized.
*/
@Override
public boolean execute(String action, JSONArray inputs,
CallbackContext callbackContext) throws JSONException {
if (ACTION_CREATE_BANNER_VIEW.equals(action)) {
executeCreateBannerView(inputs, callbackContext);
return true;
} else if (ACTION_CREATE_INTERSTITIAL_VIEW.equals(action)) {
executeCreateInterstitialView(inputs, callbackContext);
return true;
} else if (ACTION_REQUEST_AD.equals(action)) {
executeRequestAd(inputs, callbackContext);
return true;
} else if (KILL_AD.equals(action)) {
executeKillAd(callbackContext);
return true;
} else {
Log.d(LOGTAG, String.format("Invalid action passed: %s", action));
callbackContext.error("Invalid Action");
}
return false;
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the
* developer should make the requestAd call to request an ad for the banner.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private void executeCreateBannerView(JSONArray inputs, CallbackContext callbackContext) {
String publisherId = "";
String size = "";
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
publisherId = data.getString("publisherId");
size = data.getString("adSize");
this.positionAtTop = data.getBoolean("positionAtTop");
Log.w(LOGTAG, "executeCreateBannerView OK");
Log.w(LOGTAG, "size: " + size);
Log.w(LOGTAG, "publisherId: " + publisherId);
Log.w(LOGTAG, "positionAtTop: " + (this.positionAtTop ? "true" : "false"));
} catch (JSONException exception) {
Log.w(LOGTAG,
String.format("Got JSON Exception: %s",
exception.getMessage()));
callbackContext.error(exception.getMessage());
}
AdSize adSize = adSizeFromSize(size);
createBannerView(publisherId, adSize, callbackContext);
}
private synchronized void createBannerView(final String publisherId,
final AdSize adSize, final CallbackContext callbackContext) {
final CordovaInterface cordova = this.cordova;
// Create the AdView on the UI thread.
Log.w(LOGTAG, "createBannerView");
Runnable runnable = new Runnable() {
public void run() {
Log.w(LOGTAG, "run");
Log.w(LOGTAG, String.valueOf(webView));
// Log.w(LOGTAG, "adSize::" + adSize); calling adSize.toString() with SmartBanner == crash
if (adSize == null) {
callbackContext
.error("AdSize is null. Did you use an AdSize constant?");
return;
} else {
adView = new DfpAdView(cordova.getActivity(), adSize,
publisherId);
adView.setAdListener(new BannerListener());
LinearLayoutSoftKeyboardDetect parentView = (LinearLayoutSoftKeyboardDetect) webView
.getParent();
if (positionAtTop) {
parentView.addView(adView, 0);
} else {
parentView.addView(adView);
}
// Notify the plugin.
callbackContext.success();
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the
* developer should make the requestAd call to request an ad for the banner.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private void executeCreateInterstitialView(JSONArray inputs, CallbackContext callbackContext) {
String publisherId = "";
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
publisherId = data.getString("publisherId");
Log.w(LOGTAG, "executeCreateInterstitialView OK");
} catch (JSONException exception) {
Log.w(LOGTAG, String.format("Got JSON Exception: %s", exception.getMessage()));
callbackContext.error(exception.getMessage());
}
createInterstitialView(publisherId, callbackContext);
}
private synchronized void createInterstitialView(final String publisherId, final CallbackContext callbackContext) {
final CordovaInterface cordova = this.cordova;
// Create the AdView on the UI thread.
Log.w(LOGTAG, "createInterstitialView");
Runnable runnable = new Runnable() {
public void run() {
intertitial = new DfpInterstitialAd(cordova.getActivity(), publisherId);
intertitial.setAdListener(new BannerListener());
// Notify the plugin.
callbackContext.success();
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* Parses the request ad input parameters and runs the request ad action on
* the UI thread.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
private void executeRequestAd(JSONArray inputs,
CallbackContext callbackContext) {
boolean isTesting = false;
JSONObject inputExtras = null;
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
isTesting = data.getBoolean("isTesting");
inputExtras = data.getJSONObject("extras");
Log.w(LOGTAG, "executeRequestAd OK");
// callbackContext.success();
// return true;
} catch (JSONException exception) {
Log.w(LOGTAG,
String.format("Got JSON Exception: %s",
exception.getMessage()));
callbackContext.error(exception.getMessage());
}
// Request an ad on the UI thread.
if (adView != null) {
requestAd(isTesting, inputExtras, callbackContext);
} else if (intertitial != null) {
requestIntertitial(isTesting, inputExtras, callbackContext);
} else {
callbackContext
.error("adView && intertitial are null. Did you call createBannerView?");
return;
}
}
private synchronized void requestIntertitial(final boolean isTesting,
final JSONObject inputExtras, final CallbackContext callbackContext) {
Log.w(LOGTAG, "requestIntertitial");
// Create the AdView on the UI thread.
Runnable runnable = new Runnable() {
@SuppressWarnings("unchecked")
public void run() {
if (intertitial == null) {
callbackContext
.error("intertitial is null. Did you call createBannerView?");
return;
} else {
AdRequest request = new AdRequest();
if (isTesting) {
// This will request test ads on the emulator only. You
// can
// get your
// hashed device ID from LogCat when making a live
// request.
// Pass
// this hashed device ID to addTestDevice request test
// ads
// on your
// device.
request.addTestDevice(AdRequest.TEST_EMULATOR);
}
AdMobAdapterExtras extras = new AdMobAdapterExtras();
Iterator<String> extrasIterator = inputExtras.keys();
boolean inputValid = true;
while (extrasIterator.hasNext()) {
String key = extrasIterator.next();
try {
extras.addExtra(key, inputExtras.get(key));
} catch (JSONException exception) {
Log.w(LOGTAG, String.format(
"Caught JSON Exception: %s",
exception.getMessage()));
callbackContext.error("Error grabbing extras");
inputValid = false;
}
}
if (inputValid) {
// extras.addExtra("cordova", 1);
// request.setNetworkExtras(extras);
intertitial.loadAd(request);
// Notify the plugin.
callbackContext.success();
}
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
private synchronized void requestAd(final boolean isTesting,
final JSONObject inputExtras, final CallbackContext callbackContext) {
Log.w(LOGTAG, "requestAd");
// Create the AdView on the UI thread.
Runnable runnable = new Runnable() {
@SuppressWarnings("unchecked")
public void run() {
if (adView == null) {
callbackContext
.error("AdView is null. Did you call createBannerView?");
return;
} else {
AdRequest request = new AdRequest();
if (isTesting) {
// This will request test ads on the emulator only. You
// can
// get your
// hashed device ID from LogCat when making a live
// request.
// Pass
// this hashed device ID to addTestDevice request test
// ads
// on your
// device.
request.addTestDevice(AdRequest.TEST_EMULATOR);
}
AdMobAdapterExtras extras = new AdMobAdapterExtras();
Iterator<String> extrasIterator = inputExtras.keys();
boolean inputValid = true;
while (extrasIterator.hasNext()) {
String key = extrasIterator.next();
try {
extras.addExtra(key, inputExtras.get(key));
} catch (JSONException exception) {
Log.w(LOGTAG, String.format(
"Caught JSON Exception: %s",
exception.getMessage()));
callbackContext.error("Error grabbing extras");
inputValid = false;
}
}
if (inputValid) {
// extras.addExtra("cordova", 1);
// request.setNetworkExtras(extras);
adView.loadAd(request);
// Notify the plugin.
callbackContext.success();
}
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
private void executeKillAd(final CallbackContext callbackContext) {
final Runnable runnable = new Runnable() {
public void run() {
if (adView == null) {
// Notify the plugin.
callbackContext.error("AdView is null. Did you call createBannerView or already destroy it?");
} else {
LinearLayoutSoftKeyboardDetect parentView = (LinearLayoutSoftKeyboardDetect) webView
.getParent();
parentView.removeView(adView);
adView.removeAllViews();
adView.destroy();
adView = null;
callbackContext.success();
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* This class implements the AdMob ad listener events. It forwards the
* events to the JavaScript layer. To listen for these events, use:
*
* document.addEventListener('onReceiveAd', function());
* document.addEventListener('onFailedToReceiveAd', function(data));
* document.addEventListener('onPresentScreen', function());
* document.addEventListener('onDismissScreen', function());
* document.addEventListener('onLeaveApplication', function());
*/
private class BannerListener implements AdListener {
@Override
public void onReceiveAd(Ad ad) {
if (ad == intertitial) {
intertitial.show();
}
webView.loadUrl("javascript:cordova.fireDocumentEvent('onReceiveAd');");
}
@Override
public void onFailedToReceiveAd(Ad ad, ErrorCode errorCode) {
webView.loadUrl(String
.format("javascript:cordova.fireDocumentEvent('onFailedToReceiveAd', { 'error': '%s' });",
errorCode));
}
@Override
public void onPresentScreen(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onPresentScreen');");
}
@Override
public void onDismissScreen(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onDismissScreen');");
}
@Override
public void onLeaveApplication(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onLeaveApplication');");
}
}
@Override
public void onDestroy() {
if (adView != null) {
adView.destroy();
}
super.onDestroy();
}
/**
* Gets an AdSize object from the string size passed in from JavaScript.
* Returns null if an improper string is provided.
*
* @param size
* The string size representing an ad format constant.
* @return An AdSize object used to create a banner.
*/
public static AdSize adSizeFromSize(String size) {
if ("BANNER".equals(size)) {
return AdSize.BANNER;
} else if ("IAB_MRECT".equals(size)) {
return AdSize.IAB_MRECT;
} else if ("IAB_BANNER".equals(size)) {
return AdSize.IAB_BANNER;
} else if ("IAB_LEADERBOARD".equals(size)) {
return AdSize.IAB_LEADERBOARD;
} else if ("SMART_BANNER".equals(size)) {
return AdSize.SMART_BANNER;
} else {
return null;
}
}
}
| src/android/com/google/cordova/plugin/AdMobPlugin.java | package com.google.cordova.plugin;
import java.util.Iterator;
import org.apache.cordova.CallbackContext;
import org.apache.cordova.CordovaInterface;
import org.apache.cordova.CordovaPlugin;
import org.apache.cordova.LinearLayoutSoftKeyboardDetect;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import android.util.Log;
import com.google.ads.Ad;
import com.google.ads.AdListener;
import com.google.ads.AdRequest;
import com.google.ads.AdRequest.ErrorCode;
import com.google.ads.AdSize;
import com.google.ads.doubleclick.DfpAdView;
import com.google.ads.doubleclick.DfpInterstitialAd;
import com.google.ads.mediation.admob.AdMobAdapterExtras;
/**
* This class represents the native implementation for the AdMob Cordova plugin.
* This plugin can be used to request AdMob ads natively via the Google AdMob
* SDK. The Google AdMob SDK is a dependency for this plugin.
*/
public class AdMobPlugin extends CordovaPlugin {
/** The adView to display to the user. */
private DfpAdView adView;
private DfpInterstitialAd intertitial;
/** Whether or not the ad should be positioned at top or bottom of screen. */
private boolean positionAtTop;
/** Common tag used for logging statements. */
private static final String LOGTAG = "AdMobPlugin";
/** Cordova Actions. */
public static final String ACTION_CREATE_BANNER_VIEW = "createBannerView";
public static final String ACTION_CREATE_INTERSTITIAL_VIEW = "createInterstitialView";
public static final String ACTION_REQUEST_AD = "requestAd";
public static final String KILL_AD = "killAd";
/**
* This is the main method for the AdMob plugin. All API calls go through
* here. This method determines the action, and executes the appropriate
* call.
*
* @param action
* The action that the plugin should execute.
* @param inputs
* The input parameters for the action.
* @param callbackId
* The callback ID. This is currently unused.
* @return A PluginResult representing the result of the provided action. A
* status of INVALID_ACTION is returned if the action is not
* recognized.
*/
@Override
public boolean execute(String action, JSONArray inputs,
CallbackContext callbackContext) throws JSONException {
if (ACTION_CREATE_BANNER_VIEW.equals(action)) {
executeCreateBannerView(inputs, callbackContext);
return true;
} else if (ACTION_CREATE_INTERSTITIAL_VIEW.equals(action)) {
executeCreateInterstitialView(inputs, callbackContext);
return true;
} else if (ACTION_REQUEST_AD.equals(action)) {
executeRequestAd(inputs, callbackContext);
return true;
} else if (KILL_AD.equals(action)) {
executeKillAd(callbackContext);
return true;
} else {
Log.d(LOGTAG, String.format("Invalid action passed: %s", action));
callbackContext.error("Invalid Action");
}
return false;
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the
* developer should make the requestAd call to request an ad for the banner.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private void executeCreateBannerView(JSONArray inputs, CallbackContext callbackContext) {
String publisherId = "";
String size = "";
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
publisherId = data.getString("publisherId");
size = data.getString("adSize");
this.positionAtTop = data.getBoolean("positionAtTop");
Log.w(LOGTAG, "executeCreateBannerView OK");
Log.w(LOGTAG, "size: " + size);
Log.w(LOGTAG, "publisherId: " + publisherId);
Log.w(LOGTAG, "positionAtTop: " + (this.positionAtTop ? "true" : "false"));
} catch (JSONException exception) {
Log.w(LOGTAG,
String.format("Got JSON Exception: %s",
exception.getMessage()));
callbackContext.error(exception.getMessage());
}
AdSize adSize = adSizeFromSize(size);
createBannerView(publisherId, adSize, callbackContext);
}
private synchronized void createBannerView(final String publisherId,
final AdSize adSize, final CallbackContext callbackContext) {
final CordovaInterface cordova = this.cordova;
// Create the AdView on the UI thread.
Log.w(LOGTAG, "createBannerView");
Runnable runnable = new Runnable() {
public void run() {
Log.w(LOGTAG, "run");
Log.w(LOGTAG, String.valueOf(webView));
// Log.w(LOGTAG, "adSize::" + adSize); calling adSize.toString() with SmartBanner == crash
if (adSize == null) {
callbackContext
.error("AdSize is null. Did you use an AdSize constant?");
return;
} else {
adView = new DfpAdView(cordova.getActivity(), adSize,
publisherId);
adView.setAdListener(new BannerListener());
LinearLayoutSoftKeyboardDetect parentView = (LinearLayoutSoftKeyboardDetect) webView
.getParent();
if (positionAtTop) {
parentView.addView(adView, 0);
} else {
parentView.addView(adView);
}
// Notify the plugin.
callbackContext.success();
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* Parses the create banner view input parameters and runs the create banner
* view action on the UI thread. If this request is successful, the
* developer should make the requestAd call to request an ad for the banner.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not the banner was created
* successfully.
*/
private void executeCreateInterstitialView(JSONArray inputs, CallbackContext callbackContext) {
String publisherId = "";
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
publisherId = data.getString("publisherId");
Log.w(LOGTAG, "executeCreateInterstitialView OK");
} catch (JSONException exception) {
Log.w(LOGTAG, String.format("Got JSON Exception: %s", exception.getMessage()));
callbackContext.error(exception.getMessage());
}
createInterstitialView(publisherId, callbackContext);
}
private synchronized void createInterstitialView(final String publisherId, final CallbackContext callbackContext) {
final CordovaInterface cordova = this.cordova;
// Create the AdView on the UI thread.
Log.w(LOGTAG, "createInterstitialView");
Runnable runnable = new Runnable() {
public void run() {
intertitial = new DfpInterstitialAd(cordova.getActivity(), publisherId);
intertitial.setAdListener(new BannerListener());
// Notify the plugin.
callbackContext.success();
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* Parses the request ad input parameters and runs the request ad action on
* the UI thread.
*
* @param inputs
* The JSONArray representing input parameters. This function
* expects the first object in the array to be a JSONObject with
* the input parameters.
* @return A PluginResult representing whether or not an ad was requested
* succcessfully. Listen for onReceiveAd() and onFailedToReceiveAd()
* callbacks to see if an ad was successfully retrieved.
*/
private void executeRequestAd(JSONArray inputs,
CallbackContext callbackContext) {
boolean isTesting = false;
JSONObject inputExtras = null;
// Get the input data.
try {
JSONObject data = inputs.getJSONObject(0);
isTesting = data.getBoolean("isTesting");
inputExtras = data.getJSONObject("extras");
Log.w(LOGTAG, "executeRequestAd OK");
// callbackContext.success();
// return true;
} catch (JSONException exception) {
Log.w(LOGTAG,
String.format("Got JSON Exception: %s",
exception.getMessage()));
callbackContext.error(exception.getMessage());
}
// Request an ad on the UI thread.
if (adView != null) {
requestAd(isTesting, inputExtras, callbackContext);
} else if (intertitial != null) {
requestIntertitial(isTesting, inputExtras, callbackContext);
} else {
callbackContext
.error("adView && intertitial are null. Did you call createBannerView?");
return;
}
}
private synchronized void requestIntertitial(final boolean isTesting,
final JSONObject inputExtras, final CallbackContext callbackContext) {
Log.w(LOGTAG, "requestIntertitial");
// Create the AdView on the UI thread.
Runnable runnable = new Runnable() {
@SuppressWarnings("unchecked")
public void run() {
if (intertitial == null) {
callbackContext
.error("intertitial is null. Did you call createBannerView?");
return;
} else {
AdRequest request = new AdRequest();
if (isTesting) {
// This will request test ads on the emulator only. You
// can
// get your
// hashed device ID from LogCat when making a live
// request.
// Pass
// this hashed device ID to addTestDevice request test
// ads
// on your
// device.
request.addTestDevice(AdRequest.TEST_EMULATOR);
}
AdMobAdapterExtras extras = new AdMobAdapterExtras();
Iterator<String> extrasIterator = inputExtras.keys();
boolean inputValid = true;
while (extrasIterator.hasNext()) {
String key = extrasIterator.next();
try {
extras.addExtra(key, inputExtras.get(key));
} catch (JSONException exception) {
Log.w(LOGTAG, String.format(
"Caught JSON Exception: %s",
exception.getMessage()));
callbackContext.error("Error grabbing extras");
inputValid = false;
}
}
if (inputValid) {
// extras.addExtra("cordova", 1);
// request.setNetworkExtras(extras);
intertitial.loadAd(request);
// Notify the plugin.
callbackContext.success();
}
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
private synchronized void requestAd(final boolean isTesting,
final JSONObject inputExtras, final CallbackContext callbackContext) {
Log.w(LOGTAG, "requestAd");
// Create the AdView on the UI thread.
Runnable runnable = new Runnable() {
@SuppressWarnings("unchecked")
public void run() {
if (adView == null) {
callbackContext
.error("AdView is null. Did you call createBannerView?");
return;
} else {
AdRequest request = new AdRequest();
if (isTesting) {
// This will request test ads on the emulator only. You
// can
// get your
// hashed device ID from LogCat when making a live
// request.
// Pass
// this hashed device ID to addTestDevice request test
// ads
// on your
// device.
request.addTestDevice(AdRequest.TEST_EMULATOR);
}
AdMobAdapterExtras extras = new AdMobAdapterExtras();
Iterator<String> extrasIterator = inputExtras.keys();
boolean inputValid = true;
while (extrasIterator.hasNext()) {
String key = extrasIterator.next();
try {
extras.addExtra(key, inputExtras.get(key));
} catch (JSONException exception) {
Log.w(LOGTAG, String.format(
"Caught JSON Exception: %s",
exception.getMessage()));
callbackContext.error("Error grabbing extras");
inputValid = false;
}
}
if (inputValid) {
// extras.addExtra("cordova", 1);
// request.setNetworkExtras(extras);
adView.loadAd(request);
// Notify the plugin.
callbackContext.success();
}
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
private void executeKillAd(CallbackContext callbackContext) {
final Runnable runnable = new Runnable() {
public void run() {
if (adView == null) {
// Notify the plugin.
callbackContext.error("AdView is null. Did you call createBannerView or already destroy it?");
} else {
LinearLayoutSoftKeyboardDetect parentView = (LinearLayoutSoftKeyboardDetect) webView
.getParent();
parentView.removeView(adView);
adView.removeAllViews();
adView.destroy();
adView = null;
callbackContext.success();
}
}
};
this.cordova.getActivity().runOnUiThread(runnable);
}
/**
* This class implements the AdMob ad listener events. It forwards the
* events to the JavaScript layer. To listen for these events, use:
*
* document.addEventListener('onReceiveAd', function());
* document.addEventListener('onFailedToReceiveAd', function(data));
* document.addEventListener('onPresentScreen', function());
* document.addEventListener('onDismissScreen', function());
* document.addEventListener('onLeaveApplication', function());
*/
private class BannerListener implements AdListener {
@Override
public void onReceiveAd(Ad ad) {
if (ad == intertitial) {
intertitial.show();
}
webView.loadUrl("javascript:cordova.fireDocumentEvent('onReceiveAd');");
}
@Override
public void onFailedToReceiveAd(Ad ad, ErrorCode errorCode) {
webView.loadUrl(String
.format("javascript:cordova.fireDocumentEvent('onFailedToReceiveAd', { 'error': '%s' });",
errorCode));
}
@Override
public void onPresentScreen(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onPresentScreen');");
}
@Override
public void onDismissScreen(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onDismissScreen');");
}
@Override
public void onLeaveApplication(Ad ad) {
webView.loadUrl("javascript:cordova.fireDocumentEvent('onLeaveApplication');");
}
}
@Override
public void onDestroy() {
if (adView != null) {
adView.destroy();
}
super.onDestroy();
}
/**
* Gets an AdSize object from the string size passed in from JavaScript.
* Returns null if an improper string is provided.
*
* @param size
* The string size representing an ad format constant.
* @return An AdSize object used to create a banner.
*/
public static AdSize adSizeFromSize(String size) {
if ("BANNER".equals(size)) {
return AdSize.BANNER;
} else if ("IAB_MRECT".equals(size)) {
return AdSize.IAB_MRECT;
} else if ("IAB_BANNER".equals(size)) {
return AdSize.IAB_BANNER;
} else if ("IAB_LEADERBOARD".equals(size)) {
return AdSize.IAB_LEADERBOARD;
} else if ("SMART_BANNER".equals(size)) {
return AdSize.SMART_BANNER;
} else {
return null;
}
}
}
| fix executeKillAd
| src/android/com/google/cordova/plugin/AdMobPlugin.java | fix executeKillAd | <ide><path>rc/android/com/google/cordova/plugin/AdMobPlugin.java
<ide> this.cordova.getActivity().runOnUiThread(runnable);
<ide> }
<ide>
<del> private void executeKillAd(CallbackContext callbackContext) {
<add> private void executeKillAd(final CallbackContext callbackContext) {
<ide> final Runnable runnable = new Runnable() {
<ide> public void run() {
<ide> if (adView == null) { |
|
Java | apache-2.0 | ff83e9e67c5367c7b7bc50d1f5aa1eae93a03e8a | 0 | apache/pdfbox,apache/pdfbox,kalaspuffar/pdfbox,kalaspuffar/pdfbox | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.pdfbox.pdmodel.common.function;
import java.io.IOException;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.pdmodel.common.PDRange;
import org.apache.pdfbox.pdmodel.common.PDStream;
/**
* This class represents a function in a PDF document.
*
* @author Ben Litchfield
*
*/
public abstract class PDFunction implements COSObjectable
{
private PDStream functionStream = null;
private COSDictionary functionDictionary = null;
private COSArray domain = null;
private COSArray range = null;
private int numberOfInputValues = -1;
private int numberOfOutputValues = -1;
/**
* Constructor.
*
* @param function The function stream.
*
*/
public PDFunction( COSBase function )
{
if (function instanceof COSStream)
{
functionStream = new PDStream( (COSStream)function );
functionStream.getCOSObject().setItem( COSName.TYPE, COSName.FUNCTION );
}
else if (function instanceof COSDictionary)
{
functionDictionary = (COSDictionary)function;
}
}
/**
* Returns the function type.
*
* Possible values are:
*
* 0 - Sampled function
* 2 - Exponential interpolation function
* 3 - Stitching function
* 4 - PostScript calculator function
*
* @return the function type.
*/
public abstract int getFunctionType();
/**
* Returns the stream.
* @return The stream for this object.
*/
@Override
public COSDictionary getCOSObject()
{
if (functionStream != null)
{
return functionStream.getCOSObject();
}
else
{
return functionDictionary;
}
}
/**
* Returns the underlying PDStream.
* @return The stream.
*/
protected PDStream getPDStream()
{
return functionStream;
}
/**
* Create the correct PD Model function based on the COS base function.
*
* @param function The COS function dictionary.
*
* @return The PDModel Function object.
*
* @throws IOException If we are unable to create the PDFunction object.
*/
public static PDFunction create( COSBase function ) throws IOException
{
if (function == COSName.IDENTITY)
{
return new PDFunctionTypeIdentity(null);
}
COSBase base = function;
if (function instanceof COSObject)
{
base = ((COSObject) function).getObject();
}
if (!(base instanceof COSDictionary))
{
throw new IOException("Error: Function must be a Dictionary, but is " +
(base == null ? "(null)" : base.getClass().getSimpleName()));
}
COSDictionary functionDictionary = (COSDictionary) base;
int functionType = functionDictionary.getInt(COSName.FUNCTION_TYPE);
switch (functionType)
{
case 0:
return new PDFunctionType0(functionDictionary);
case 2:
return new PDFunctionType2(functionDictionary);
case 3:
return new PDFunctionType3(functionDictionary);
case 4:
return new PDFunctionType4(functionDictionary);
default:
throw new IOException("Error: Unknown function type " + functionType);
}
}
/**
* This will get the number of output parameters that
* have a range specified. A range for output parameters
* is optional so this may return zero for a function
* that does have output parameters, this will simply return the
* number that have the range specified.
*
* @return The number of output parameters that have a range
* specified.
*/
public int getNumberOfOutputParameters()
{
if (numberOfOutputValues == -1)
{
COSArray rangeValues = getRangeValues();
numberOfOutputValues = rangeValues.size() / 2;
}
return numberOfOutputValues;
}
/**
* This will get the range for a certain output parameters. This is will never
* return null. If it is not present then the range 0 to 0 will
* be returned.
*
* @param n The output parameter number to get the range for.
*
* @return The range for this component.
*/
public PDRange getRangeForOutput(int n)
{
COSArray rangeValues = getRangeValues();
return new PDRange( rangeValues, n );
}
/**
* This will set the range values.
*
* @param rangeValues The new range values.
*/
public void setRangeValues(COSArray rangeValues)
{
range = rangeValues;
getCOSObject().setItem(COSName.RANGE, rangeValues);
}
/**
* This will get the number of input parameters that
* have a domain specified.
*
* @return The number of input parameters that have a domain
* specified.
*/
public int getNumberOfInputParameters()
{
if (numberOfInputValues == -1)
{
COSArray array = getDomainValues();
numberOfInputValues = array.size() / 2;
}
return numberOfInputValues;
}
/**
* This will get the range for a certain input parameter. This is will never
* return null. If it is not present then the range 0 to 0 will
* be returned.
*
* @param n The parameter number to get the domain for.
*
* @return The domain range for this component.
*/
public PDRange getDomainForInput(int n)
{
COSArray domainValues = getDomainValues();
return new PDRange( domainValues, n );
}
/**
* This will set the domain values.
*
* @param domainValues The new domain values.
*/
public void setDomainValues(COSArray domainValues)
{
domain = domainValues;
getCOSObject().setItem(COSName.DOMAIN, domainValues);
}
/**
* Evaluates the function at the given input.
* ReturnValue = f(input)
*
* @param input The array of input values for the function.
* In many cases will be an array of a single value, but not always.
*
* @return The of outputs the function returns based on those inputs.
* In many cases will be an array of a single value, but not always.
*
* @throws IOException if something went wrong processing the function.
*/
public abstract float[] eval(float[] input) throws IOException;
/**
* Returns all ranges for the output values as COSArray .
* Required for type 0 and type 4 functions
* @return the ranges array.
*/
protected COSArray getRangeValues()
{
if (range == null)
{
range = (COSArray) getCOSObject().getDictionaryObject(COSName.RANGE);
}
return range;
}
/**
* Returns all domains for the input values as COSArray.
* Required for all function types.
* @return the domains array.
*/
private COSArray getDomainValues()
{
if (domain == null)
{
domain = (COSArray) getCOSObject().getDictionaryObject(COSName.DOMAIN);
}
return domain;
}
/**
* Clip the given input values to the ranges.
*
* @param inputValues the input values
* @return the clipped values
*/
protected float[] clipToRange(float[] inputValues)
{
COSArray rangesArray = getRangeValues();
float[] result;
if (rangesArray != null && rangesArray.size() > 0)
{
float[] rangeValues = rangesArray.toFloatArray();
int numberOfRanges = rangeValues.length/2;
result = new float[numberOfRanges];
for (int i=0; i<numberOfRanges; i++)
{
int index = i << 1;
result[i] = clipToRange(inputValues[i], rangeValues[index], rangeValues[index + 1]);
}
}
else
{
result = inputValues;
}
return result;
}
/**
* Clip the given input value to the given range.
*
* @param x the input value
* @param rangeMin the min value of the range
* @param rangeMax the max value of the range
* @return the clipped value
*/
protected float clipToRange(float x, float rangeMin, float rangeMax)
{
if (x < rangeMin)
{
return rangeMin;
}
else if (x > rangeMax)
{
return rangeMax;
}
return x;
}
/**
* For a given value of x, interpolate calculates the y value
* on the line defined by the two points (xRangeMin , xRangeMax )
* and (yRangeMin , yRangeMax ).
*
* @param x the to be interpolated value.
* @param xRangeMin the min value of the x range
* @param xRangeMax the max value of the x range
* @param yRangeMin the min value of the y range
* @param yRangeMax the max value of the y range
* @return the interpolated y value
*/
protected float interpolate(float x, float xRangeMin, float xRangeMax, float yRangeMin, float yRangeMax)
{
return yRangeMin + ((x - xRangeMin) * (yRangeMax - yRangeMin)/(xRangeMax - xRangeMin));
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return "FunctionType" + getFunctionType();
}
}
| pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java | /*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.pdfbox.pdmodel.common.function;
import java.io.IOException;
import org.apache.pdfbox.cos.COSArray;
import org.apache.pdfbox.cos.COSBase;
import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.cos.COSObject;
import org.apache.pdfbox.cos.COSStream;
import org.apache.pdfbox.pdmodel.common.COSObjectable;
import org.apache.pdfbox.pdmodel.common.PDRange;
import org.apache.pdfbox.pdmodel.common.PDStream;
/**
* This class represents a function in a PDF document.
*
* @author Ben Litchfield
*
*/
public abstract class PDFunction implements COSObjectable
{
private PDStream functionStream = null;
private COSDictionary functionDictionary = null;
private COSArray domain = null;
private COSArray range = null;
private int numberOfInputValues = -1;
private int numberOfOutputValues = -1;
/**
* Constructor.
*
* @param function The function stream.
*
*/
public PDFunction( COSBase function )
{
if (function instanceof COSStream)
{
functionStream = new PDStream( (COSStream)function );
functionStream.getCOSObject().setItem( COSName.TYPE, COSName.FUNCTION );
}
else if (function instanceof COSDictionary)
{
functionDictionary = (COSDictionary)function;
}
}
/**
* Returns the function type.
*
* Possible values are:
*
* 0 - Sampled function
* 2 - Exponential interpolation function
* 3 - Stitching function
* 4 - PostScript calculator function
*
* @return the function type.
*/
public abstract int getFunctionType();
/**
* Returns the stream.
* @return The stream for this object.
*/
@Override
public COSDictionary getCOSObject()
{
if (functionStream != null)
{
return functionStream.getCOSObject();
}
else
{
return functionDictionary;
}
}
/**
* Returns the underlying PDStream.
* @return The stream.
*/
protected PDStream getPDStream()
{
return functionStream;
}
/**
* Create the correct PD Model function based on the COS base function.
*
* @param function The COS function dictionary.
*
* @return The PDModel Function object.
*
* @throws IOException If we are unable to create the PDFunction object.
*/
public static PDFunction create( COSBase function ) throws IOException
{
if (function == COSName.IDENTITY)
{
return new PDFunctionTypeIdentity(null);
}
COSBase base = function;
if (function instanceof COSObject)
{
base = ((COSObject) function).getObject();
}
if (!(base instanceof COSDictionary))
{
throw new IOException("Error: Function must be a Dictionary, but is " +
base.getClass().getSimpleName());
}
COSDictionary functionDictionary = (COSDictionary) base;
int functionType = functionDictionary.getInt(COSName.FUNCTION_TYPE);
switch (functionType)
{
case 0:
return new PDFunctionType0(functionDictionary);
case 2:
return new PDFunctionType2(functionDictionary);
case 3:
return new PDFunctionType3(functionDictionary);
case 4:
return new PDFunctionType4(functionDictionary);
default:
throw new IOException("Error: Unknown function type " + functionType);
}
}
/**
* This will get the number of output parameters that
* have a range specified. A range for output parameters
* is optional so this may return zero for a function
* that does have output parameters, this will simply return the
* number that have the range specified.
*
* @return The number of output parameters that have a range
* specified.
*/
public int getNumberOfOutputParameters()
{
if (numberOfOutputValues == -1)
{
COSArray rangeValues = getRangeValues();
numberOfOutputValues = rangeValues.size() / 2;
}
return numberOfOutputValues;
}
/**
* This will get the range for a certain output parameters. This is will never
* return null. If it is not present then the range 0 to 0 will
* be returned.
*
* @param n The output parameter number to get the range for.
*
* @return The range for this component.
*/
public PDRange getRangeForOutput(int n)
{
COSArray rangeValues = getRangeValues();
return new PDRange( rangeValues, n );
}
/**
* This will set the range values.
*
* @param rangeValues The new range values.
*/
public void setRangeValues(COSArray rangeValues)
{
range = rangeValues;
getCOSObject().setItem(COSName.RANGE, rangeValues);
}
/**
* This will get the number of input parameters that
* have a domain specified.
*
* @return The number of input parameters that have a domain
* specified.
*/
public int getNumberOfInputParameters()
{
if (numberOfInputValues == -1)
{
COSArray array = getDomainValues();
numberOfInputValues = array.size() / 2;
}
return numberOfInputValues;
}
/**
* This will get the range for a certain input parameter. This is will never
* return null. If it is not present then the range 0 to 0 will
* be returned.
*
* @param n The parameter number to get the domain for.
*
* @return The domain range for this component.
*/
public PDRange getDomainForInput(int n)
{
COSArray domainValues = getDomainValues();
return new PDRange( domainValues, n );
}
/**
* This will set the domain values.
*
* @param domainValues The new domain values.
*/
public void setDomainValues(COSArray domainValues)
{
domain = domainValues;
getCOSObject().setItem(COSName.DOMAIN, domainValues);
}
/**
* Evaluates the function at the given input.
* ReturnValue = f(input)
*
* @param input The array of input values for the function.
* In many cases will be an array of a single value, but not always.
*
* @return The of outputs the function returns based on those inputs.
* In many cases will be an array of a single value, but not always.
*
* @throws IOException if something went wrong processing the function.
*/
public abstract float[] eval(float[] input) throws IOException;
/**
* Returns all ranges for the output values as COSArray .
* Required for type 0 and type 4 functions
* @return the ranges array.
*/
protected COSArray getRangeValues()
{
if (range == null)
{
range = (COSArray) getCOSObject().getDictionaryObject(COSName.RANGE);
}
return range;
}
/**
* Returns all domains for the input values as COSArray.
* Required for all function types.
* @return the domains array.
*/
private COSArray getDomainValues()
{
if (domain == null)
{
domain = (COSArray) getCOSObject().getDictionaryObject(COSName.DOMAIN);
}
return domain;
}
/**
* Clip the given input values to the ranges.
*
* @param inputValues the input values
* @return the clipped values
*/
protected float[] clipToRange(float[] inputValues)
{
COSArray rangesArray = getRangeValues();
float[] result;
if (rangesArray != null && rangesArray.size() > 0)
{
float[] rangeValues = rangesArray.toFloatArray();
int numberOfRanges = rangeValues.length/2;
result = new float[numberOfRanges];
for (int i=0; i<numberOfRanges; i++)
{
int index = i << 1;
result[i] = clipToRange(inputValues[i], rangeValues[index], rangeValues[index + 1]);
}
}
else
{
result = inputValues;
}
return result;
}
/**
* Clip the given input value to the given range.
*
* @param x the input value
* @param rangeMin the min value of the range
* @param rangeMax the max value of the range
* @return the clipped value
*/
protected float clipToRange(float x, float rangeMin, float rangeMax)
{
if (x < rangeMin)
{
return rangeMin;
}
else if (x > rangeMax)
{
return rangeMax;
}
return x;
}
/**
* For a given value of x, interpolate calculates the y value
* on the line defined by the two points (xRangeMin , xRangeMax )
* and (yRangeMin , yRangeMax ).
*
* @param x the to be interpolated value.
* @param xRangeMin the min value of the x range
* @param xRangeMax the max value of the x range
* @param yRangeMin the min value of the y range
* @param yRangeMax the max value of the y range
* @return the interpolated y value
*/
protected float interpolate(float x, float xRangeMin, float xRangeMax, float yRangeMin, float yRangeMax)
{
return yRangeMin + ((x - xRangeMin) * (yRangeMax - yRangeMin)/(xRangeMax - xRangeMin));
}
/**
* {@inheritDoc}
*/
@Override
public String toString()
{
return "FunctionType" + getFunctionType();
}
}
| PDFBOX-4892: avoid NullPointerException
git-svn-id: c3ad59981690829a43dc34c293c4e2cd04bcd994@1884682 13f79535-47bb-0310-9956-ffa450edef68
| pdfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java | PDFBOX-4892: avoid NullPointerException | <ide><path>dfbox/src/main/java/org/apache/pdfbox/pdmodel/common/function/PDFunction.java
<ide> if (!(base instanceof COSDictionary))
<ide> {
<ide> throw new IOException("Error: Function must be a Dictionary, but is " +
<del> base.getClass().getSimpleName());
<add> (base == null ? "(null)" : base.getClass().getSimpleName()));
<ide> }
<ide> COSDictionary functionDictionary = (COSDictionary) base;
<ide> int functionType = functionDictionary.getInt(COSName.FUNCTION_TYPE); |
|
JavaScript | mit | 952d68e3ea559b9b391c17d84573d7fad250f456 | 0 | panva/node-oidc-provider,panva/node-oidc-provider | const url = require('url');
const camelCase = require('lodash/camelCase');
const assign = require('lodash/assign');
const upperFirst = require('lodash/upperFirst');
const Debug = require('debug');
const started = new Debug('oidc-provider:authentication:interrupted');
const accepted = new Debug('oidc-provider:authentication:accepted');
const ssHandler = require('../../helpers/samesite_handler');
const errors = require('../../helpers/errors');
const instance = require('../../helpers/weak_cache');
/* eslint-disable no-restricted-syntax, no-await-in-loop */
module.exports = async function interactions(resumeRouteName, ctx, next) {
const { oidc } = ctx;
let failedCheck;
let prompt;
const { policy, url: interactionUrl } = instance(oidc.provider).configuration('interactions');
for (const { name, checks, details: promptDetails } of policy) {
let results = (await Promise.all([...checks].map(async ({
reason, description, error, details, check,
}) => {
if (await check(ctx)) {
return {
[reason]: { error, description, details: await details(ctx) },
};
}
return undefined;
}))).filter(Boolean);
if (results.length) {
results = assign({}, ...results);
prompt = {
name,
reasons: Object.keys(results),
details: assign(
{},
await promptDetails(ctx),
...Object.values(results).map((r) => r.details),
),
};
const [[, { error, description }]] = Object.entries(results);
failedCheck = {
error: error || 'interaction_required',
error_description: description || 'interaction is required from the end-user',
};
break;
}
}
// no interaction requested
if (!prompt) {
// check there's an accountId to continue
if (!oidc.session.accountId()) {
throw new errors.AccessDenied(undefined, 'request resolved without requesting interactions but no account id was resolved');
}
// check there's something granted to continue
// if only claims parameter is used then it must be combined with openid scope anyway
// when no scope paramater was provided and none is injected by the AS policy access is
// denied rather then issuing a code/token without scopes
if (!oidc.acceptedScope()) {
throw new errors.AccessDenied(undefined, 'request resolved without requesting interactions but scope was granted');
}
accepted('uid=%s %o', oidc.uid, oidc.params);
oidc.provider.emit('authorization.accepted', ctx);
await next();
return;
}
// if interaction needed but prompt=none => throw;
try {
if (oidc.promptPending('none')) {
const className = upperFirst(camelCase(failedCheck.error));
if (errors[className]) {
throw new errors[className](failedCheck.error_description);
} else {
ctx.throw(400, failedCheck.error, { error_description: failedCheck.error_description });
}
}
} catch (err) {
const code = /^(code|device)_/.test(oidc.route) ? 400 : 302;
err.status = code;
err.statusCode = code;
err.expose = true;
throw err;
}
const cookieOptions = instance(oidc.provider).configuration('cookies.short');
const returnTo = oidc.urlFor(resumeRouteName, {
uid: oidc.uid,
...(oidc.deviceCode ? { user_code: oidc.deviceCode.userCode } : undefined),
});
const interactionSession = new oidc.provider.Interaction(oidc.uid, {
returnTo,
prompt,
lastSubmission: oidc.result,
accountId: oidc.session.accountId(),
uid: oidc.uid,
params: oidc.params.toPlainObject(),
signed: oidc.signed,
session: oidc.session.accountId() ? {
accountId: oidc.session.accountId(),
...(oidc.session.uid ? { uid: oidc.session.uid } : undefined),
...(oidc.session.jti ? { cookie: oidc.session.jti } : undefined),
...(oidc.session.acr ? { acr: oidc.session.acr } : undefined),
...(oidc.session.amr ? { amr: oidc.session.amr } : undefined),
} : undefined,
});
await interactionSession.save(cookieOptions.maxAge / 1000);
const destination = await interactionUrl(ctx, interactionSession);
ssHandler.set(
ctx.oidc.cookies,
oidc.provider.cookieName('interaction'),
oidc.uid,
{ path: url.parse(destination).pathname, ...cookieOptions },
);
ssHandler.set(
ctx.oidc.cookies,
oidc.provider.cookieName('resume'),
oidc.uid,
{
...cookieOptions,
path: url.parse(returnTo).pathname,
domain: undefined,
httpOnly: true,
},
);
started('uid=%s interaction=%o', ctx.oidc.uid, interactionSession);
oidc.provider.emit('interaction.started', ctx, prompt);
ctx.redirect(destination);
};
| lib/actions/authorization/interactions.js | const url = require('url');
const camelCase = require('lodash/camelCase');
const assign = require('lodash/assign');
const upperFirst = require('lodash/upperFirst');
const Debug = require('debug');
const started = new Debug('oidc-provider:authentication:interrupted');
const accepted = new Debug('oidc-provider:authentication:accepted');
const ssHandler = require('../../helpers/samesite_handler');
const errors = require('../../helpers/errors');
const instance = require('../../helpers/weak_cache');
/* eslint-disable no-restricted-syntax, no-await-in-loop */
module.exports = async function interactions(resumeRouteName, ctx, next) {
const { oidc } = ctx;
let failedCheck;
let prompt;
const { policy, url: interactionUrl } = instance(oidc.provider).configuration('interactions');
for (const { name, checks, details: promptDetails } of policy) {
let results = (await Promise.all([...checks].map(async ({
reason, description, error, details, check,
}) => {
if (await check(ctx)) {
return {
[reason]: { error, description, details: await details(ctx) },
};
}
return undefined;
}))).filter(Boolean);
if (results.length) {
results = assign({}, ...results);
prompt = {
name,
reasons: Object.keys(results),
details: assign(
{},
await promptDetails(ctx),
...Object.values(results).map((r) => r.details),
),
};
const [[, { error, description }]] = Object.entries(results);
failedCheck = {
error: error || 'interaction_required',
error_description: description || 'interaction is required from the end-user',
};
break;
}
}
// no interaction requested
if (!prompt) {
// check there's an accountId to continue
if (!oidc.session.accountId()) {
throw new errors.AccessDenied(undefined, 'request resolved without requesting interactions but no account id was resolved');
}
// check there's something granted to continue
// if only claims parameter is used then it must be combined with openid scope anyway
// when no scope paramater was provided and none is injected by the AS policy access is
// denied rather then issuing a code/token without scopes
if (!oidc.acceptedScope()) {
throw new errors.AccessDenied(undefined, 'request resolved without requesting interactions but scope was granted');
}
accepted('uid=%s %o', oidc.uid, oidc.params);
oidc.provider.emit('authorization.accepted', ctx);
await next();
return;
}
// if interaction needed but prompt=none => throw;
try {
if (oidc.promptPending('none')) {
const className = upperFirst(camelCase(failedCheck.error));
if (errors[className]) {
throw new errors[className](failedCheck.error_description);
} else {
ctx.throw(400, failedCheck.error, { error_description: failedCheck.error_description });
}
}
} catch (err) {
const code = /^(code|device)_/.test(oidc.route) ? 400 : 302;
err.status = code;
err.statusCode = code;
err.expose = true;
throw err;
}
const cookieOptions = instance(oidc.provider).configuration('cookies.short');
const returnTo = oidc.urlFor(resumeRouteName, {
uid: oidc.uid,
...(oidc.deviceCode ? { user_code: oidc.deviceCode.userCode } : undefined),
});
const interactionSession = new oidc.provider.Interaction(oidc.uid, {
returnTo,
prompt,
lastSubmission: oidc.result,
accountId: oidc.session.accountId(),
uid: oidc.uid,
params: oidc.params.toPlainObject(),
signed: oidc.signed,
session: oidc.session.accountId() ? {
accountId: oidc.session.accountId(),
...(oidc.session.uid ? { uid: oidc.session.uid } : undefined),
...(oidc.session.jti ? { cookie: oidc.session.jti } : undefined),
...(oidc.session.acr ? { acr: oidc.session.acr } : undefined),
...(oidc.session.amr ? { amr: oidc.session.amr } : undefined),
} : undefined,
});
await interactionSession.save(cookieOptions.maxAge / 1000);
const destination = await interactionUrl(ctx, interactionSession);
ssHandler.set(
ctx.oidc.cookies,
oidc.provider.cookieName('interaction'),
oidc.uid,
{ path: url.parse(destination).pathname, ...cookieOptions },
);
ssHandler.set(
ctx.oidc.cookies,
oidc.provider.cookieName('resume'),
oidc.uid,
{ ...cookieOptions, path: url.parse(returnTo).pathname },
);
started('uid=%s interaction=%o', ctx.oidc.uid, interactionSession);
oidc.provider.emit('interaction.started', ctx, prompt);
ctx.redirect(destination);
};
| fix: ignore httpOnly and domain configuration options for resume cookies
fixes #574
| lib/actions/authorization/interactions.js | fix: ignore httpOnly and domain configuration options for resume cookies | <ide><path>ib/actions/authorization/interactions.js
<ide> ctx.oidc.cookies,
<ide> oidc.provider.cookieName('resume'),
<ide> oidc.uid,
<del> { ...cookieOptions, path: url.parse(returnTo).pathname },
<add> {
<add> ...cookieOptions,
<add> path: url.parse(returnTo).pathname,
<add> domain: undefined,
<add> httpOnly: true,
<add> },
<ide> );
<ide>
<ide> started('uid=%s interaction=%o', ctx.oidc.uid, interactionSession); |
|
Java | lgpl-2.1 | b3ce6d0eb741e7f3d8bb77dd92d457f85ac3aa99 | 0 | kohsah/exist,wshager/exist,shabanovd/exist,zwobit/exist,shabanovd/exist,RemiKoutcherawy/exist,ljo/exist,RemiKoutcherawy/exist,opax/exist,shabanovd/exist,ambs/exist,opax/exist,patczar/exist,opax/exist,olvidalo/exist,patczar/exist,RemiKoutcherawy/exist,jessealama/exist,joewiz/exist,jessealama/exist,windauer/exist,jensopetersen/exist,MjAbuz/exist,jessealama/exist,opax/exist,dizzzz/exist,ambs/exist,joewiz/exist,patczar/exist,ambs/exist,adamretter/exist,adamretter/exist,eXist-db/exist,windauer/exist,kohsah/exist,adamretter/exist,joewiz/exist,jessealama/exist,ambs/exist,ljo/exist,wolfgangmm/exist,hungerburg/exist,RemiKoutcherawy/exist,zwobit/exist,hungerburg/exist,dizzzz/exist,lcahlander/exist,ambs/exist,shabanovd/exist,ljo/exist,eXist-db/exist,kohsah/exist,shabanovd/exist,eXist-db/exist,opax/exist,dizzzz/exist,wolfgangmm/exist,adamretter/exist,eXist-db/exist,dizzzz/exist,RemiKoutcherawy/exist,zwobit/exist,zwobit/exist,eXist-db/exist,olvidalo/exist,jensopetersen/exist,jensopetersen/exist,adamretter/exist,zwobit/exist,wshager/exist,joewiz/exist,wshager/exist,olvidalo/exist,MjAbuz/exist,ljo/exist,RemiKoutcherawy/exist,patczar/exist,MjAbuz/exist,patczar/exist,wshager/exist,eXist-db/exist,wolfgangmm/exist,hungerburg/exist,dizzzz/exist,jessealama/exist,kohsah/exist,olvidalo/exist,wshager/exist,windauer/exist,wshager/exist,patczar/exist,wolfgangmm/exist,lcahlander/exist,wolfgangmm/exist,MjAbuz/exist,dizzzz/exist,ljo/exist,MjAbuz/exist,ambs/exist,kohsah/exist,wolfgangmm/exist,shabanovd/exist,joewiz/exist,olvidalo/exist,hungerburg/exist,jessealama/exist,joewiz/exist,windauer/exist,lcahlander/exist,lcahlander/exist,MjAbuz/exist,windauer/exist,lcahlander/exist,adamretter/exist,windauer/exist,ljo/exist,lcahlander/exist,jensopetersen/exist,hungerburg/exist,kohsah/exist,zwobit/exist,jensopetersen/exist,jensopetersen/exist | package org.exist.xqdoc;
import static org.junit.Assert.fail;
import java.io.File;
import org.exist.source.FileSource;
import org.exist.source.Source;
import org.exist.util.XMLFilenameFilter;
import org.exist.xmldb.DatabaseInstanceManager;
import org.exist.xmldb.XQueryService;
import org.exist.xmldb.XmldbURI;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xmldb.api.DatabaseManager;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.Database;
import org.xmldb.api.base.ResourceSet;
import org.xmldb.api.base.XMLDBException;
import org.xmldb.api.modules.CollectionManagementService;
import org.xmldb.api.modules.XMLResource;
public class RunTests {
private final static String TEST_DIR = "extensions/xqdoc/test/src/org/exist/xqdoc";
private final static String TEST_QUERY = TEST_DIR + "/runTests.xql";
private static File[] files;
private static Collection testCollection;
@Test
public void run() {
try {
XQueryService xqs = (XQueryService) testCollection.getService("XQueryService", "1.0");
Source query = new FileSource(new File(TEST_QUERY), "UTF-8", false);
for (File file : files) {
xqs.declareVariable("doc", file.getName());
ResourceSet result = xqs.execute(query);
XMLResource resource = (XMLResource) result.getResource(0);
System.out.println(resource.getContent());
Element root = (Element) resource.getContentAsDOM();
NodeList tests = root.getElementsByTagName("test");
for (int i = 0; i < tests.getLength(); i++) {
Element test = (Element) tests.item(i);
String passed = test.getAttribute("pass");
if (passed.equals("false")) {
System.err.println(resource.getContent());
fail("Test " + test.getAttribute("n") + " failed");
}
}
}
} catch (XMLDBException e) {
e.printStackTrace();
fail(e.getMessage());
}
}
@BeforeClass
public static void setUpBeforeClass() throws Exception {
// initialize driver
Class<?> cl = Class.forName("org.exist.xmldb.DatabaseImpl");
Database database = (Database) cl.newInstance();
database.setProperty("create-database", "true");
DatabaseManager.registerDatabase(database);
Collection root =
DatabaseManager.getCollection(XmldbURI.LOCAL_DB, "admin", "");
CollectionManagementService service =
(CollectionManagementService) root.getService("CollectionManagementService", "1.0");
testCollection = service.createCollection("test");
Assert.assertNotNull(testCollection);
File dir = new File(TEST_DIR);
files = dir.listFiles(new XMLFilenameFilter());
for (File file : files) {
XMLResource resource = (XMLResource) testCollection.createResource(file.getName(), "XMLResource");
resource.setContent(file);
testCollection.storeResource(resource);
}
}
@AfterClass
public static void tearDownAfterClass() {
files = null;
try {
Collection root =
DatabaseManager.getCollection(XmldbURI.LOCAL_DB, "admin", "");
DatabaseInstanceManager dim =
(DatabaseInstanceManager) root.getService(
"DatabaseInstanceManager", "1.0");
dim.shutdown();
} catch (Exception e) {
e.printStackTrace();
fail(e.getMessage());
}
testCollection = null;
}
}
| extensions/xqdoc/test/src/org/exist/xqdoc/RunTests.java | package org.exist.xqdoc;
import static org.junit.Assert.fail;
import java.io.File;
import org.exist.source.FileSource;
import org.exist.source.Source;
import org.exist.util.XMLFilenameFilter;
import org.exist.xmldb.DatabaseInstanceManager;
import org.exist.xmldb.XQueryService;
import org.exist.xmldb.XmldbURI;
import org.junit.AfterClass;
import org.junit.Assert;
import org.junit.BeforeClass;
import org.junit.Test;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.xmldb.api.DatabaseManager;
import org.xmldb.api.base.Collection;
import org.xmldb.api.base.Database;
import org.xmldb.api.base.ResourceSet;
import org.xmldb.api.base.XMLDBException;
import org.xmldb.api.modules.CollectionManagementService;
import org.xmldb.api.modules.XMLResource;
public class RunTests {
private final static String TEST_DIR = "extensions/xqdoc/test/src/org/exist/xqdoc";
private final static String TEST_QUERY = TEST_DIR + "/runTests.xql";
private static File[] files;
private static Collection testCollection;
@Test
public void run() {
try {
XQueryService xqs = (XQueryService) testCollection.getService("XQueryService", "1.0");
Source query = new FileSource(new File(TEST_QUERY), "UTF-8", false);
for (File file : files) {
xqs.declareVariable("doc", file.getName());
ResourceSet result = xqs.execute(query);
XMLResource resource = (XMLResource) result.getResource(0);
System.out.println(resource.getContent());
Element root = (Element) resource.getContentAsDOM();
NodeList tests = root.getElementsByTagName("test");
for (int i = 0; i < tests.getLength(); i++) {
Element test = (Element) tests.item(i);
String passed = test.getAttribute("pass");
if (passed.equals("false")) {
System.err.println(resource.getContent());
fail("Test " + test.getAttribute("n") + " failed");
}
}
}
} catch (XMLDBException e) {
e.printStackTrace();
fail(e.getMessage());
}
}
@BeforeClass
public static void setUpBeforeClass() throws Exception {
// initialize driver
Class<?> cl = Class.forName("org.exist.xmldb.DatabaseImpl");
Database database = (Database) cl.newInstance();
database.setProperty("create-database", "true");
DatabaseManager.registerDatabase(database);
Collection root =
DatabaseManager.getCollection(XmldbURI.LOCAL_DB, "admin", "");
CollectionManagementService service =
(CollectionManagementService) root.getService("CollectionManagementService", "1.0");
testCollection = service.createCollection("test");
Assert.assertNotNull(testCollection);
File dir = new File(TEST_DIR);
files = dir.listFiles(new XMLFilenameFilter());
for (File file : files) {
XMLResource resource = (XMLResource) testCollection.createResource(file.getName(), "XMLResource");
resource.setContent(file);
testCollection.storeResource(resource);
}
}
@AfterClass
public static void tearDownAfterClass() {
files = null;
try {
DatabaseInstanceManager dim =
(DatabaseInstanceManager) root.getService(
"DatabaseInstanceManager", "1.0");
dim.shutdown();
} catch (Exception e) {
e.printStackTrace();
fail(e.getMessage());
}
testCollection = null;
}
}
| [ignore] attempt 2
svn path=/trunk/eXist/; revision=17034
| extensions/xqdoc/test/src/org/exist/xqdoc/RunTests.java | [ignore] attempt 2 | <ide><path>xtensions/xqdoc/test/src/org/exist/xqdoc/RunTests.java
<ide> public static void tearDownAfterClass() {
<ide> files = null;
<ide> try {
<add> Collection root =
<add> DatabaseManager.getCollection(XmldbURI.LOCAL_DB, "admin", "");
<add>
<ide> DatabaseInstanceManager dim =
<ide> (DatabaseInstanceManager) root.getService(
<ide> "DatabaseInstanceManager", "1.0"); |
|
Java | apache-2.0 | 57c43eb4fe85f976644596e9bc077cf9a69274af | 0 | diffplug/durian-swt,diffplug/durian-swt | /*
* Copyright 2015 DiffPlug
*
* 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.diffplug.common.swt;
import java.util.Collection;
import java.util.stream.Stream;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;
import rx.Observable;
import rx.subjects.PublishSubject;
import com.google.common.base.Preconditions;
import com.google.common.primitives.Ints;
import com.diffplug.common.rx.RxBox;
/** Utilities that convert SWT events into Rx-friendly Observables. */
public class SwtRx {
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, int... events) {
return addListener(widget, Ints.asList(events));
}
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, Collection<Integer> events) {
return addListener(widget, events.stream());
}
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, Stream<Integer> events) {
PublishSubject<Event> subject = PublishSubject.create();
events.forEach(event -> widget.addListener(event, subject::onNext));
return subject.asObservable();
}
/** Returns an {@link Observable}<{@link Point}> of the right-click mouse-up on the given control, in global coordinates. */
public static Observable<Point> rightClickGlobal(Control ctl) {
return rightClickLocal(ctl).map(ctl::toDisplay);
}
/** Returns an {@link Observable}<{@link Point}> of the right-click mouse-up on the given control, in local coordinates. */
public static Observable<Point> rightClickLocal(Control ctl) {
PublishSubject<Point> observable = PublishSubject.create();
ctl.addListener(SWT.MouseUp, e -> {
if (e.button == 3) {
observable.onNext(new Point(e.x, e.y));
}
});
return observable;
}
/** Returns an RxBox<String> which contains the content of the text box. */
public static RxBox<String> textImmediate(Text text) {
return textImp(text, SWT.Modify);
}
/**
* Returns an RxBox<String> which contains the content of the text box
* only when it has been confirmed by:
* <ul>
* <li>programmer setting the RxBox</li>
* <li>user hitting enter</li>
* <li>focus leaving the text</li>
* </ul>
*/
public static RxBox<String> textConfirmed(Text text) {
return textImp(text, SWT.DefaultSelection, SWT.FocusOut);
}
private static RxBox<String> textImp(Text text, int... events) {
RxBox<String> box = RxBox.of(text.getText());
// set the text when the box changes
SwtExec.immediate().guardOn(text).subscribe(box, str -> {
Point selection = text.getSelection();
text.setText(str);
text.setSelection(selection);
});
// set the box when the text changes
Listener listener = e -> box.set(text.getText());
for (int event : events) {
text.addListener(event, listener);
}
return box;
}
/**
* Returns an {@code RxBox<Boolean>} for the toggle state of the given button as an RxBox.
* <p>
* Applicable to SWT.TOGGLE, SWT.CHECK, and SWT.RADIO.
*/
public static RxBox<Boolean> toggle(Button btn) {
Preconditions.checkArgument(SwtMisc.flagIsSet(SWT.TOGGLE, btn) || SwtMisc.flagIsSet(SWT.CHECK, btn) || SwtMisc.flagIsSet(SWT.RADIO, btn));
RxBox<Boolean> box = RxBox.of(btn.getSelection());
// update the box when a click happens
btn.addListener(SWT.Selection, e -> {
box.set(!box.get());
});
// update the button when the box happens
SwtExec.immediate().guardOn(btn).subscribe(box, btn::setSelection);
return box;
}
}
| src/com/diffplug/common/swt/SwtRx.java | /*
* Copyright 2015 DiffPlug
*
* 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.diffplug.common.swt;
import java.util.Collection;
import java.util.stream.Stream;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Listener;
import org.eclipse.swt.widgets.Text;
import org.eclipse.swt.widgets.Widget;
import rx.Observable;
import rx.subjects.PublishSubject;
import com.google.common.base.Preconditions;
import com.google.common.primitives.Ints;
import com.diffplug.common.rx.RxBox;
/** Utilities that convert SWT events into Rx-friendly Observables. */
public class SwtRx {
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, int... events) {
return addListener(widget, Ints.asList(events));
}
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, Collection<Integer> events) {
return addListener(widget, events.stream());
}
/** Subscribes to the given widget and pipes the events to an {@link Observable}<{@link Event}>. */
public static Observable<Event> addListener(Widget widget, Stream<Integer> events) {
PublishSubject<Event> subject = PublishSubject.create();
events.forEach(event -> widget.addListener(event, subject::onNext));
return subject.asObservable();
}
/** Returns an {@link Observable}<{@link Point}> of the right-click mouse-up on the given control, in global coordinates. */
public static Observable<Point> rightClickGlobal(Control ctl) {
return rightClickLocal(ctl).map(ctl::toDisplay);
}
/** Returns an {@link Observable}<{@link Point}> of the right-click mouse-up on the given control, in local coordinates. */
public static Observable<Point> rightClickLocal(Control ctl) {
PublishSubject<Point> observable = PublishSubject.create();
ctl.addListener(SWT.MouseUp, e -> {
if (e.button == 3) {
observable.onNext(new Point(e.x, e.y));
}
});
return observable;
}
/** Returns an RxBox<String> which contains the content of the text box. */
public static RxBox<String> textImmediate(Text text) {
return textImp(text, SWT.Modify);
}
/**
* Returns an RxBox<String> which contains the content of the text box
* only when it has been confirmed by:
* <ul>
* <li>programmer setting the RxBox</li>
* <li>user hitting enter</li>
* <li>focus leaving the text</li>
* </ul>
*/
public static RxBox<String> textConfirmed(Text text) {
return textImp(text, SWT.DefaultSelection, SWT.FocusOut);
}
private static RxBox<String> textImp(Text text, int... events) {
RxBox<String> box = RxBox.of(text.getText());
// set the text when the box changes
SwtExec.immediate().guardOn(text).subscribe(box, str -> {
Point selection = text.getSelection();
text.setText(str);
text.setSelection(selection);
});
// set the box when the text changes
Listener listener = e -> box.set(text.getText());
for (int event : events) {
text.addListener(event, listener);
}
return box;
}
/** Returns an {@code RxBox<Boolean>} for the toggle state of the given button as an RxBox. */
public static RxBox<Boolean> toggle(Button btn) {
Preconditions.checkArgument(SwtMisc.flagIsSet(SWT.TOGGLE, btn) || SwtMisc.flagIsSet(SWT.CHECK, btn));
RxBox<Boolean> box = RxBox.of(btn.getSelection());
// update the box when a click happens
btn.addListener(SWT.Selection, e -> {
box.set(!box.get());
});
// update the button when the box happens
SwtExec.immediate().guardOn(btn).subscribe(box, btn::setSelection);
return box;
}
}
| SwtRx.toggle() can now work with SWT.RADIO buttons. | src/com/diffplug/common/swt/SwtRx.java | SwtRx.toggle() can now work with SWT.RADIO buttons. | <ide><path>rc/com/diffplug/common/swt/SwtRx.java
<ide> return box;
<ide> }
<ide>
<del> /** Returns an {@code RxBox<Boolean>} for the toggle state of the given button as an RxBox. */
<add> /**
<add> * Returns an {@code RxBox<Boolean>} for the toggle state of the given button as an RxBox.
<add> * <p>
<add> * Applicable to SWT.TOGGLE, SWT.CHECK, and SWT.RADIO.
<add> */
<ide> public static RxBox<Boolean> toggle(Button btn) {
<del> Preconditions.checkArgument(SwtMisc.flagIsSet(SWT.TOGGLE, btn) || SwtMisc.flagIsSet(SWT.CHECK, btn));
<add> Preconditions.checkArgument(SwtMisc.flagIsSet(SWT.TOGGLE, btn) || SwtMisc.flagIsSet(SWT.CHECK, btn) || SwtMisc.flagIsSet(SWT.RADIO, btn));
<ide> RxBox<Boolean> box = RxBox.of(btn.getSelection());
<ide> // update the box when a click happens
<ide> btn.addListener(SWT.Selection, e -> { |
|
Java | bsd-3-clause | 13d527eb38d0e2c8fe240688f2b9a95e1d0f8fa2 | 0 | NCIP/cagrid-core,NCIP/cagrid-core,NCIP/cagrid-core,NCIP/cagrid-core | package gov.nih.nci.cagrid.fqp.common;
import gov.nih.nci.cagrid.cqlquery.Attribute;
import gov.nih.nci.cagrid.cqlquery.LogicalOperator;
import gov.nih.nci.cagrid.cqlquery.Predicate;
import gov.nih.nci.cagrid.dcql.Association;
import gov.nih.nci.cagrid.dcql.ForeignAssociation;
import gov.nih.nci.cagrid.dcql.ForeignPredicate;
import gov.nih.nci.cagrid.dcql.Group;
import gov.nih.nci.cagrid.dcql.Object;
import gov.nih.nci.cagrid.dcqlresult.DCQLQueryResultsCollection;
import gov.nih.nci.cagrid.dcqlresult.DCQLResult;
import gov.nih.nci.cagrid.metadata.common.UMLAttribute;
import gov.nih.nci.cagrid.metadata.common.UMLClass;
import gov.nih.nci.cagrid.metadata.dataservice.DomainModel;
import java.text.DateFormat;
import java.text.ParseException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.cagrid.cql.utilities.CQL2ResultsToCQL1ResultsConverter;
import org.cagrid.cql.utilities.ResultsConversionException;
import org.cagrid.cql2.AttributeValue;
import org.cagrid.cql2.BinaryPredicate;
import org.cagrid.cql2.CQLAttribute;
import org.cagrid.cql2.GroupLogicalOperator;
import org.cagrid.cql2.UnaryPredicate;
import org.cagrid.data.dcql.DCQLAssociatedObject;
import org.cagrid.data.dcql.DCQLGroup;
import org.cagrid.data.dcql.DCQLObject;
import org.cagrid.data.dcql.DCQLQuery;
import org.cagrid.data.dcql.ForeignAssociatedObject;
import org.cagrid.data.dcql.JoinCondition;
/**
* DCQLConverter
*
* Utility to convert DCQL and DCQL results between versions 1 and 2
*
* @author David
*/
public class DCQLConverter {
private static Map<Predicate, BinaryPredicate> binaryPredicateConversion = null;
private static Map<Predicate, UnaryPredicate> unaryPredicateConversion = null;
private static Map<ForeignPredicate, BinaryPredicate> foreignPredicateConversion = null;
static {
binaryPredicateConversion = new HashMap<Predicate, BinaryPredicate>();
unaryPredicateConversion = new HashMap<Predicate, UnaryPredicate>();
foreignPredicateConversion = new HashMap<ForeignPredicate, BinaryPredicate>();
binaryPredicateConversion.put(Predicate.EQUAL_TO, BinaryPredicate.EQUAL_TO);
binaryPredicateConversion.put(Predicate.GREATER_THAN, BinaryPredicate.GREATER_THAN);
binaryPredicateConversion.put(Predicate.GREATER_THAN_EQUAL_TO, BinaryPredicate.GREATER_THAN_EQUAL_TO);
binaryPredicateConversion.put(Predicate.LESS_THAN, BinaryPredicate.LESS_THAN);
binaryPredicateConversion.put(Predicate.LESS_THAN_EQUAL_TO, BinaryPredicate.LESS_THAN_EQUAL_TO);
binaryPredicateConversion.put(Predicate.LIKE, BinaryPredicate.LIKE);
binaryPredicateConversion.put(Predicate.NOT_EQUAL_TO, BinaryPredicate.NOT_EQUAL_TO);
unaryPredicateConversion.put(Predicate.IS_NOT_NULL, UnaryPredicate.IS_NOT_NULL);
unaryPredicateConversion.put(Predicate.IS_NULL, UnaryPredicate.IS_NULL);
foreignPredicateConversion.put(ForeignPredicate.EQUAL_TO, BinaryPredicate.EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.NOT_EQUAL_TO, BinaryPredicate.NOT_EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.GREATER_THAN, BinaryPredicate.GREATER_THAN);
foreignPredicateConversion.put(ForeignPredicate.GREATER_THAN_EQUAL_TO, BinaryPredicate.GREATER_THAN_EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.LESS_THAN, BinaryPredicate.LESS_THAN);
foreignPredicateConversion.put(ForeignPredicate.LESS_THAN_EQUAL_TO, BinaryPredicate.LESS_THAN_EQUAL_TO);
}
private DomainModelLocator modelLocator = null;
public DCQLConverter() {
this(new DefaultDomainModelLocator());
}
public DCQLConverter(DomainModelLocator modelLocator) {
this.modelLocator = modelLocator;
}
public DCQLQuery convertToDcql2(gov.nih.nci.cagrid.dcql.DCQLQuery oldQuery) throws DCQLConversionException {
DCQLQuery query = new DCQLQuery();
// target service URLs
query.setTargetServiceURL(oldQuery.getTargetServiceURL());
// target object
DCQLObject target = convertToDcql2Object(oldQuery.getTargetServiceURL(0), oldQuery.getTargetObject());
query.setTargetObject(target);
return query;
}
private DCQLObject convertToDcql2Object(String targetServiceUrl, Object oldObject) throws DCQLConversionException {
DCQLObject object = new DCQLObject();
object.setName(oldObject.getName());
if (oldObject.getAssociation() != null) {
object.setAssociatedObject(convertToDcql2Association(
targetServiceUrl, oldObject.getAssociation()));
} else if (oldObject.getAttribute() != null) {
object.setAttribute(convertToCql2Attribute(
targetServiceUrl, object.getName(), oldObject.getAttribute()));
} else if (oldObject.getGroup() != null) {
object.setGroup(convertToDcql2Group(
targetServiceUrl, object.getName(), oldObject.getGroup()));
} else if (oldObject.getForeignAssociation() != null) {
object.setForeignAssociatedObject(
convertToDcql2ForeignAssociation(
oldObject.getForeignAssociation()));
}
return object;
}
private DCQLAssociatedObject convertToDcql2Association(String targetServiceUrl, Association oldAssociation)
throws DCQLConversionException {
DCQLObject object = convertToDcql2Object(targetServiceUrl, oldAssociation);
DCQLAssociatedObject association = new DCQLAssociatedObject();
association.setName(object.getName());
association.setEndName(oldAssociation.getRoleName());
association.setAssociatedObject(object.getAssociatedObject());
association.setGroup(object.getGroup());
association.setAttribute(object.getAttribute());
return association;
}
private CQLAttribute convertToCql2Attribute(String targetServiceUrl, String className, Attribute oldAttribute)
throws DCQLConversionException {
CQLAttribute attribute = new CQLAttribute();
attribute.setName(oldAttribute.getName());
Predicate oldPredicate = oldAttribute.getPredicate();
if (unaryPredicateConversion.containsKey(oldPredicate)) {
attribute.setUnaryPredicate(unaryPredicateConversion.get(oldPredicate));
} else {
attribute.setBinaryPredicate(binaryPredicateConversion.get(oldPredicate));
String oldValue = oldAttribute.getValue();
AttributeValue value = convertAttributeValue(
targetServiceUrl, className, oldAttribute.getName(), oldValue);
attribute.setAttributeValue(value);
}
return attribute;
}
private AttributeValue convertAttributeValue(
String targetServiceUrl, String className, String attributeName, String rawValue)
throws DCQLConversionException {
String datatypeName = null;
DomainModel model = null;
try {
model = modelLocator.getDomainModel(targetServiceUrl);
} catch (Exception ex) {
throw new DCQLConversionException(
"Error locating domain model for service " + targetServiceUrl + ": " + ex.getMessage(), ex);
}
UMLClass[] classes = model.getExposedUMLClassCollection().getUMLClass();
for (UMLClass c : classes) {
String fqName = c.getClassName();
if (c.getPackageName() != null && c.getPackageName().length() != 0) {
fqName = c.getPackageName() + "." + c.getClassName();
}
if (className.equals(fqName)) {
for (UMLAttribute att : c.getUmlAttributeCollection().getUMLAttribute()) {
if (attributeName.equals(att.getName())) {
datatypeName = att.getDataTypeName();
break;
}
}
}
}
AttributeValue val = new AttributeValue();
if (datatypeName != null) {
if (String.class.getName().equals(datatypeName)) {
val.setStringValue(rawValue);
} else if (Boolean.class.getName().equals(datatypeName)) {
val.setBooleanValue(Boolean.valueOf(rawValue));
} else if (Date.class.getName().equals(datatypeName)) {
Date date = null;
try {
date = DateFormat.getDateInstance().parse(rawValue);
} catch (ParseException ex) {
throw new DCQLConversionException(
"Error converting value " + rawValue + " to date: " + ex.getMessage(), ex);
}
val.setDateValue(date);
} else if (Integer.class.getName().equals(datatypeName)) {
val.setIntegerValue(Integer.valueOf(rawValue));
} else if (Long.class.getName().equals(datatypeName)) {
val.setLongValue(Long.valueOf(rawValue));
} else if (Double.class.getName().equals(datatypeName)) {
val.setDoubleValue(Double.valueOf(rawValue));
}
}
return val;
}
private DCQLGroup convertToDcql2Group(String targetServiceUrl, String className, Group oldGroup)
throws DCQLConversionException {
DCQLGroup group = new DCQLGroup();
group.setLogicalOperation(LogicalOperator.AND.equals(
oldGroup.getLogicRelation()) ?
GroupLogicalOperator.AND : GroupLogicalOperator.OR);
if (oldGroup.getAssociation() != null && oldGroup.getAssociation().length != 0) {
DCQLAssociatedObject[] associations = new DCQLAssociatedObject[oldGroup.getAssociation().length];
for (int i = 0; i < oldGroup.getAssociation().length; i++) {
associations[i] = convertToDcql2Association(targetServiceUrl, oldGroup.getAssociation(i));
}
group.setAssociatedObject(associations);
}
if (oldGroup.getAttribute() != null && oldGroup.getAttribute().length != 0) {
CQLAttribute[] attributes = new CQLAttribute[oldGroup.getAttribute().length];
for (int i = 0; i < oldGroup.getAttribute().length; i++) {
attributes[i] = convertToCql2Attribute(targetServiceUrl, className, oldGroup.getAttribute(i));
}
group.setAttribute(attributes);
}
if (oldGroup.getGroup() != null && oldGroup.getGroup().length != 0) {
DCQLGroup groups[] = new DCQLGroup[oldGroup.getGroup().length];
for (int i = 0; i < oldGroup.getGroup().length; i++) {
groups[i] = convertToDcql2Group(targetServiceUrl, className, oldGroup.getGroup(i));
}
group.setGroup(groups);
}
if (oldGroup.getForeignAssociation() != null && oldGroup.getForeignAssociation().length != 0) {
ForeignAssociatedObject[] foreignAssociations = new ForeignAssociatedObject[oldGroup.getForeignAssociation().length];
for (int i = 0; i < oldGroup.getForeignAssociation().length; i++) {
foreignAssociations[i] = convertToDcql2ForeignAssociation(oldGroup.getForeignAssociation(i));
}
group.setForeignAssociatedObject(foreignAssociations);
}
return group;
}
private ForeignAssociatedObject convertToDcql2ForeignAssociation(ForeignAssociation oldForeignAssociation)
throws DCQLConversionException {
ForeignAssociatedObject foreign = new ForeignAssociatedObject();
foreign.setTargetServiceURL(oldForeignAssociation.getTargetServiceURL());
DCQLObject object = convertToDcql2Object(
oldForeignAssociation.getTargetServiceURL(), oldForeignAssociation.getForeignObject());
foreign.setName(object.getName());
foreign.setAssociatedObject(object.getAssociatedObject());
foreign.setAttribute(object.getAttribute());
foreign.setGroup(object.getGroup());
foreign.setForeignAssociatedObject(object.getForeignAssociatedObject());
foreign.setJoinCondition(convertToDcql2Join(oldForeignAssociation.getJoinCondition()));
return foreign;
}
private JoinCondition convertToDcql2Join(gov.nih.nci.cagrid.dcql.JoinCondition oldJoin) {
JoinCondition join = new JoinCondition();
join.setForeignAttributeName(oldJoin.getForeignAttributeName());
join.setLocalAttributeName(oldJoin.getLocalAttributeName());
if (oldJoin.getPredicate() != null) {
join.setPredicate(foreignPredicateConversion.get(oldJoin.getPredicate()));
} else {
// predicate is optional in DCQL 1, default is EQUAL_TO
join.setPredicate(BinaryPredicate.EQUAL_TO);
}
return join;
}
public DCQLQueryResultsCollection convertToDcqlQueryResults(org.cagrid.data.dcql.results.DCQLQueryResultsCollection results) throws DCQLConversionException {
DCQLQueryResultsCollection oldResultsCollection = new DCQLQueryResultsCollection();
if (results.getDCQLResult() != null) {
DCQLResult[] oldResults = new DCQLResult[results.getDCQLResult().length];
for (int i = 0; i < results.getDCQLResult().length; i++) {
oldResults[i] = convertToDcqlResult(results.getDCQLResult(i));
}
oldResultsCollection.setDCQLResult(oldResults);
}
return oldResultsCollection;
}
private DCQLResult convertToDcqlResult(org.cagrid.data.dcql.results.DCQLResult result) throws DCQLConversionException {
DCQLResult oldResult = new DCQLResult();
oldResult.setTargetServiceURL(result.getTargetServiceURL());
try {
gov.nih.nci.cagrid.cqlresultset.CQLQueryResults cqlResult =
CQL2ResultsToCQL1ResultsConverter.convertResults(result.getCQLQueryResults());
oldResult.setCQLQueryResultCollection(cqlResult);
} catch (ResultsConversionException ex) {
throw new DCQLConversionException("Error converting inner CQL query results: " + ex.getMessage(), ex);
}
return oldResult;
}
}
| caGrid/projects/fqp/src/gov/nih/nci/cagrid/fqp/common/DCQLConverter.java | package gov.nih.nci.cagrid.fqp.common;
import gov.nih.nci.cagrid.cqlquery.Attribute;
import gov.nih.nci.cagrid.cqlquery.LogicalOperator;
import gov.nih.nci.cagrid.cqlquery.Predicate;
import gov.nih.nci.cagrid.dcql.Association;
import gov.nih.nci.cagrid.dcql.ForeignAssociation;
import gov.nih.nci.cagrid.dcql.ForeignPredicate;
import gov.nih.nci.cagrid.dcql.Group;
import gov.nih.nci.cagrid.dcql.Object;
import gov.nih.nci.cagrid.dcqlresult.DCQLQueryResultsCollection;
import gov.nih.nci.cagrid.dcqlresult.DCQLResult;
import gov.nih.nci.cagrid.metadata.common.UMLAttribute;
import gov.nih.nci.cagrid.metadata.common.UMLClass;
import gov.nih.nci.cagrid.metadata.dataservice.DomainModel;
import java.text.DateFormat;
import java.text.ParseException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import org.cagrid.cql.utilities.CQL2ResultsToCQL1ResultsConverter;
import org.cagrid.cql.utilities.ResultsConversionException;
import org.cagrid.cql2.AttributeValue;
import org.cagrid.cql2.BinaryPredicate;
import org.cagrid.cql2.CQLAttribute;
import org.cagrid.cql2.GroupLogicalOperator;
import org.cagrid.cql2.UnaryPredicate;
import org.cagrid.data.dcql.DCQLAssociatedObject;
import org.cagrid.data.dcql.DCQLGroup;
import org.cagrid.data.dcql.DCQLObject;
import org.cagrid.data.dcql.DCQLQuery;
import org.cagrid.data.dcql.ForeignAssociatedObject;
import org.cagrid.data.dcql.JoinCondition;
/**
* DCQLConverter
*
* Utility to convert DCQL and DCQL results between versions 1 and 2
*
* @author David
*/
public class DCQLConverter {
private static Map<Predicate, BinaryPredicate> binaryPredicateConversion = null;
private static Map<Predicate, UnaryPredicate> unaryPredicateConversion = null;
private static Map<ForeignPredicate, BinaryPredicate> foreignPredicateConversion = null;
static {
binaryPredicateConversion = new HashMap<Predicate, BinaryPredicate>();
unaryPredicateConversion = new HashMap<Predicate, UnaryPredicate>();
foreignPredicateConversion = new HashMap<ForeignPredicate, BinaryPredicate>();
binaryPredicateConversion.put(Predicate.EQUAL_TO, BinaryPredicate.EQUAL_TO);
binaryPredicateConversion.put(Predicate.GREATER_THAN, BinaryPredicate.GREATER_THAN);
binaryPredicateConversion.put(Predicate.GREATER_THAN_EQUAL_TO, BinaryPredicate.GREATER_THAN_EQUAL_TO);
binaryPredicateConversion.put(Predicate.LESS_THAN, BinaryPredicate.LESS_THAN);
binaryPredicateConversion.put(Predicate.LESS_THAN_EQUAL_TO, BinaryPredicate.LESS_THAN_EQUAL_TO);
binaryPredicateConversion.put(Predicate.LIKE, BinaryPredicate.LIKE);
binaryPredicateConversion.put(Predicate.NOT_EQUAL_TO, BinaryPredicate.NOT_EQUAL_TO);
unaryPredicateConversion.put(Predicate.IS_NOT_NULL, UnaryPredicate.IS_NOT_NULL);
unaryPredicateConversion.put(Predicate.IS_NULL, UnaryPredicate.IS_NULL);
foreignPredicateConversion.put(ForeignPredicate.EQUAL_TO, BinaryPredicate.EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.NOT_EQUAL_TO, BinaryPredicate.NOT_EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.GREATER_THAN, BinaryPredicate.GREATER_THAN);
foreignPredicateConversion.put(ForeignPredicate.GREATER_THAN_EQUAL_TO, BinaryPredicate.GREATER_THAN_EQUAL_TO);
foreignPredicateConversion.put(ForeignPredicate.LESS_THAN, BinaryPredicate.LESS_THAN);
foreignPredicateConversion.put(ForeignPredicate.LESS_THAN_EQUAL_TO, BinaryPredicate.LESS_THAN_EQUAL_TO);
}
private DomainModelLocator modelLocator = null;
public DCQLConverter() {
this(new DefaultDomainModelLocator());
}
public DCQLConverter(DomainModelLocator modelLocator) {
this.modelLocator = modelLocator;
}
public DCQLQuery convertToDcql2(gov.nih.nci.cagrid.dcql.DCQLQuery oldQuery) throws DCQLConversionException {
DCQLQuery query = new DCQLQuery();
// target service URLs
query.setTargetServiceURL(oldQuery.getTargetServiceURL());
// target object
DCQLObject target = convertToDcql2Object(oldQuery.getTargetServiceURL(0), oldQuery.getTargetObject());
query.setTargetObject(target);
return query;
}
private DCQLObject convertToDcql2Object(String targetServiceUrl, Object oldObject) throws DCQLConversionException {
DCQLObject object = new DCQLObject();
object.setName(oldObject.getName());
if (oldObject.getAssociation() != null) {
object.setAssociatedObject(convertToDcql2Association(
targetServiceUrl, oldObject.getAssociation()));
} else if (oldObject.getAttribute() != null) {
object.setAttribute(convertToCql2Attribute(
targetServiceUrl, object.getName(), oldObject.getAttribute()));
} else if (oldObject.getGroup() != null) {
object.setGroup(convertToDcql2Group(
targetServiceUrl, object.getName(), oldObject.getGroup()));
} else if (oldObject.getForeignAssociation() != null) {
object.setForeignAssociatedObject(
convertToDcql2ForeignAssociation(
oldObject.getForeignAssociation()));
}
return object;
}
private DCQLAssociatedObject convertToDcql2Association(String targetServiceUrl, Association oldAssociation)
throws DCQLConversionException {
DCQLObject object = convertToDcql2Object(targetServiceUrl, oldAssociation);
DCQLAssociatedObject association = new DCQLAssociatedObject();
association.setName(object.getName());
association.setEndName(oldAssociation.getRoleName());
association.setAssociatedObject(object.getAssociatedObject());
association.setGroup(object.getGroup());
association.setAttribute(object.getAttribute());
return association;
}
private CQLAttribute convertToCql2Attribute(String targetServiceUrl, String className, Attribute oldAttribute)
throws DCQLConversionException {
CQLAttribute attribute = new CQLAttribute();
attribute.setName(oldAttribute.getName());
Predicate oldPredicate = oldAttribute.getPredicate();
if (unaryPredicateConversion.containsKey(oldPredicate)) {
attribute.setUnaryPredicate(unaryPredicateConversion.get(oldPredicate));
} else {
attribute.setBinaryPredicate(binaryPredicateConversion.get(oldPredicate));
String oldValue = oldAttribute.getValue();
AttributeValue value = convertAttributeValue(
targetServiceUrl, className, oldAttribute.getName(), oldValue);
attribute.setAttributeValue(value);
}
return attribute;
}
private AttributeValue convertAttributeValue(
String targetServiceUrl, String className, String attributeName, String rawValue)
throws DCQLConversionException {
String datatypeName = null;
DomainModel model = null;
try {
model = modelLocator.getDomainModel(targetServiceUrl);
} catch (Exception ex) {
throw new DCQLConversionException(
"Error locating domain model for service " + targetServiceUrl + ": " + ex.getMessage(), ex);
}
UMLClass[] classes = model.getExposedUMLClassCollection().getUMLClass();
for (UMLClass c : classes) {
String fqName = c.getClassName();
if (c.getPackageName() != null && c.getPackageName().length() != 0) {
fqName = c.getPackageName() + "." + c.getClassName();
}
if (className.equals(fqName)) {
for (UMLAttribute att : c.getUmlAttributeCollection().getUMLAttribute()) {
if (attributeName.equals(att.getName())) {
datatypeName = att.getDataTypeName();
break;
}
}
}
}
AttributeValue val = new AttributeValue();
if (datatypeName != null) {
if (String.class.getName().equals(datatypeName)) {
val.setStringValue(rawValue);
} else if (Boolean.class.getName().equals(datatypeName)) {
val.setBooleanValue(Boolean.valueOf(rawValue));
} else if (Date.class.getName().equals(datatypeName)) {
Date date = null;
try {
date = DateFormat.getDateInstance().parse(rawValue);
} catch (ParseException ex) {
throw new DCQLConversionException(
"Error converting value " + rawValue + " to date: " + ex.getMessage(), ex);
}
val.setDateValue(date);
} else if (Integer.class.getName().equals(datatypeName)) {
val.setIntegerValue(Integer.valueOf(rawValue));
} else if (Long.class.getName().equals(datatypeName)) {
val.setLongValue(Long.valueOf(rawValue));
} else if (Double.class.getName().equals(datatypeName)) {
val.setDoubleValue(Double.valueOf(rawValue));
}
}
return val;
}
private DCQLGroup convertToDcql2Group(String targetServiceUrl, String className, Group oldGroup)
throws DCQLConversionException {
DCQLGroup group = new DCQLGroup();
group.setLogicalOperation(LogicalOperator.AND.equals(
oldGroup.getLogicRelation()) ?
GroupLogicalOperator.AND : GroupLogicalOperator.OR);
if (oldGroup.getAssociation() != null && oldGroup.getAssociation().length != 0) {
DCQLAssociatedObject[] associations = new DCQLAssociatedObject[oldGroup.getAssociation().length];
for (int i = 0; i < oldGroup.getAssociation().length; i++) {
associations[i] = convertToDcql2Association(targetServiceUrl, oldGroup.getAssociation(i));
}
group.setAssociatedObject(associations);
}
if (oldGroup.getAttribute() != null && oldGroup.getAttribute().length != 0) {
CQLAttribute[] attributes = new CQLAttribute[oldGroup.getAttribute().length];
for (int i = 0; i < oldGroup.getAttribute().length; i++) {
attributes[i] = convertToCql2Attribute(targetServiceUrl, className, oldGroup.getAttribute(i));
}
group.setAttribute(attributes);
}
if (oldGroup.getGroup() != null && oldGroup.getGroup().length != 0) {
DCQLGroup groups[] = new DCQLGroup[oldGroup.getGroup().length];
for (int i = 0; i < oldGroup.getGroup().length; i++) {
groups[i] = convertToDcql2Group(targetServiceUrl, className, oldGroup.getGroup(i));
}
group.setGroup(groups);
}
if (oldGroup.getForeignAssociation() != null && oldGroup.getForeignAssociation().length != 0) {
ForeignAssociatedObject[] foreignAssociations = new ForeignAssociatedObject[oldGroup.getForeignAssociation().length];
for (int i = 0; i < oldGroup.getForeignAssociation().length; i++) {
foreignAssociations[i] = convertToDcql2ForeignAssociation(oldGroup.getForeignAssociation(i));
}
group.setForeignAssociatedObject(foreignAssociations);
}
return group;
}
private ForeignAssociatedObject convertToDcql2ForeignAssociation(ForeignAssociation oldForeignAssociation)
throws DCQLConversionException {
ForeignAssociatedObject foreign = new ForeignAssociatedObject();
foreign.setTargetServiceURL(oldForeignAssociation.getTargetServiceURL());
DCQLObject object = convertToDcql2Object(
oldForeignAssociation.getTargetServiceURL(), oldForeignAssociation.getForeignObject());
foreign.setName(object.getName());
foreign.setAssociatedObject(object.getAssociatedObject());
foreign.setAttribute(object.getAttribute());
foreign.setGroup(object.getGroup());
foreign.setForeignAssociatedObject(object.getForeignAssociatedObject());
foreign.setJoinCondition(convertToDcql2Join(oldForeignAssociation.getJoinCondition()));
return foreign;
}
private JoinCondition convertToDcql2Join(gov.nih.nci.cagrid.dcql.JoinCondition oldJoin) {
JoinCondition join = new JoinCondition();
join.setForeignAttributeName(oldJoin.getForeignAttributeName());
join.setLocalAttributeName(oldJoin.getLocalAttributeName());
join.setPredicate(foreignPredicateConversion.get(oldJoin.getPredicate()));
return join;
}
public DCQLQueryResultsCollection convertToDcqlQueryResults(org.cagrid.data.dcql.results.DCQLQueryResultsCollection results) throws DCQLConversionException {
DCQLQueryResultsCollection oldResultsCollection = new DCQLQueryResultsCollection();
if (results.getDCQLResult() != null) {
DCQLResult[] oldResults = new DCQLResult[results.getDCQLResult().length];
for (int i = 0; i < results.getDCQLResult().length; i++) {
oldResults[i] = convertToDcqlResult(results.getDCQLResult(i));
}
}
results.getDCQLResult();
return oldResultsCollection;
}
private DCQLResult convertToDcqlResult(org.cagrid.data.dcql.results.DCQLResult result) throws DCQLConversionException {
DCQLResult oldResult = new DCQLResult();
oldResult.setTargetServiceURL(result.getTargetServiceURL());
try {
gov.nih.nci.cagrid.cqlresultset.CQLQueryResults cqlResult =
CQL2ResultsToCQL1ResultsConverter.convertResults(result.getCQLQueryResults());
oldResult.setCQLQueryResultCollection(cqlResult);
} catch (ResultsConversionException ex) {
throw new DCQLConversionException("Error converting inner CQL query results: " + ex.getMessage(), ex);
}
return oldResult;
}
}
| CAGRID-264: Fixing this up
git-svn-id: bfb4fccd43670159d66a456bef71e1335c6a6a12@15748 dd7b0c16-3c94-4492-92de-414b6a06f0b1
| caGrid/projects/fqp/src/gov/nih/nci/cagrid/fqp/common/DCQLConverter.java | CAGRID-264: Fixing this up | <ide><path>aGrid/projects/fqp/src/gov/nih/nci/cagrid/fqp/common/DCQLConverter.java
<ide> JoinCondition join = new JoinCondition();
<ide> join.setForeignAttributeName(oldJoin.getForeignAttributeName());
<ide> join.setLocalAttributeName(oldJoin.getLocalAttributeName());
<del> join.setPredicate(foreignPredicateConversion.get(oldJoin.getPredicate()));
<add> if (oldJoin.getPredicate() != null) {
<add> join.setPredicate(foreignPredicateConversion.get(oldJoin.getPredicate()));
<add> } else {
<add> // predicate is optional in DCQL 1, default is EQUAL_TO
<add> join.setPredicate(BinaryPredicate.EQUAL_TO);
<add> }
<ide> return join;
<ide> }
<ide>
<ide> for (int i = 0; i < results.getDCQLResult().length; i++) {
<ide> oldResults[i] = convertToDcqlResult(results.getDCQLResult(i));
<ide> }
<del> }
<del> results.getDCQLResult();
<add> oldResultsCollection.setDCQLResult(oldResults);
<add> }
<ide> return oldResultsCollection;
<ide> }
<ide> |
|
Java | apache-2.0 | 28b4db497d01e9b019c7329927a832889807d78e | 0 | rkapsi/ardverk-dht | package com.ardverk.dht.io;
import java.io.IOException;
import java.io.Serializable;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
import java.util.NavigableSet;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.ardverk.concurrent.AsyncFuture;
import org.ardverk.lang.Arguments;
import org.ardverk.lang.NullArgumentException;
import org.slf4j.Logger;
import com.ardverk.dht.Constants;
import com.ardverk.dht.KUID;
import com.ardverk.dht.config.LookupConfig;
import com.ardverk.dht.entity.LookupEntity;
import com.ardverk.dht.message.ResponseMessage;
import com.ardverk.dht.routing.Contact;
import com.ardverk.dht.routing.RouteTable;
import com.ardverk.dht.utils.SchedulingUtils;
import com.ardverk.logging.LoggerUtils;
public abstract class LookupResponseHandler<T extends LookupEntity>
extends AbstractResponseHandler<T> {
private static final Logger LOG
= LoggerUtils.getLogger(LookupResponseHandler.class);
protected final LookupConfig config;
private final LookupManager lookupManager;
private final ProcessCounter lookupCounter;
private long startTime = -1L;
private ScheduledFuture<?> boostFuture;
public LookupResponseHandler(MessageDispatcher messageDispatcher,
RouteTable routeTable, KUID lookupId, LookupConfig config) {
super(messageDispatcher);
this.config = Arguments.notNull(config, "config");
lookupManager = new LookupManager(routeTable, lookupId);
lookupCounter = new ProcessCounter(config.getAlpha());
}
@Override
protected synchronized void go(AsyncFuture<T> future) throws IOException {
long boostFrequency = config.getBoostFrequencyInMillis();
if (0L < boostFrequency) {
Runnable task = new Runnable() {
@Override
public void run() {
try {
boost();
} catch (IOException err) {
LOG.error("IOException", err);
}
}
};
boostFuture = SchedulingUtils.scheduleWithFixedDelay(
task, boostFrequency, boostFrequency,
TimeUnit.MILLISECONDS);
}
process(0);
}
@Override
protected synchronized void done() {
if (boostFuture != null) {
boostFuture.cancel(true);
}
}
/**
*
*/
private synchronized void boost() throws IOException {
if (lookupManager.hasNext(true)) {
long boostTimeout = config.getBoostTimeoutInMillis();
if (getLastResponseTime(TimeUnit.MILLISECONDS) >= boostTimeout) {
try {
Contact contact = lookupManager.next();
lookup(contact);
lookupCounter.increment(true);
} finally {
postProcess();
}
}
}
}
/**
*
*/
private synchronized void process(int decrement) throws IOException {
try {
preProcess(decrement);
while (lookupCounter.hasNext()) {
if (!lookupManager.hasNext()) {
break;
}
Contact contact = lookupManager.next();
lookup(contact);
lookupCounter.increment();
}
} finally {
postProcess();
}
}
private void lookup(Contact dst) throws IOException {
long defaultTimeout = config.getFooTimeoutInMillis();
long adaptiveTimeout = config.getAdaptiveTimeout(
dst, defaultTimeout, TimeUnit.MILLISECONDS);
lookup(dst, lookupManager.key, adaptiveTimeout, TimeUnit.MILLISECONDS);
}
/**
*
*/
private synchronized void preProcess(int decrement) {
if (startTime == -1L) {
startTime = System.currentTimeMillis();
}
while (0 < decrement--) {
lookupCounter.decrement();
}
}
/**
*
*/
private synchronized void postProcess() {
int count = lookupCounter.getProcesses();
if (count == 0) {
State state = getState();
complete(state);
}
}
/**
*
*/
protected abstract void lookup(Contact dst, KUID lookupId,
long timeout, TimeUnit unit) throws IOException;
/**
*
*/
protected abstract void complete(State state);
@Override
protected final synchronized void processResponse(RequestEntity entity,
ResponseMessage response, long time, TimeUnit unit)
throws IOException {
try {
processResponse0(entity, response, time, unit);
} finally {
process(1);
}
}
/**
*
*/
protected abstract void processResponse0(RequestEntity entity,
ResponseMessage response, long time, TimeUnit unit) throws IOException;
/**
*
*/
protected synchronized void processContacts(Contact src,
Contact[] contacts, long time, TimeUnit unit) throws IOException {
lookupManager.handleResponse(src, contacts, time, unit);
}
@Override
protected final synchronized void processTimeout(RequestEntity entity,
long time, TimeUnit unit) throws IOException {
try {
processTimeout0(entity, time, unit);
} finally {
process(1);
}
}
protected synchronized void processTimeout0(RequestEntity entity,
long time, TimeUnit unit) throws IOException {
lookupManager.handleTimeout(time, unit);
}
protected synchronized State getState() {
if (startTime == -1L) {
throw new IllegalStateException("startTime=" + startTime);
}
Contact[] contacts = lookupManager.getContacts();
int hop = lookupManager.getCurrentHop();
long time = System.currentTimeMillis() - startTime;
return new State(contacts, hop, time, TimeUnit.MILLISECONDS);
}
/**
*
*/
private class LookupManager {
private final boolean exhaustive = config.isExhaustive();
private final boolean randomize = config.isRandomize();
private final RouteTable routeTable;
private final KUID key;
/**
* A {@link Set} of all responses
*/
private final NavigableSet<Contact> responses;
/**
* A {@link Set} of the k-closest responses
*/
private final NavigableSet<Contact> closest;
/**
* A {@link Set} of {@link Contact}s to query
*/
private final NavigableSet<Contact> query;
/**
* A history of all {@link KUID}s that were added to the
* {@link #query} {@link NavigableSet}.
*/
private final Map<KUID, Integer> history
= new HashMap<KUID, Integer>();
private int currentHop = 0;
private int timeouts = 0;
public LookupManager(RouteTable routeTable, KUID key) {
if (routeTable == null) {
throw new NullArgumentException("routeTable");
}
if (key == null) {
throw new NullArgumentException("key");
}
this.routeTable = routeTable;
this.key = key;
Contact localhost = routeTable.getLocalhost();
KUID contactId = localhost.getId();
XorComparator comparator = new XorComparator(key);
this.responses = new TreeSet<Contact>(comparator);
this.closest = new TreeSet<Contact>(comparator);
this.query = new TreeSet<Contact>(comparator);
history.put(contactId, 0);
Contact[] contacts = routeTable.select(key);
if (0 < contacts.length) {
addToResponses(localhost);
for (Contact contact : contacts) {
addToQuery(contact, 1);
}
}
}
public void handleResponse(Contact src, Contact[] contacts,
long time, TimeUnit unit) {
boolean success = addToResponses(src);
if (!success) {
return;
}
for (Contact contact : contacts) {
if (addToQuery(contact, currentHop+1)) {
routeTable.add(contact);
}
}
}
public void handleTimeout(long time, TimeUnit unit) {
timeouts++;
}
public Contact[] getContacts() {
return responses.toArray(new Contact[0]);
}
public int getCurrentHop() {
return currentHop;
}
public int getTimeouts() {
return timeouts;
}
private boolean addToResponses(Contact contact) {
if (responses.add(contact)) {
closest.add(contact);
if (closest.size() > routeTable.getK()) {
closest.pollLast();
}
KUID contactId = contact.getId();
currentHop = history.get(contactId);
return true;
}
return false;
}
private boolean addToQuery(Contact contact, int hop) {
KUID contactId = contact.getId();
if (!history.containsKey(contactId)) {
history.put(contactId, hop);
query.add(contact);
return true;
}
return false;
}
private boolean isCloserThanClosest(Contact other) {
if (!closest.isEmpty()) {
Contact contact = closest.last();
KUID contactId = contact.getId();
KUID otherId = other.getId();
return otherId.isCloserTo(key, contactId);
}
return true;
}
public boolean hasNext() {
return hasNext(false);
}
public boolean hasNext(boolean force) {
if (!query.isEmpty()) {
Contact contact = query.first();
if (force || exhaustive
|| closest.size() < Constants.K
|| isCloserThanClosest(contact)) {
return true;
}
}
return false;
}
public Contact next() {
Contact contact = null;
if (randomize && !query.isEmpty()) {
// Knuth: Can we pick a random element from a set of
// items whose cardinality we do not know?
//
// Pick an item and store it. Pick the next one, and replace
// the first one with it with probability 1/2. Pick the third
// one, and do a replace with probability 1/3, and so on. At
// the end, the item you've stored has a probability of 1/n
// of being any particular element.
//
// NOTE: We do know the cardinality but we don't have the
// required methods to retrieve elements from the Set and
// are forced to use the Iterator (streaming) as described
// above.
int index = 0;
for (Contact c : query) {
// First element is always true because 1/1 >= random[0..1]!
if (1d/(index + 1) >= Math.random()) {
contact = c;
}
if (index >= routeTable.getK()) {
break;
}
++index;
}
query.remove(contact);
} else {
contact = query.pollFirst();
}
if (contact == null) {
throw new NoSuchElementException();
}
return contact;
}
}
/**
*
*/
private static class XorComparator implements Comparator<Contact>, Serializable {
private static final long serialVersionUID = -7543333434594933816L;
private final KUID key;
public XorComparator(KUID key) {
if (key == null) {
throw new NullArgumentException("key");
}
this.key = key;
}
@Override
public int compare(Contact o1, Contact o2) {
return o1.getId().xor(key).compareTo(o2.getId().xor(key));
}
}
public static class State {
private final Contact[] contacts;
private final int hop;
private final long time;
private final TimeUnit unit;
private State(Contact[] contacts, int hop, long time, TimeUnit unit) {
if (contacts == null) {
throw new NullArgumentException("contacts");
}
if (unit == null) {
throw new NullArgumentException("unit");
}
this.contacts = contacts;
this.hop = hop;
this.time = time;
this.unit = unit;
}
public Contact[] getContacts() {
return contacts;
}
public int getHop() {
return hop;
}
public long getTime(TimeUnit unit) {
return unit.convert(time, this.unit);
}
public long getTimeInMillis() {
return getTime(TimeUnit.MILLISECONDS);
}
}
}
| ardverk-dht/src/main/java/com/ardverk/dht/io/LookupResponseHandler.java | package com.ardverk.dht.io;
import java.io.IOException;
import java.io.Serializable;
import java.util.Comparator;
import java.util.HashMap;
import java.util.Map;
import java.util.NavigableSet;
import java.util.NoSuchElementException;
import java.util.Set;
import java.util.TreeSet;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import org.ardverk.concurrent.AsyncFuture;
import org.ardverk.lang.Arguments;
import org.ardverk.lang.NullArgumentException;
import org.slf4j.Logger;
import com.ardverk.dht.Constants;
import com.ardverk.dht.KUID;
import com.ardverk.dht.config.LookupConfig;
import com.ardverk.dht.entity.LookupEntity;
import com.ardverk.dht.message.ResponseMessage;
import com.ardverk.dht.routing.Contact;
import com.ardverk.dht.routing.RouteTable;
import com.ardverk.dht.utils.SchedulingUtils;
import com.ardverk.logging.LoggerUtils;
public abstract class LookupResponseHandler<T extends LookupEntity>
extends AbstractResponseHandler<T> {
private static final Logger LOG
= LoggerUtils.getLogger(LookupResponseHandler.class);
protected final LookupConfig config;
private final LookupManager lookupManager;
private final ProcessCounter lookupCounter;
private long startTime = -1L;
private ScheduledFuture<?> boostFuture;
public LookupResponseHandler(MessageDispatcher messageDispatcher,
RouteTable routeTable, KUID lookupId, LookupConfig config) {
super(messageDispatcher);
this.config = Arguments.notNull(config, "config");
lookupManager = new LookupManager(routeTable, lookupId);
lookupCounter = new ProcessCounter(config.getAlpha());
}
@Override
protected synchronized void go(AsyncFuture<T> future) throws IOException {
long boostFrequency = config.getBoostFrequencyInMillis();
if (0L < boostFrequency) {
Runnable task = new Runnable() {
@Override
public void run() {
try {
boost();
} catch (IOException err) {
LOG.error("IOException", err);
}
}
};
boostFuture = SchedulingUtils.scheduleWithFixedDelay(
task, boostFrequency, boostFrequency,
TimeUnit.MILLISECONDS);
}
process(0);
}
@Override
protected synchronized void done() {
if (boostFuture != null) {
boostFuture.cancel(true);
}
}
/**
*
*/
private synchronized void boost() throws IOException {
if (lookupManager.hasNext(true)) {
long boostTimeout = config.getBoostTimeoutInMillis();
if (getLastResponseTime(TimeUnit.MILLISECONDS) >= boostTimeout) {
try {
Contact contact = lookupManager.next();
lookup(contact);
lookupCounter.increment(true);
} finally {
postProcess();
}
}
}
}
/**
*
*/
private synchronized void process(int decrement) throws IOException {
try {
preProcess(decrement);
while (lookupCounter.hasNext()) {
if (!lookupManager.hasNext()) {
break;
}
Contact contact = lookupManager.next();
lookup(contact);
lookupCounter.increment();
}
} finally {
postProcess();
}
}
private void lookup(Contact dst) throws IOException {
long defaultTimeout = config.getFooTimeoutInMillis();
long adaptiveTimeout = config.getAdaptiveTimeout(
dst, defaultTimeout, TimeUnit.MILLISECONDS);
lookup(dst, lookupManager.key, adaptiveTimeout, TimeUnit.MILLISECONDS);
}
/**
*
*/
private synchronized void preProcess(int decrement) {
if (startTime == -1L) {
startTime = System.currentTimeMillis();
}
while (0 < decrement--) {
lookupCounter.decrement();
}
}
/**
*
*/
private synchronized void postProcess() {
int count = lookupCounter.getProcesses();
if (count == 0) {
State state = getState();
complete(state);
}
}
/**
*
*/
protected abstract void lookup(Contact dst, KUID lookupId,
long timeout, TimeUnit unit) throws IOException;
/**
*
*/
protected abstract void complete(State state);
@Override
protected final synchronized void processResponse(RequestEntity entity,
ResponseMessage response, long time, TimeUnit unit)
throws IOException {
try {
processResponse0(entity, response, time, unit);
} finally {
process(1);
}
}
/**
*
*/
protected abstract void processResponse0(RequestEntity entity,
ResponseMessage response, long time, TimeUnit unit) throws IOException;
/**
*
*/
protected synchronized void processContacts(Contact src,
Contact[] contacts, long time, TimeUnit unit) throws IOException {
lookupManager.handleResponse(src, contacts, time, unit);
}
@Override
protected final synchronized void processTimeout(RequestEntity entity,
long time, TimeUnit unit) throws IOException {
try {
processTimeout0(entity, time, unit);
} finally {
process(1);
}
}
protected synchronized void processTimeout0(RequestEntity entity,
long time, TimeUnit unit) throws IOException {
lookupManager.handleTimeout(time, unit);
}
protected synchronized State getState() {
if (startTime == -1L) {
throw new IllegalStateException("startTime=" + startTime);
}
Contact[] contacts = lookupManager.getContacts();
int hop = lookupManager.getCurrentHop();
long time = System.currentTimeMillis() - startTime;
return new State(contacts, hop, time, TimeUnit.MILLISECONDS);
}
/**
*
*/
private class LookupManager {
private final boolean exhaustive = config.isExhaustive();
private final boolean randomize = config.isRandomize();
private final RouteTable routeTable;
private final KUID key;
/**
* A {@link Set} of all responses
*/
private final NavigableSet<Contact> responses;
/**
* A {@link Set} of the k-closest responses
*/
private final NavigableSet<Contact> closest;
/**
* A {@link Set} of {@link Contact}s to query
*/
private final NavigableSet<Contact> query;
/**
* A history of all {@link KUID}s that were added to the
* {@link #query} {@link NavigableSet}.
*/
private final Map<KUID, Integer> history
= new HashMap<KUID, Integer>();
private int currentHop = 0;
private int timeouts = 0;
public LookupManager(RouteTable routeTable, KUID key) {
if (routeTable == null) {
throw new NullArgumentException("routeTable");
}
if (key == null) {
throw new NullArgumentException("key");
}
this.routeTable = routeTable;
this.key = key;
Contact localhost = routeTable.getLocalhost();
KUID contactId = localhost.getId();
XorComparator comparator = new XorComparator(key);
this.responses = new TreeSet<Contact>(comparator);
this.closest = new TreeSet<Contact>(comparator);
this.query = new TreeSet<Contact>(comparator);
history.put(contactId, 0);
Contact[] contacts = routeTable.select(key);
if (0 < contacts.length) {
addToResponses(localhost);
for (Contact contact : contacts) {
addToQuery(contact, 1);
}
}
}
public void handleResponse(Contact src, Contact[] contacts,
long time, TimeUnit unit) {
boolean success = addToResponses(src);
if (!success) {
return;
}
for (Contact contact : contacts) {
if (addToQuery(contact, currentHop+1)) {
routeTable.add(contact);
}
}
}
public void handleTimeout(long time, TimeUnit unit) {
timeouts++;
}
public Contact[] getContacts() {
return responses.toArray(new Contact[0]);
}
public int getCurrentHop() {
return currentHop;
}
public int getTimeouts() {
return timeouts;
}
private boolean addToResponses(Contact contact) {
if (responses.add(contact)) {
closest.add(contact);
if (closest.size() > routeTable.getK()) {
closest.pollLast();
}
KUID contactId = contact.getId();
currentHop = history.get(contactId);
return true;
}
return false;
}
private boolean addToQuery(Contact contact, int hop) {
KUID contactId = contact.getId();
if (!history.containsKey(contactId)) {
history.put(contactId, hop);
query.add(contact);
return true;
}
return false;
}
private boolean isCloserThanClosest(Contact other) {
if (!closest.isEmpty()) {
Contact contact = closest.last();
KUID contactId = contact.getId();
KUID otherId = other.getId();
return otherId.isCloserTo(key, contactId);
}
return true;
}
public boolean hasNext() {
return hasNext(false);
}
public boolean hasNext(boolean force) {
if (!query.isEmpty()) {
Contact contact = query.first();
if (force || exhaustive
|| closest.size() < Constants.K
|| isCloserThanClosest(contact)) {
return true;
}
}
return false;
}
public Contact next() {
Contact contact = null;
if (randomize && !query.isEmpty()) {
// Knuth: Can we pick a random element from a set of
// items whose cardinality we do not know?
//
// Pick an item and store it. Pick the next one, and replace
// the first one with it with probability 1/2. Pick the third
// one, and do a replace with probability 1/3, and so on. At
// the end, the item you've stored has a probability of 1/n
// of being any particular element.
//
// NOTE: We do know the cardinality but we don't have the
// required methods to retrieve elements by index from the
// Set and are therefore forced to use the streaming approach
// as described above.
int index = 0;
for (Contact c : query) {
if (1d/(index + 1) >= Math.random()) {
contact = c;
}
if (index >= routeTable.getK()) {
break;
}
++index;
}
query.remove(contact);
} else {
contact = query.pollFirst();
}
if (contact == null) {
throw new NoSuchElementException();
}
return contact;
}
}
/**
*
*/
private static class XorComparator implements Comparator<Contact>, Serializable {
private static final long serialVersionUID = -7543333434594933816L;
private final KUID key;
public XorComparator(KUID key) {
if (key == null) {
throw new NullArgumentException("key");
}
this.key = key;
}
@Override
public int compare(Contact o1, Contact o2) {
return o1.getId().xor(key).compareTo(o2.getId().xor(key));
}
}
public static class State {
private final Contact[] contacts;
private final int hop;
private final long time;
private final TimeUnit unit;
private State(Contact[] contacts, int hop, long time, TimeUnit unit) {
if (contacts == null) {
throw new NullArgumentException("contacts");
}
if (unit == null) {
throw new NullArgumentException("unit");
}
this.contacts = contacts;
this.hop = hop;
this.time = time;
this.unit = unit;
}
public Contact[] getContacts() {
return contacts;
}
public int getHop() {
return hop;
}
public long getTime(TimeUnit unit) {
return unit.convert(time, this.unit);
}
public long getTimeInMillis() {
return getTime(TimeUnit.MILLISECONDS);
}
}
}
| This is better
| ardverk-dht/src/main/java/com/ardverk/dht/io/LookupResponseHandler.java | This is better | <ide><path>rdverk-dht/src/main/java/com/ardverk/dht/io/LookupResponseHandler.java
<ide> // of being any particular element.
<ide> //
<ide> // NOTE: We do know the cardinality but we don't have the
<del> // required methods to retrieve elements by index from the
<del> // Set and are therefore forced to use the streaming approach
<del> // as described above.
<add> // required methods to retrieve elements from the Set and
<add> // are forced to use the Iterator (streaming) as described
<add> // above.
<ide>
<ide> int index = 0;
<ide> for (Contact c : query) {
<ide>
<add> // First element is always true because 1/1 >= random[0..1]!
<ide> if (1d/(index + 1) >= Math.random()) {
<ide> contact = c;
<ide> } |
|
Java | mit | 5dbc52fc7eac01170f52f0c42f1d75706f70e45b | 0 | PixelRunStudios/InternetSpeedTest | package com.github.assisstion.InternetSpeedTest;
import java.awt.Color;
import java.awt.Graphics;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Map;
import java.util.TreeMap;
import javax.swing.JButton;
import javax.swing.JPanel;
import javax.swing.JTextField;
public class LineGraphPanel extends JPanel{
/**
*
*/
private static final long serialVersionUID = -3206451660421244754L;
private static final int TOP_Y = 30;
private static final int BOTTOM_Y = 390;
private static final int LEFT_X = 50;
private static final int RIGHT_X = 920;
private TreeMap<Long, Double> data = new TreeMap<Long, Double>();
private int valuesPerPoint = 1;
private int pixelInterval = 2;
private int max = 0;
private JTextField textField;
private JTextField textField_1;
private JButton btnMoveDisplay;
private JButton btnUseAutomove;
private boolean automove = true;
private int movePosition = 0;
/**
* Create the panel.
*/
public LineGraphPanel(){
setLayout(null);
JButton btnSetValue = new JButton("Set Point Interval");
btnSetValue.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
try{
valuesPerPoint = Integer.parseInt(textField.getText());
repaint();
}
catch(NumberFormatException nfe){
System.out.println("Input not a number!");
}
}
});
btnSetValue.setBounds(50, 0, 150, 29);
add(btnSetValue);
textField = new JTextField();
textField.setText("1");
textField.setBounds(0, 0, 40, 28);
add(textField);
textField.setColumns(2);
textField_1 = new JTextField();
textField_1.setText("0");
textField_1.setBounds(215, 0, 80, 28);
add(textField_1);
textField_1.setColumns(10);
btnMoveDisplay = new JButton("Set Display Position");
btnMoveDisplay.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
try{
automove = false;
movePosition = Integer.parseInt(textField_1.getText());
repaint();
}
catch(NumberFormatException nfe){
System.out.println("Input not a number!");
}
}
});
btnMoveDisplay.setBounds(300, 0, 180, 29);
add(btnMoveDisplay);
btnUseAutomove = new JButton("Use Automove");
btnUseAutomove.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent e) {
automove = true;
repaint();
}
});
btnUseAutomove.setBounds(500, 0, 150, 29);
add(btnUseAutomove);
}
@Override
public void paint(Graphics g){
super.paint(g);
g.setColor(Color.BLACK);
g.drawRect(LEFT_X, TOP_Y, getGraphWidth(), getGraphHeight());
int size = getGraphWidth() / pixelInterval * valuesPerPoint;
ArrayList<Double> points = new ArrayList<Double>(size / valuesPerPoint);
Map.Entry<Long, Double> entry = data.lastEntry();
int speedStack = 0;
int speedStackCount = 0;
int moveAmount = 0;
if(!automove){
moveAmount += data.size() -
(movePosition + getGraphWidth()) / pixelInterval * valuesPerPoint;
//moveAmount += movePosition;
}
moveAmount = moveAmount - moveAmount % valuesPerPoint +
data.size() % valuesPerPoint;
System.out.println(moveAmount);
for(int i = 0; i < moveAmount; i++){
if(entry == null){
break;
}
entry = data.lowerEntry(entry.getKey());
}
for(int i = 0; i < size; i++){
if(entry == null){
break;
}
speedStack += entry.getValue();
speedStackCount++;
if(speedStackCount >= valuesPerPoint){
double speed = (double) speedStack / (double) speedStackCount;
points.add(speed);
if(speed > max){
max = (int) speed;
}
speedStack = 0;
speedStackCount = 0;
}
entry = data.lowerEntry(entry.getKey());
}
boolean hasLast = false;
int lastX = LEFT_X;
int lastY = BOTTOM_Y;
for(int i = 0; i < points.size(); i++){
double value = points.get(points.size() - i - 1);
int y = BOTTOM_Y;
if(hasLast){
y = BOTTOM_Y - (int) (value * getGraphHeight() / max);
g.drawLine(lastX, lastY, lastX + 2, y);
}
lastX = lastX + 2;
lastY = y;
hasLast = true;
}
}
public void pushLine(long timeStamp, double speed){
data.put(timeStamp, speed);
repaint();
}
public static int getGraphWidth(){
return RIGHT_X - LEFT_X;
}
public static int getGraphHeight(){
return BOTTOM_Y - TOP_Y;
}
public static class Point implements Comparable<Point>{
public int x;
public int y;
@Override
public int compareTo(Point o){
return Integer.compare(x, o.x);
}
}
}
| src/com/github/assisstion/InternetSpeedTest/LineGraphPanel.java | package com.github.assisstion.InternetSpeedTest;
import java.awt.Color;
import java.awt.Graphics;
import java.util.ArrayList;
import java.util.Map;
import java.util.TreeMap;
import javax.swing.JPanel;
public class LineGraphPanel extends JPanel{
/**
*
*/
private static final long serialVersionUID = -3206451660421244754L;
private static final int TOP_Y = 30;
private static final int BOTTOM_Y = 390;
private static final int LEFT_X = 50;
private static final int RIGHT_X = 920;
private TreeMap<Long, Double> data = new TreeMap<Long, Double>();
private int valuesPerPoint = 1;
private int pixelInterval = 2;
private int max = 0;
/**
* Create the panel.
*/
public LineGraphPanel(){
}
@Override
public void paint(Graphics g){
g.setColor(Color.BLACK);
g.drawRect(LEFT_X, TOP_Y, getGraphWidth(), getGraphHeight());
int size = getGraphWidth() / pixelInterval;
ArrayList<Double> points = new ArrayList<Double>(size / valuesPerPoint);
Map.Entry<Long, Double> entry = data.lastEntry();
int speedStack = 0;
int speedStackCount = 0;
for(int i = 0; i < size; i++){
if(entry == null){
break;
}
speedStack += entry.getValue();
speedStackCount++;
if(speedStackCount >= valuesPerPoint){
double speed = (double) speedStack / (double) speedStackCount;
points.add(speed);
if(speed > max){
max = (int) speed;
}
speedStack = 0;
speedStackCount = 0;
}
entry = data.lowerEntry(entry.getKey());
}
boolean hasLast = false;
int lastX = LEFT_X;
int lastY = BOTTOM_Y;
for(int i = 0; i < points.size(); i++){
double value = points.get(points.size() - i - 1);
int y = BOTTOM_Y;
if(hasLast){
y = BOTTOM_Y - (int) (value * getGraphHeight() / max);
System.out.println("X:" + (lastX + 2));
System.out.println(y);
g.drawLine(lastX, lastY, lastX + 2, y);
}
lastX = lastX + 2;
lastY = y;
hasLast = true;
}
}
public void pushLine(long timeStamp, double speed){
data.put(timeStamp, speed);
repaint();
}
public static int getGraphWidth(){
return RIGHT_X - LEFT_X;
}
public static int getGraphHeight(){
return BOTTOM_Y - TOP_Y;
}
public static class Point implements Comparable<Point>{
public int x;
public int y;
@Override
public int compareTo(Point o){
return Integer.compare(x, o.x);
}
}
}
| Fixed intervals, Added position/interval setter
Default automove is on. Minor Bug: When Interval > 1 and automove is
off, graph is shaky (still accurate). Otherwise nothing wrong.
| src/com/github/assisstion/InternetSpeedTest/LineGraphPanel.java | Fixed intervals, Added position/interval setter | <ide><path>rc/com/github/assisstion/InternetSpeedTest/LineGraphPanel.java
<ide>
<ide> import java.awt.Color;
<ide> import java.awt.Graphics;
<add>import java.awt.event.ActionEvent;
<add>import java.awt.event.ActionListener;
<ide> import java.util.ArrayList;
<ide> import java.util.Map;
<ide> import java.util.TreeMap;
<ide>
<add>import javax.swing.JButton;
<ide> import javax.swing.JPanel;
<add>import javax.swing.JTextField;
<ide>
<ide> public class LineGraphPanel extends JPanel{
<ide>
<ide> private int valuesPerPoint = 1;
<ide> private int pixelInterval = 2;
<ide> private int max = 0;
<add> private JTextField textField;
<add> private JTextField textField_1;
<add> private JButton btnMoveDisplay;
<add> private JButton btnUseAutomove;
<add> private boolean automove = true;
<add> private int movePosition = 0;
<ide>
<ide> /**
<ide> * Create the panel.
<ide> */
<ide> public LineGraphPanel(){
<add> setLayout(null);
<add>
<add> JButton btnSetValue = new JButton("Set Point Interval");
<add> btnSetValue.addActionListener(new ActionListener() {
<add> @Override
<add> public void actionPerformed(ActionEvent e) {
<add> try{
<add> valuesPerPoint = Integer.parseInt(textField.getText());
<add> repaint();
<add> }
<add> catch(NumberFormatException nfe){
<add> System.out.println("Input not a number!");
<add> }
<add> }
<add> });
<add> btnSetValue.setBounds(50, 0, 150, 29);
<add> add(btnSetValue);
<add>
<add> textField = new JTextField();
<add> textField.setText("1");
<add> textField.setBounds(0, 0, 40, 28);
<add> add(textField);
<add> textField.setColumns(2);
<add>
<add> textField_1 = new JTextField();
<add> textField_1.setText("0");
<add> textField_1.setBounds(215, 0, 80, 28);
<add> add(textField_1);
<add> textField_1.setColumns(10);
<add>
<add> btnMoveDisplay = new JButton("Set Display Position");
<add> btnMoveDisplay.addActionListener(new ActionListener() {
<add> @Override
<add> public void actionPerformed(ActionEvent e) {
<add> try{
<add> automove = false;
<add> movePosition = Integer.parseInt(textField_1.getText());
<add> repaint();
<add> }
<add> catch(NumberFormatException nfe){
<add> System.out.println("Input not a number!");
<add> }
<add> }
<add> });
<add> btnMoveDisplay.setBounds(300, 0, 180, 29);
<add> add(btnMoveDisplay);
<add>
<add> btnUseAutomove = new JButton("Use Automove");
<add> btnUseAutomove.addActionListener(new ActionListener() {
<add> @Override
<add> public void actionPerformed(ActionEvent e) {
<add> automove = true;
<add> repaint();
<add> }
<add> });
<add> btnUseAutomove.setBounds(500, 0, 150, 29);
<add> add(btnUseAutomove);
<ide>
<ide> }
<ide>
<ide> @Override
<ide> public void paint(Graphics g){
<add> super.paint(g);
<ide> g.setColor(Color.BLACK);
<ide> g.drawRect(LEFT_X, TOP_Y, getGraphWidth(), getGraphHeight());
<del> int size = getGraphWidth() / pixelInterval;
<add> int size = getGraphWidth() / pixelInterval * valuesPerPoint;
<ide> ArrayList<Double> points = new ArrayList<Double>(size / valuesPerPoint);
<ide> Map.Entry<Long, Double> entry = data.lastEntry();
<ide> int speedStack = 0;
<ide> int speedStackCount = 0;
<add> int moveAmount = 0;
<add> if(!automove){
<add> moveAmount += data.size() -
<add> (movePosition + getGraphWidth()) / pixelInterval * valuesPerPoint;
<add> //moveAmount += movePosition;
<add> }
<add> moveAmount = moveAmount - moveAmount % valuesPerPoint +
<add> data.size() % valuesPerPoint;
<add> System.out.println(moveAmount);
<add> for(int i = 0; i < moveAmount; i++){
<add> if(entry == null){
<add> break;
<add> }
<add> entry = data.lowerEntry(entry.getKey());
<add> }
<ide> for(int i = 0; i < size; i++){
<ide> if(entry == null){
<ide> break;
<ide> int y = BOTTOM_Y;
<ide> if(hasLast){
<ide> y = BOTTOM_Y - (int) (value * getGraphHeight() / max);
<del> System.out.println("X:" + (lastX + 2));
<del> System.out.println(y);
<ide> g.drawLine(lastX, lastY, lastX + 2, y);
<ide> }
<ide> lastX = lastX + 2; |
|
Java | apache-2.0 | 768b99910d1a7015955e4ea5b7c2da5cf68c804d | 0 | apache/incubator-groovy,paulk-asert/groovy,shils/groovy,paulk-asert/incubator-groovy,apache/groovy,apache/incubator-groovy,paulk-asert/incubator-groovy,shils/incubator-groovy,paulk-asert/groovy,apache/incubator-groovy,shils/incubator-groovy,paulk-asert/groovy,shils/groovy,apache/groovy,paulk-asert/incubator-groovy,shils/groovy,paulk-asert/incubator-groovy,apache/groovy,shils/incubator-groovy,paulk-asert/groovy,paulk-asert/incubator-groovy,shils/groovy,apache/groovy,shils/incubator-groovy,apache/incubator-groovy | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.codehaus.groovy.runtime;
import groovy.io.GroovyPrintWriter;
import groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import groovy.lang.DelegatingMetaClass;
import groovy.lang.EmptyRange;
import groovy.lang.ExpandoMetaClass;
import groovy.lang.GroovyObject;
import groovy.lang.GroovyRuntimeException;
import groovy.lang.GroovySystem;
import groovy.lang.Groovydoc;
import groovy.lang.IntRange;
import groovy.lang.ListWithDefault;
import groovy.lang.MapWithDefault;
import groovy.lang.MetaClass;
import groovy.lang.MetaClassImpl;
import groovy.lang.MetaClassRegistry;
import groovy.lang.MetaMethod;
import groovy.lang.MetaProperty;
import groovy.lang.MissingPropertyException;
import groovy.lang.ObjectRange;
import groovy.lang.PropertyValue;
import groovy.lang.Range;
import groovy.lang.SpreadMap;
import groovy.lang.Tuple2;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FirstParam;
import groovy.transform.stc.FromString;
import groovy.transform.stc.MapEntryOrKeyValue;
import groovy.transform.stc.SimpleType;
import groovy.util.BufferedIterator;
import groovy.util.ClosureComparator;
import groovy.util.GroovyCollections;
import groovy.util.MapEntry;
import groovy.util.OrderBy;
import groovy.util.PermutationGenerator;
import groovy.util.ProxyGenerator;
import org.apache.groovy.io.StringBuilderWriter;
import org.codehaus.groovy.classgen.Verifier;
import org.codehaus.groovy.reflection.ClassInfo;
import org.codehaus.groovy.reflection.MixinInMetaClass;
import org.codehaus.groovy.reflection.ReflectionCache;
import org.codehaus.groovy.reflection.ReflectionUtils;
import org.codehaus.groovy.reflection.stdclasses.CachedSAMClass;
import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberDiv;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMinus;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMultiply;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberPlus;
import org.codehaus.groovy.runtime.dgmimpl.arrays.BooleanArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.BooleanArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ByteArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ByteArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.CharacterArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.CharacterArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.DoubleArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.DoubleArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.FloatArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.FloatArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.IntegerArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.IntegerArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.LongArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.LongArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ObjectArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ObjectArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ShortArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ShortArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.metaclass.MetaClassRegistryImpl;
import org.codehaus.groovy.runtime.metaclass.MissingPropertyExceptionNoStack;
import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
import org.codehaus.groovy.runtime.typehandling.GroovyCastException;
import org.codehaus.groovy.runtime.typehandling.NumberMath;
import org.codehaus.groovy.tools.RootLoader;
import org.codehaus.groovy.transform.trait.Traits;
import org.codehaus.groovy.util.ArrayIterator;
import org.codehaus.groovy.util.IteratorBufferedIterator;
import org.codehaus.groovy.util.ListBufferedIterator;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.math.RoundingMode;
import java.net.URL;
import java.security.AccessController;
import java.security.CodeSource;
import java.security.PrivilegedAction;
import java.text.MessageFormat;
import java.util.AbstractCollection;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.Stack;
import java.util.Timer;
import java.util.TimerTask;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.concurrent.BlockingQueue;
import java.util.logging.Logger;
import static groovy.lang.groovydoc.Groovydoc.EMPTY_GROOVYDOC;
/**
* This class defines new groovy methods which appear on normal JDK
* classes inside the Groovy environment. Static methods are used with the
* first parameter being the destination class,
* i.e. <code>public static String reverse(String self)</code>
* provides a <code>reverse()</code> method for <code>String</code>.
* <p>
* NOTE: While this class contains many 'public' static methods, it is
* primarily regarded as an internal class (its internal package name
* suggests this also). We value backwards compatibility of these
* methods when used within Groovy but value less backwards compatibility
* at the Java method call level. I.e. future versions of Groovy may
* remove or move a method call in this file but would normally
* aim to keep the method available from within Groovy.
*/
public class DefaultGroovyMethods extends DefaultGroovyMethodsSupport {
private static final Logger LOG = Logger.getLogger(DefaultGroovyMethods.class.getName());
private static final Integer ONE = 1;
private static final BigInteger BI_INT_MAX = BigInteger.valueOf(Integer.MAX_VALUE);
private static final BigInteger BI_INT_MIN = BigInteger.valueOf(Integer.MIN_VALUE);
private static final BigInteger BI_LONG_MAX = BigInteger.valueOf(Long.MAX_VALUE);
private static final BigInteger BI_LONG_MIN = BigInteger.valueOf(Long.MIN_VALUE);
public static final Class[] ADDITIONAL_CLASSES = {
NumberNumberPlus.class,
NumberNumberMultiply.class,
NumberNumberMinus.class,
NumberNumberDiv.class,
ObjectArrayGetAtMetaMethod.class,
ObjectArrayPutAtMetaMethod.class,
BooleanArrayGetAtMetaMethod.class,
BooleanArrayPutAtMetaMethod.class,
ByteArrayGetAtMetaMethod.class,
ByteArrayPutAtMetaMethod.class,
CharacterArrayGetAtMetaMethod.class,
CharacterArrayPutAtMetaMethod.class,
ShortArrayGetAtMetaMethod.class,
ShortArrayPutAtMetaMethod.class,
IntegerArrayGetAtMetaMethod.class,
IntegerArrayPutAtMetaMethod.class,
LongArrayGetAtMetaMethod.class,
LongArrayPutAtMetaMethod.class,
FloatArrayGetAtMetaMethod.class,
FloatArrayPutAtMetaMethod.class,
DoubleArrayGetAtMetaMethod.class,
DoubleArrayPutAtMetaMethod.class,
};
public static final Class[] DGM_LIKE_CLASSES = new Class[]{
DefaultGroovyMethods.class,
EncodingGroovyMethods.class,
IOGroovyMethods.class,
ProcessGroovyMethods.class,
ResourceGroovyMethods.class,
SocketGroovyMethods.class,
StringGroovyMethods.class//,
// Below are registered as module extension classes
// DateUtilExtensions.class,
// DateTimeStaticExtensions.class,
// DateTimeExtensions.class,
// SqlExtensions.class,
// SwingGroovyMethods.class,
// XmlExtensions.class,
// NioExtensions.class
};
private static final Object[] EMPTY_OBJECT_ARRAY = new Object[0];
private static final NumberAwareComparator<Comparable> COMPARABLE_NUMBER_AWARE_COMPARATOR = new NumberAwareComparator<>();
/**
* Identity check. Since == is overridden in Groovy with the meaning of equality
* we need some fallback to check for object identity. Invoke using the
* 'is' method, like so: <code>def same = this.is(that)</code>
*
* @param self an object
* @param other an object to compare identity with
* @return true if self and other are both references to the same
* instance, false otherwise
* @since 1.0
*/
public static boolean is(Object self, Object other) {
return self == other;
}
/**
* Allows the closure to be called for the object reference self.
* Synonym for 'with()'.
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return result of calling the closure
* @see #with(Object, Closure)
* @since 1.0
*/
public static <T,U> T identity(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return DefaultGroovyMethods.with(self, closure);
}
/**
* Allows the closure to be called for the object reference self.
* <p>
* Any method invoked inside the closure will first be invoked on the
* self reference. For instance, the following method calls to the append()
* method are invoked on the StringBuilder instance:
* <pre class="groovyTestCase">
* def b = new StringBuilder().with {
* append('foo')
* append('bar')
* return it
* }
* assert b.toString() == 'foobar'
* </pre>
* This is commonly used to simplify object creation, such as this example:
* <pre>
* def p = new Person().with {
* firstName = 'John'
* lastName = 'Doe'
* return it
* }
* </pre>
* The other typical usage, uses the self object while creating some value:
* <pre>
* def fullName = person.with{ "$firstName $lastName" }
* </pre>
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return result of calling the closure
* @see #with(Object, boolean, Closure)
* @see #tap(Object, Closure)
* @since 1.5.0
*/
@SuppressWarnings("unchecked")
public static <T,U> T with(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return (T) with(self, false, (Closure<Object>)closure);
}
/**
* Allows the closure to be called for the object reference self.
* <p/>
* Any method invoked inside the closure will first be invoked on the
* self reference. For example, the following method calls to the append()
* method are invoked on the StringBuilder instance and then, because
* 'returning' is true, the self instance is returned:
* <pre class="groovyTestCase">
* def b = new StringBuilder().with(true) {
* append('foo')
* append('bar')
* }
* assert b.toString() == 'foobar'
* </pre>
* The returning parameter is commonly set to true when using with to simplify object
* creation, such as this example:
* <pre>
* def p = new Person().with(true) {
* firstName = 'John'
* lastName = 'Doe'
* }
* </pre>
* Alternatively, 'tap' is an alias for 'with(true)', so that method can be used instead.
*
* The other main use case for with is when returning a value calculated using self as shown here:
* <pre>
* def fullName = person.with(false){ "$firstName $lastName" }
* </pre>
* Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be omitted instead.
*
* @param self the object to have a closure act upon
* @param returning if true, return the self object; otherwise, the result of calling the closure
* @param closure the closure to call on the object
* @return the self object or the result of calling the closure depending on 'returning'
* @see #with(Object, Closure)
* @see #tap(Object, Closure)
* @since 2.5.0
*/
public static <T,U extends T, V extends T> T with(
@DelegatesTo.Target("self") U self,
boolean returning,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
@SuppressWarnings("unchecked")
final Closure<V> clonedClosure = (Closure<V>) closure.clone();
clonedClosure.setResolveStrategy(Closure.DELEGATE_FIRST);
clonedClosure.setDelegate(self);
V result = clonedClosure.call(self);
return returning ? self : result;
}
/**
* Allows the closure to be called for the object reference self (similar
* to <code>with</code> and always returns self.
* <p>
* Any method invoked inside the closure will first be invoked on the
* self reference. For instance, the following method calls to the append()
* method are invoked on the StringBuilder instance:
* <pre>
* def b = new StringBuilder().tap {
* append('foo')
* append('bar')
* }
* assert b.toString() == 'foobar'
* </pre>
* This is commonly used to simplify object creation, such as this example:
* <pre>
* def p = new Person().tap {
* firstName = 'John'
* lastName = 'Doe'
* }
* </pre>
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return self
* @see #with(Object, boolean, Closure)
* @see #with(Object, Closure)
* @since 2.5.0
*/
@SuppressWarnings("unchecked")
public static <T,U> U tap(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return (U) with(self, true, (Closure<Object>)closure);
}
/**
* Allows the subscript operator to be used to lookup dynamic property values.
* <code>bean[somePropertyNameExpression]</code>. The normal property notation
* of groovy is neater and more concise but only works with compile-time known
* property names.
*
* @param self the object to act upon
* @param property the property name of interest
* @return the property value
* @since 1.0
*/
public static Object getAt(Object self, String property) {
return InvokerHelper.getProperty(self, property);
}
/**
* Allows the subscript operator to be used to set dynamically named property values.
* <code>bean[somePropertyNameExpression] = foo</code>. The normal property notation
* of groovy is neater and more concise but only works with property names which
* are known at compile time.
*
* @param self the object to act upon
* @param property the name of the property to set
* @param newValue the value to set
* @since 1.0
*/
public static void putAt(Object self, String property, Object newValue) {
InvokerHelper.setProperty(self, property, newValue);
}
/**
* Generates a detailed dump string of an object showing its class,
* hashCode and fields.
*
* @param self an object
* @return the dump representation
* @since 1.0
*/
public static String dump(Object self) {
if (self == null) {
return "null";
}
StringBuilder buffer = new StringBuilder("<");
Class klass = self.getClass();
buffer.append(klass.getName());
buffer.append("@");
buffer.append(Integer.toHexString(self.hashCode()));
boolean groovyObject = self instanceof GroovyObject;
/*jes this may be rewritten to use the new getProperties() stuff
* but the original pulls out private variables, whereas getProperties()
* does not. What's the real use of dump() here?
*/
while (klass != null) {
for (final Field field : klass.getDeclaredFields()) {
if ((field.getModifiers() & Modifier.STATIC) == 0) {
if (groovyObject && field.getName().equals("metaClass")) {
continue;
}
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
ReflectionUtils.trySetAccessible(field);
return null;
});
buffer.append(" ");
buffer.append(field.getName());
buffer.append("=");
try {
buffer.append(InvokerHelper.toString(field.get(self)));
} catch (Exception e) {
buffer.append(e);
}
}
}
klass = klass.getSuperclass();
}
/* here is a different implementation that uses getProperties(). I have left
* it commented out because it returns a slightly different list of properties;
* i.e. it does not return privates. I don't know what dump() really should be doing,
* although IMO showing private fields is a no-no
*/
/*
List props = getProperties(self);
for(Iterator itr = props.keySet().iterator(); itr.hasNext(); ) {
String propName = itr.next().toString();
// the original skipped this, so I will too
if(pv.getName().equals("class")) continue;
if(pv.getName().equals("metaClass")) continue;
buffer.append(" ");
buffer.append(propName);
buffer.append("=");
try {
buffer.append(InvokerHelper.toString(props.get(propName)));
}
catch (Exception e) {
buffer.append(e);
}
}
*/
buffer.append(">");
return buffer.toString();
}
/**
* Retrieves the list of {@link groovy.lang.MetaProperty} objects for 'self' and wraps it
* in a list of {@link groovy.lang.PropertyValue} objects that additionally provide
* the value for each property of 'self'.
*
* @param self the receiver object
* @return list of {@link groovy.lang.PropertyValue} objects
* @see groovy.util.Expando#getMetaPropertyValues()
* @since 1.0
*/
public static List<PropertyValue> getMetaPropertyValues(Object self) {
MetaClass metaClass = InvokerHelper.getMetaClass(self);
List<MetaProperty> mps = metaClass.getProperties();
List<PropertyValue> props = new ArrayList<>(mps.size());
for (MetaProperty mp : mps) {
props.add(new PropertyValue(self, mp));
}
return props;
}
/**
* Convenience method that calls {@link #getMetaPropertyValues(java.lang.Object)}(self)
* and provides the data in form of simple key/value pairs, i.e. without
* type() information.
*
* @param self the receiver object
* @return meta properties as Map of key/value pairs
* @since 1.0
*/
public static Map getProperties(Object self) {
List<PropertyValue> metaProps = getMetaPropertyValues(self);
Map<String, Object> props = new LinkedHashMap<>(metaProps.size());
for (PropertyValue mp : metaProps) {
try {
props.put(mp.getName(), mp.getValue());
} catch (Exception e) {
LOG.throwing(self.getClass().getName(), "getProperty(" + mp.getName() + ")", e);
}
}
return props;
}
/**
* Scoped use method
*
* @param self any Object
* @param categoryClass a category class to use
* @param closure the closure to invoke with the category in place
* @return the value returned from the closure
* @since 1.0
*/
public static <T> T use(Object self, Class categoryClass, Closure<T> closure) {
return GroovyCategorySupport.use(categoryClass, closure);
}
/**
* Extend object with category methods.
* All methods for given class and all super classes will be added to the object.
*
* @param self any Class
* @param categoryClasses a category classes to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, List<Class> categoryClasses) {
MixinInMetaClass.mixinClassesToMetaClass(self, categoryClasses);
}
/**
* Extend class globally with category methods.
* All methods for given class and all super classes will be added to the class.
*
* @param self any Class
* @param categoryClasses a category classes to use
* @since 1.6.0
*/
public static void mixin(Class self, List<Class> categoryClasses) {
mixin(getMetaClass(self), categoryClasses);
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(Class self, Class categoryClass) {
mixin(getMetaClass(self), Collections.singletonList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(Class self, Class[] categoryClass) {
mixin(getMetaClass(self), Arrays.asList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, Class categoryClass) {
mixin(self, Collections.singletonList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, Class[] categoryClass) {
mixin(self, Arrays.asList(categoryClass));
}
/**
* Gets the url of the jar file/source file containing the specified class
*
* @param self the class
* @return the url of the jar, {@code null} if the specified class is from JDK
* @since 2.5.0
*/
public static URL getLocation(Class self) {
CodeSource codeSource = self.getProtectionDomain().getCodeSource();
return null == codeSource ? null : codeSource.getLocation();
}
/**
* Scoped use method with list of categories.
*
* @param self any Object
* @param categoryClassList a list of category classes
* @param closure the closure to invoke with the categories in place
* @return the value returned from the closure
* @since 1.0
*/
public static <T> T use(Object self, List<Class> categoryClassList, Closure<T> closure) {
return GroovyCategorySupport.use(categoryClassList, closure);
}
/**
* Allows the usage of addShutdownHook without getting the runtime first.
*
* @param self the object the method is called on (ignored)
* @param closure the shutdown hook action
* @since 1.5.0
*/
public static void addShutdownHook(Object self, Closure closure) {
Runtime.getRuntime().addShutdownHook(new Thread(closure));
}
/**
* Allows you to use a list of categories, specifying the list as varargs.
* <code>use(CategoryClass1, CategoryClass2) { ... }</code>
* This method saves having to wrap the category
* classes in a list.
*
* @param self any Object
* @param array a list of category classes and a Closure
* @return the value returned from the closure
* @since 1.0
*/
public static Object use(Object self, Object[] array) {
if (array.length < 2)
throw new IllegalArgumentException(
"Expecting at least 2 arguments, a category class and a Closure");
Closure closure;
try {
closure = (Closure) array[array.length - 1];
} catch (ClassCastException e) {
throw new IllegalArgumentException("Expecting a Closure to be the last argument");
}
List<Class> list = new ArrayList<>(array.length - 1);
for (int i = 0; i < array.length - 1; ++i) {
Class categoryClass;
try {
categoryClass = (Class) array[i];
} catch (ClassCastException e) {
throw new IllegalArgumentException("Expecting a Category Class for argument " + i);
}
list.add(categoryClass);
}
return GroovyCategorySupport.use(list, closure);
}
/**
* Print a value formatted Groovy style to self if it
* is a Writer, otherwise to the standard output stream.
*
* @param self any Object
* @param value the value to print
* @since 1.0
*/
public static void print(Object self, Object value) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
try {
((Writer) self).write(InvokerHelper.toString(value));
} catch (IOException e) {
// TODO: Should we have some unified function like PrintWriter.checkError()?
}
} else {
System.out.print(InvokerHelper.toString(value));
}
}
/**
* Print a value formatted Groovy style to the print writer.
*
* @param self a PrintWriter
* @param value the value to print
* @since 1.0
*/
public static void print(PrintWriter self, Object value) {
self.print(InvokerHelper.toString(value));
}
/**
* Print a value formatted Groovy style to the print stream.
*
* @param self a PrintStream
* @param value the value to print
* @since 1.6.0
*/
public static void print(PrintStream self, Object value) {
self.print(InvokerHelper.toString(value));
}
/**
* Print a value to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param value the value to print
* @since 1.0
*/
public static void print(Closure self, Object value) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "print", new Object[]{value});
}
/**
* Print a linebreak to the standard output stream.
*
* @param self any Object
* @since 1.0
*/
public static void println(Object self) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
PrintWriter pw = new GroovyPrintWriter((Writer) self);
pw.println();
} else {
System.out.println();
}
}
/**
* Print a linebreak to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a closure
* @since 1.0
*/
public static void println(Closure self) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "println", EMPTY_OBJECT_ARRAY);
}
private static Object getClosureOwner(Closure cls) {
Object owner = cls.getOwner();
while (owner instanceof GeneratedClosure) {
owner = ((Closure) owner).getOwner();
}
return owner;
}
/**
* Print a value formatted Groovy style (followed by a newline) to self
* if it is a Writer, otherwise to the standard output stream.
*
* @param self any Object
* @param value the value to print
* @since 1.0
*/
public static void println(Object self, Object value) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
final PrintWriter pw = new GroovyPrintWriter((Writer) self);
pw.println(value);
} else {
System.out.println(InvokerHelper.toString(value));
}
}
/**
* Print a value formatted Groovy style (followed by a newline) to the print writer.
*
* @param self a PrintWriter
* @param value the value to print
* @since 1.0
*/
public static void println(PrintWriter self, Object value) {
self.println(InvokerHelper.toString(value));
}
/**
* Print a value formatted Groovy style (followed by a newline) to the print stream.
*
* @param self any Object
* @param value the value to print
* @since 1.6.0
*/
public static void println(PrintStream self, Object value) {
self.println(InvokerHelper.toString(value));
}
/**
* Print a value (followed by a newline) to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a closure
* @param value the value to print
* @since 1.0
*/
public static void println(Closure self, Object value) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "println", new Object[]{value});
}
/**
* Printf to the standard output stream.
*
* @param self any Object
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @since 1.0
*/
public static void printf(Object self, String format, Object[] values) {
if (self instanceof PrintStream)
((PrintStream)self).printf(format, values);
else
System.out.printf(format, values);
}
/**
* Printf 0 or more values to the standard output stream using a format string.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @since 3.0.0
*/
public static void printf(Closure self, String format, Object[] values) {
Object owner = getClosureOwner(self);
Object[] newValues = new Object[values.length + 1];
newValues[0] = format;
System.arraycopy(values, 0, newValues, 1, values.length);
InvokerHelper.invokeMethod(owner, "printf", newValues);
}
/**
* Printf a value to the standard output stream using a format string.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param format a format string
* @param value value referenced by the format specifier in the format string
* @since 3.0.0
*/
public static void printf(Closure self, String format, Object value) {
Object owner = getClosureOwner(self);
Object[] newValues = new Object[2];
newValues[0] = format;
newValues[1] = value;
InvokerHelper.invokeMethod(owner, "printf", newValues);
}
/**
* Sprintf to a string.
*
* @param self any Object
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @return the resulting formatted string
* @since 1.5.0
*/
public static String sprintf(Object self, String format, Object[] values) {
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
PrintStream out = new PrintStream(outputStream);
out.printf(format, values);
return outputStream.toString();
}
/**
* Prints a formatted string using the specified format string and arguments.
* <p>
* Examples:
* <pre>
* printf ( "Hello, %s!\n" , [ "world" ] as String[] )
* printf ( "Hello, %s!\n" , [ "Groovy" ])
* printf ( "%d + %d = %d\n" , [ 1 , 2 , 1+2 ] as Integer[] )
* printf ( "%d + %d = %d\n" , [ 3 , 3 , 3+3 ])
*
* ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as Integer[] ) }
* ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as int[] ) }
* ( 0x41..0x45 ).each { printf ( "-- %c\n" , [ it ] as char[] ) }
* ( 07..011 ).each { printf ( "-- %d\n" , [ it ] as byte[] ) }
* ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as short[] ) }
* ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as long[] ) }
* ( 7..11 ).each { printf ( "-- %5.2f\n" , [ it ] as float[] ) }
* ( 7..11 ).each { printf ( "-- %5.2g\n" , [ it ] as double[] ) }
* </pre>
*
* @param self any Object
* @param format A format string
* @param arg Argument which is referenced by the format specifiers in the format
* string. The type of <code>arg</code> should be one of Object[], List,
* int[], short[], byte[], char[], boolean[], long[], float[], or double[].
* @since 1.0
*/
public static void printf(Object self, String format, Object arg) {
if (self instanceof PrintStream)
printf((PrintStream) self, format, arg);
else if (self instanceof Writer)
printf((Writer) self, format, arg);
else
printf(System.out, format, arg);
}
private static void printf(PrintStream self, String format, Object arg) {
self.print(sprintf(self, format, arg));
}
private static void printf(Writer self, String format, Object arg) {
try {
self.write(sprintf(self, format, arg));
} catch (IOException e) {
printf(System.out, format, arg);
}
}
/**
* Returns a formatted string using the specified format string and
* arguments.
*
* @param self any Object
* @param format A format string
* @param arg Argument which is referenced by the format specifiers in the format
* string. The type of <code>arg</code> should be one of Object[], List,
* int[], short[], byte[], char[], boolean[], long[], float[], or double[].
* @return the resulting printf'd string
* @since 1.5.0
*/
public static String sprintf(Object self, String format, Object arg) {
if (arg instanceof Object[]) {
return sprintf(self, format, (Object[]) arg);
}
if (arg instanceof List) {
return sprintf(self, format, ((List) arg).toArray());
}
if (!arg.getClass().isArray()) {
Object[] o = (Object[]) java.lang.reflect.Array.newInstance(arg.getClass(), 1);
o[0] = arg;
return sprintf(self, format, o);
}
Object[] ans;
String elemType = arg.getClass().getName();
switch (elemType) {
case "[I":
int[] ia = (int[]) arg;
ans = new Integer[ia.length];
for (int i = 0; i < ia.length; i++) {
ans[i] = ia[i];
}
break;
case "[C":
char[] ca = (char[]) arg;
ans = new Character[ca.length];
for (int i = 0; i < ca.length; i++) {
ans[i] = ca[i];
}
break;
case "[Z": {
boolean[] ba = (boolean[]) arg;
ans = new Boolean[ba.length];
for (int i = 0; i < ba.length; i++) {
ans[i] = ba[i];
}
break;
}
case "[B": {
byte[] ba = (byte[]) arg;
ans = new Byte[ba.length];
for (int i = 0; i < ba.length; i++) {
ans[i] = ba[i];
}
break;
}
case "[S":
short[] sa = (short[]) arg;
ans = new Short[sa.length];
for (int i = 0; i < sa.length; i++) {
ans[i] = sa[i];
}
break;
case "[F":
float[] fa = (float[]) arg;
ans = new Float[fa.length];
for (int i = 0; i < fa.length; i++) {
ans[i] = fa[i];
}
break;
case "[J":
long[] la = (long[]) arg;
ans = new Long[la.length];
for (int i = 0; i < la.length; i++) {
ans[i] = la[i];
}
break;
case "[D":
double[] da = (double[]) arg;
ans = new Double[da.length];
for (int i = 0; i < da.length; i++) {
ans[i] = da[i];
}
break;
default:
throw new RuntimeException("sprintf(String," + arg + ")");
}
return sprintf(self, format, ans);
}
/**
* Inspects returns the String that matches what would be typed into a
* terminal to create this object.
*
* @param self any Object
* @return a String that matches what would be typed into a terminal to
* create this object. e.g. [1, 'hello'].inspect() {@code ->} [1, "hello"]
* @since 1.0
*/
public static String inspect(Object self) {
return InvokerHelper.inspect(self);
}
/**
* Print to a console in interactive format.
*
* @param self any Object
* @param out the PrintWriter used for printing
* @since 1.0
*/
public static void print(Object self, PrintWriter out) {
if (out == null) {
out = new PrintWriter(System.out);
}
out.print(InvokerHelper.toString(self));
}
/**
* Print to a console in interactive format.
*
* @param self any Object
* @param out the PrintWriter used for printing
* @since 1.0
*/
public static void println(Object self, PrintWriter out) {
if (out == null) {
out = new PrintWriter(System.out);
}
out.println(InvokerHelper.toString(self));
}
/**
* Provide a dynamic method invocation method which can be overloaded in
* classes to implement dynamic proxies easily.
*
* @param object any Object
* @param method the name of the method to call
* @param arguments the arguments to use
* @return the result of the method call
* @since 1.0
*/
public static Object invokeMethod(Object object, String method, Object arguments) {
return InvokerHelper.invokeMethod(object, method, arguments);
}
// isCase methods
//-------------------------------------------------------------------------
/**
* Method for overloading the behavior of the 'case' method in switch statements.
* The default implementation handles arrays types but otherwise simply delegates
* to Object#equals, but this may be overridden for other types. In this example:
* <pre> switch( a ) {
* case b: //some code
* }</pre>
* "some code" is called when <code>b.isCase( a )</code> returns
* <code>true</code>.
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the switchValue is deemed to be equal to the caseValue
* @since 1.0
*/
public static boolean isCase(Object caseValue, Object switchValue) {
if (caseValue.getClass().isArray()) {
return isCase(DefaultTypeTransformation.asCollection(caseValue), switchValue);
}
return caseValue.equals(switchValue);
}
/**
* Special 'Case' implementation for Class, which allows testing
* for a certain class in a switch statement.
* For example:
* <pre>switch( obj ) {
* case List :
* // obj is a list
* break;
* case Set :
* // etc
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the switchValue is deemed to be assignable from the given class
* @since 1.0
*/
public static boolean isCase(Class caseValue, Object switchValue) {
if (switchValue instanceof Class) {
Class val = (Class) switchValue;
return caseValue.isAssignableFrom(val);
}
return caseValue.isInstance(switchValue);
}
/**
* 'Case' implementation for collections which tests if the 'switch'
* operand is contained in any of the 'case' values.
* For example:
* <pre class="groovyTestCase">switch( 3 ) {
* case [1,3,5]:
* assert true
* break
* default:
* assert false
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the caseValue is deemed to contain the switchValue
* @see java.util.Collection#contains(java.lang.Object)
* @since 1.0
*/
public static boolean isCase(Collection caseValue, Object switchValue) {
return caseValue.contains(switchValue);
}
/**
* 'Case' implementation for maps which tests the groovy truth
* value obtained using the 'switch' operand as key.
* For example:
* <pre class="groovyTestCase">switch( 'foo' ) {
* case [foo:true, bar:false]:
* assert true
* break
* default:
* assert false
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return the groovy truth value from caseValue corresponding to the switchValue key
* @since 1.7.6
*/
public static boolean isCase(Map caseValue, Object switchValue) {
return DefaultTypeTransformation.castToBoolean(caseValue.get(switchValue));
}
/**
* Special 'case' implementation for all numbers, which delegates to the
* <code>compareTo()</code> method for comparing numbers of different
* types.
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the numbers are deemed equal
* @since 1.5.0
*/
public static boolean isCase(Number caseValue, Number switchValue) {
return NumberMath.compareTo(caseValue, switchValue) == 0;
}
/**
* Returns an iterator equivalent to this iterator with all duplicated items removed
* by using Groovy's default number-aware comparator. The original iterator will become
* exhausted of elements after determining the unique values. A new iterator
* for the unique values will be returned.
*
* @param self an Iterator
* @return a new Iterator of the unique items from the original iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self) {
return uniqueItems(new IteratorIterableAdapter<>(self)).listIterator();
}
/**
* Modifies this collection to remove all duplicated items, using Groovy's
* default number-aware comparator.
* <pre class="groovyTestCase">assert [1,3] == [1,3,3].unique()</pre>
*
* @param self a collection
* @return the now modified collection
* @see #unique(Collection, boolean)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self) {
return unique(self, true);
}
/**
* Modifies this List to remove all duplicated items, using Groovy's
* default number-aware comparator.
* <pre class="groovyTestCase">assert [1,3] == [1,3,3].unique()</pre>
*
* @param self a List
* @return the now modified List
* @see #unique(Collection, boolean)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self) {
return (List<T>) unique((Collection<T>) self, true);
}
/**
* Remove all duplicates from a given Collection using Groovy's default number-aware comparator.
* If mutate is true, it works by modifying the original object (and also returning it).
* If mutate is false, a new collection is returned leaving the original unchanged.
* <pre class="groovyTestCase">
* assert [1,3] == [1,3,3].unique()
* </pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2, 3]
* def uniq = orig.unique(false)
* assert orig == [1, 3, 2, 3]
* assert uniq == [1, 3, 2]
* </pre>
*
* @param self a collection
* @param mutate false will cause a new list containing unique items from the collection to be created, true will mutate collections in place
* @return the now modified collection
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate) {
List<T> answer = uniqueItems(self);
if (mutate) {
self.clear();
self.addAll(answer);
}
return mutate ? self : answer ;
}
private static <T> List<T> uniqueItems(Iterable<T> self) {
List<T> answer = new ArrayList<>();
for (T t : self) {
boolean duplicated = false;
for (T t2 : answer) {
if (coercedEquals(t, t2)) {
duplicated = true;
break;
}
}
if (!duplicated)
answer.add(t);
}
return answer;
}
/**
* Remove all duplicates from a given List using Groovy's default number-aware comparator.
* If mutate is true, it works by modifying the original object (and also returning it).
* If mutate is false, a new collection is returned leaving the original unchanged.
* <pre class="groovyTestCase">
* assert [1,3] == [1,3,3].unique()
* </pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2, 3]
* def uniq = orig.unique(false)
* assert orig == [1, 3, 2, 3]
* assert uniq == [1, 3, 2]
* </pre>
*
* @param self a List
* @param mutate false will cause a new List containing unique items from the List to be created, true will mutate List in place
* @return the now modified List
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate) {
return (List<T>) unique((Collection<T>) self, mutate);
}
/**
* Provides a method that compares two comparables using Groovy's
* default number aware comparator.
*
* @param self a Comparable
* @param other another Comparable
* @return a -ve number, 0 or a +ve number according to Groovy's compareTo contract
* @since 1.6.0
*/
public static int numberAwareCompareTo(Comparable self, Comparable other) {
return COMPARABLE_NUMBER_AWARE_COMPARATOR.compare(self, other);
}
/**
* Returns an iterator equivalent to this iterator but with all duplicated items
* removed by using a Closure to determine duplicate (equal) items.
* The original iterator will be fully processed after the call.
* <p>
* If the closure takes a single parameter, the argument passed will be each element,
* and the closure should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the Iterator
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
*
* @param self an Iterator
* @param condition a Closure used to determine unique items
* @return the modified Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<>(condition, true)
: new ClosureComparator<>(condition);
return unique(self, comparator);
}
/**
* A convenience method for making a collection unique using a Closure
* to determine duplicate (equal) items.
* <p>
* If the closure takes a single parameter, the
* argument passed will be each element, and the closure
* should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].unique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].unique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self a Collection
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @see #unique(Collection, boolean, Closure)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return unique(self, true, closure);
}
/**
* A convenience method for making a List unique using a Closure
* to determine duplicate (equal) items.
* <p>
* If the closure takes a single parameter, the
* argument passed will be each element, and the closure
* should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the List
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].unique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].unique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self a List
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @see #unique(Collection, boolean, Closure)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return (List<T>) unique((Collection<T>) self, true, closure);
}
/**
* A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.
* If mutate is true, it works on the receiver object and returns it. If mutate is false, a new collection is returned.
* <p>
* If the closure takes a single parameter, each element from the Collection will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def orig = [1, 3, 4, 5]
* def uniq = orig.unique(false) { it % 2 }
* assert orig == [1, 3, 4, 5]
* assert uniq == [1, 4]
* </pre>
* <pre class="groovyTestCase">
* def orig = [2, 3, 3, 4]
* def uniq = orig.unique(false) { a, b {@code ->} a {@code <=>} b }
* assert orig == [2, 3, 3, 4]
* assert uniq == [2, 3, 4]
* </pre>
*
* @param self a Collection
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
// use a comparator of one item or two
int params = closure.getMaximumNumberOfParameters();
if (params == 1) {
self = unique(self, mutate, new OrderBy<>(closure, true));
} else {
self = unique(self, mutate, new ClosureComparator<>(closure));
}
return self;
}
/**
* A convenience method for making a List unique using a Closure to determine duplicate (equal) items.
* If mutate is true, it works on the receiver object and returns it. If mutate is false, a new collection is returned.
* <p>
* If the closure takes a single parameter, each element from the List will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def orig = [1, 3, 4, 5]
* def uniq = orig.unique(false) { it % 2 }
* assert orig == [1, 3, 4, 5]
* assert uniq == [1, 4]
* </pre>
* <pre class="groovyTestCase">
* def orig = [2, 3, 3, 4]
* def uniq = orig.unique(false) { a, b {@code ->} a {@code <=>} b }
* assert orig == [2, 3, 3, 4]
* assert uniq == [2, 3, 4]
* </pre>
*
* @param self a List
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return (List<T>) unique((Collection<T>) self, mutate, closure);
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the supplied comparator. The original iterator
* will be exhausted upon returning.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the modified Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self, Comparator<T> comparator) {
return uniqueItems(new IteratorIterableAdapter<>(self), comparator).listIterator();
}
private static final class IteratorIterableAdapter<T> implements Iterable<T> {
private final Iterator<T> self;
private IteratorIterableAdapter(Iterator<T> self) {
this.self = self;
}
@Override
public Iterator<T> iterator() {
return self;
}
}
/**
* Remove all duplicates from a given Collection.
* Works on the original object (and also returns it).
* The order of members in the Collection are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given Collection's iterator is retained, but all other ones are removed.
* The given Collection's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(new PersonComparator())
* assert( list2 == list {@code &&} list == [a, b, c] )
* </pre>
*
* @param self a Collection
* @param comparator a Comparator
* @return self the now modified collection without duplicates
* @see #unique(java.util.Collection, boolean, java.util.Comparator)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self, Comparator<T> comparator) {
return unique(self, true, comparator) ;
}
/**
* Remove all duplicates from a given List.
* Works on the original object (and also returns it).
* The order of members in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given List's iterator is retained, but all other ones are removed.
* The given List's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(new PersonComparator())
* assert( list2 == list {@code &&} list == [a, b, c] )
* </pre>
*
* @param self a List
* @param comparator a Comparator
* @return self the now modified List without duplicates
* @see #unique(java.util.Collection, boolean, java.util.Comparator)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, Comparator<T> comparator) {
return (List<T>) unique((Collection<T>) self, true, comparator);
}
/**
* Remove all duplicates from a given Collection.
* If mutate is true, it works on the original object (and also returns it). If mutate is false, a new collection is returned.
* The order of members in the Collection are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given Collection's iterator is retained, but all other ones are removed.
* The given Collection's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(false, new PersonComparator())
* assert( list2 != list {@code &&} list2 == [a, b, c] )
* </pre>
*
* @param self a Collection
* @param mutate false will always cause a new collection to be created, true will mutate collections in place
* @param comparator a Comparator
* @return self the collection without duplicates
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate, Comparator<T> comparator) {
List<T> answer = uniqueItems(self, comparator);
if (mutate) {
self.clear();
self.addAll(answer);
}
return mutate ? self : answer;
}
private static <T> List<T> uniqueItems(Iterable<T> self, Comparator<T> comparator) {
List<T> answer = new ArrayList<>();
for (T t : self) {
boolean duplicated = false;
for (T t2 : answer) {
if (comparator.compare(t, t2) == 0) {
duplicated = true;
break;
}
}
if (!duplicated)
answer.add(t);
}
return answer;
}
/**
* Remove all duplicates from a given List.
* If mutate is true, it works on the original object (and also returns it). If mutate is false, a new List is returned.
* The order of members in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given List's iterator is retained, but all other ones are removed.
* The given List's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(false, new PersonComparator())
* assert( list2 != list {@code &&} list2 == [a, b, c] )
* </pre>
*
* @param self a List
* @param mutate false will always cause a new List to be created, true will mutate List in place
* @param comparator a Comparator
* @return self the List without duplicates
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate, Comparator<T> comparator) {
return (List<T>) unique((Collection<T>) self, mutate, comparator);
}
/**
* Returns an iterator equivalent to this iterator but with all duplicated items
* removed where duplicate (equal) items are deduced by calling the supplied Closure condition.
* <p>
* If the supplied Closure takes a single parameter, the argument passed will be each element,
* and the closure should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the Iterator
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def items = "Hello".toList() + [null, null] + "there".toList()
* def toLower = { it == null ? null : it.toLowerCase() }
* def noDups = items.iterator().toUnique(toLower).toList()
* assert noDups == ['H', 'e', 'l', 'o', null, 't', 'r']
* </pre>
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].toUnique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].toUnique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self an Iterator
* @param condition a Closure used to determine unique items
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
return toUnique(self, condition.getMaximumNumberOfParameters() == 1
? new OrderBy<>(condition, true)
: new ClosureComparator<>(condition));
}
private static final class ToUniqueIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final Set<E> seen;
private boolean exhausted;
private E next;
private ToUniqueIterator(Iterator<E> delegate, Comparator<E> comparator) {
this.delegate = delegate;
seen = new TreeSet<>(comparator);
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
boolean foundNext = false;
while (!foundNext && !exhausted) {
exhausted = !delegate.hasNext();
if (!exhausted) {
next = delegate.next();
foundNext = seen.add(next);
}
}
}
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the supplied comparator.
*
* @param self an Iterator
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self, Comparator<T> comparator) {
return new ToUniqueIterator<>(self, comparator);
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the natural ordering of the items.
*
* @param self an Iterator
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed.
* The items in the Iterable are compared by the given Comparator.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.toUnique(new PersonComparator())
* assert list2 == [a, b, c] {@code &&} list == [a, b, c, d]
* </pre>
*
* @param self an Iterable
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the Collection of non-duplicate items
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self, Comparator<T> comparator) {
Collection<T> result = createSimilarCollection((Collection<T>) self);
addAll(result, toUnique(self.iterator(), comparator));
return result;
}
/**
* Returns a List containing the items from the List but with duplicates removed.
* The items in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned from the
* List is retained, but all other ones are removed.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.toUnique(new PersonComparator())
* assert list2 == [a, b, c] {@code &&} list == [a, b, c, d]
* </pre>
*
* @param self a List
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the List of non-duplicate items
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self, Comparator<T> comparator) {
return (List<T>) toUnique((Iterable<T>) self, comparator);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed
* using the natural ordering of the items to determine uniqueness.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* String[] expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique() == expected
* </pre>
*
* @param self an Iterable
* @return the Collection of non-duplicate items
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a List containing the items from the List but with duplicates removed
* using the natural ordering of the items to determine uniqueness.
* <p>
* <pre class="groovyTestCase">
* def letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* def expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique() == expected
* </pre>
*
* @param self a List
* @return the List of non-duplicate items
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed.
* The items in the Iterable are compared by the given Closure condition.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* If the closure takes a single parameter, each element from the Iterable will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the Iterable
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* def list2 = list.toUnique{ p1, p2 {@code ->} p1.lname != p2.lname ? p1.lname <=> p2.lname : p1.fname <=> p2.fname }
* assert( list2 == [a, b, c] {@code &&} list == [a, b, c, d] )
* def list3 = list.toUnique{ it.toString() }
* assert( list3 == [a, b, c] {@code &&} list == [a, b, c, d] )
* </pre>
*
* @param self an Iterable
* @param condition a Closure used to determine unique items
* @return a new Collection
* @see #toUnique(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self, @ClosureParams(value = FromString.class, options = {"T", "T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<>(condition, true)
: new ClosureComparator<>(condition);
return toUnique(self, comparator);
}
/**
* Returns a List containing the items from the List but with duplicates removed.
* The items in the List are compared by the given Closure condition.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* If the closure takes a single parameter, each element from the Iterable will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the Iterable
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* def list2 = list.toUnique{ p1, p2 {@code ->} p1.lname != p2.lname ? p1.lname <=> p2.lname : p1.fname <=> p2.fname }
* assert( list2 == [a, b, c] {@code &&} list == [a, b, c, d] )
* def list3 = list.toUnique{ it.toString() }
* assert( list3 == [a, b, c] {@code &&} list == [a, b, c, d] )
* </pre>
*
* @param self a List
* @param condition a Closure used to determine unique items
* @return a new List
* @see #toUnique(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self, @ClosureParams(value = FromString.class, options = {"T", "T,T"}) Closure condition) {
return (List<T>) toUnique((Iterable<T>) self, condition);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed with the supplied
* comparator determining which items are unique.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T']
* String[] lower = ['c', 'a', 't', 's', 'h']
* class LowerComparator implements Comparator {
* int compare(let1, let2) { let1.toLowerCase() {@code <=>} let2.toLowerCase() }
* }
* assert letters.toUnique(new LowerComparator()) == lower
* </pre>
*
* @param self an array
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the unique items from the array
*/
public static <T> T[] toUnique(T[] self, Comparator<T> comparator) {
Collection<T> items = toUnique(toList(self), comparator);
T[] result = createSimilarArray(self, items.size());
return items.toArray(result);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed using the
* natural ordering of the items in the array.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* String[] expected = ['c', 'a', 't', 's', 'h']
* def result = letters.toUnique()
* assert result == expected
* assert result.class.componentType == String
* </pre>
*
* @param self an array
* @return the unique items from the array
*/
@SuppressWarnings("unchecked")
public static <T> T[] toUnique(T[] self) {
return (T[]) toUnique(self, (Comparator) null);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed with the supplied
* comparator determining which items are unique.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T']
* String[] expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique{ p1, p2 {@code ->} p1.toLowerCase() {@code <=>} p2.toLowerCase() } == expected
* assert letters.toUnique{ it.toLowerCase() } == expected
* </pre>
*
* @param self an array
* @param condition a Closure used to determine unique items
* @return the unique items from the array
*/
public static <T> T[] toUnique(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<>(condition, true)
: new ClosureComparator<>(condition);
return toUnique(self, comparator);
}
/**
* Iterates through an array passing each array entry to the given closure.
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c']
* String result = ''
* letters.each{ result += it }
* assert result == 'abc'
* </pre>
*
* @param self the array over which we iterate
* @param closure the closure applied on each array entry
* @return the self array
* @since 2.5.0
*/
public static <T> T[] each(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
for(T item : self){
closure.call(item);
}
return self;
}
/**
* Iterates through an aggregate type or data structure,
* passing each item to the given closure. Custom types may utilize this
* method by simply providing an "iterator()" method. The items returned
* from the resulting iterator will be passed to the closure.
* <pre class="groovyTestCase">
* String result = ''
* ['a', 'b', 'c'].each{ result += it }
* assert result == 'abc'
* </pre>
*
* @param self the object over which we iterate
* @param closure the closure applied on each element found
* @return the self Object
* @since 1.0
*/
public static <T> T each(T self, Closure closure) {
each(InvokerHelper.asIterator(self), closure);
return self;
}
/**
* Iterates through an array,
* passing each array element and the element's index (a counter starting at
* zero) to the given closure.
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c']
* String result = ''
* letters.eachWithIndex{ letter, index {@code ->} result += "$index:$letter" }
* assert result == '0:a1:b2:c'
* </pre>
*
* @param self an array
* @param closure a Closure to operate on each array entry
* @return the self array
* @since 2.5.0
*/
public static <T> T[] eachWithIndex(T[] self, @ClosureParams(value=FromString.class, options="T,Integer") Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
for(T item : self) {
args[0] = item;
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through an aggregate type or data structure,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
* <pre class="groovyTestCase">
* String result = ''
* ['a', 'b', 'c'].eachWithIndex{ letter, index {@code ->} result += "$index:$letter" }
* assert result == '0:a1:b2:c'
* </pre>
*
* @param self an Object
* @param closure a Closure to operate on each item
* @return the self Object
* @since 1.0
*/
public static <T> T eachWithIndex(T self, /*@ClosureParams(value=FromString.class, options="?,Integer")*/ Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
args[0] = iter.next();
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through an iterable type,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self an Iterable
* @param closure a Closure to operate on each item
* @return the self Iterable
* @since 2.3.0
*/
public static <T> Iterable<T> eachWithIndex(Iterable<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
eachWithIndex(self.iterator(), closure);
return self;
}
/**
* Iterates through an iterator type,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self an Iterator
* @param closure a Closure to operate on each item
* @return the self Iterator (now exhausted)
* @since 2.3.0
*/
public static <T> Iterator<T> eachWithIndex(Iterator<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
while (self.hasNext()) {
args[0] = self.next();
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through a Collection,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a Collection
* @param closure a Closure to operate on each item
* @return the self Collection
* @since 2.4.0
*/
public static <T> Collection<T> eachWithIndex(Collection<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (Collection<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a List,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a List
* @param closure a Closure to operate on each item
* @return the self List
* @since 2.4.0
*/
public static <T> List<T> eachWithIndex(List<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (List<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a Set,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a Set
* @param closure a Closure to operate on each item
* @return the self Set
* @since 2.4.0
*/
public static <T> Set<T> eachWithIndex(Set<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (Set<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a SortedSet,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a SortedSet
* @param closure a Closure to operate on each item
* @return the self SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> eachWithIndex(SortedSet<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (SortedSet<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through an Iterable, passing each item to the given closure.
*
* @param self the Iterable over which we iterate
* @param closure the closure applied on each element found
* @return the self Iterable
*/
public static <T> Iterable<T> each(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
each(self.iterator(), closure);
return self;
}
/**
* Iterates through an Iterator, passing each item to the given closure.
*
* @param self the Iterator over which we iterate
* @param closure the closure applied on each element found
* @return the self Iterator
* @since 2.4.0
*/
public static <T> Iterator<T> each(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
while (self.hasNext()) {
Object arg = self.next();
closure.call(arg);
}
return self;
}
/**
* Iterates through a Collection, passing each item to the given closure.
*
* @param self the Collection over which we iterate
* @param closure the closure applied on each element found
* @return the self Collection
* @since 2.4.0
*/
public static <T> Collection<T> each(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Collection<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a List, passing each item to the given closure.
*
* @param self the List over which we iterate
* @param closure the closure applied on each element found
* @return the self List
* @since 2.4.0
*/
public static <T> List<T> each(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a Set, passing each item to the given closure.
*
* @param self the Set over which we iterate
* @param closure the closure applied on each element found
* @return the self Set
* @since 2.4.0
*/
public static <T> Set<T> each(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Set<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a SortedSet, passing each item to the given closure.
*
* @param self the SortedSet over which we iterate
* @param closure the closure applied on each element found
* @return the self SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> each(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (SortedSet<T>) each((Iterable<T>) self, closure);
}
/**
* Allows a Map to be iterated through using a closure. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].each { key, value {@code ->} result += "$key$value" }
* assert result == "a1b3"</pre>
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].each { entry {@code ->} result += entry }
* assert result == "a=1b=3"</pre>
*
* In general, the order in which the map contents are processed
* cannot be guaranteed. In practise, specialized forms of Map,
* e.g. a TreeMap will have its contents processed according to
* the natural ordering of the map.
*
* @param self the map over which we iterate
* @param closure the 1 or 2 arg closure applied on each entry of the map
* @return returns the self parameter
* @since 1.5.0
*/
public static <K, V> Map<K, V> each(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
for (Map.Entry entry : self.entrySet()) {
callClosureForMapEntry(closure, entry);
}
return self;
}
/**
* Allows a Map to be iterated through in reverse order using a closure.
*
* In general, the order in which the map contents are processed
* cannot be guaranteed. In practise, specialized forms of Map,
* e.g. a TreeMap will have its contents processed according to the
* reverse of the natural ordering of the map.
*
* @param self the map over which we iterate
* @param closure the 1 or 2 arg closure applied on each entry of the map
* @return returns the self parameter
* @see #each(Map, Closure)
* @since 1.7.2
*/
public static <K, V> Map<K, V> reverseEach(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
final Iterator<Map.Entry<K, V>> entries = reverse(self.entrySet().iterator());
while (entries.hasNext()) {
callClosureForMapEntry(closure, entries.next());
}
return self;
}
/**
* Allows a Map to be iterated through using a closure. If the
* closure takes two parameters then it will be passed the Map.Entry and
* the item's index (a counter starting at zero) otherwise if the closure
* takes three parameters then it will be passed the key, the value, and
* the index.
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].eachWithIndex { key, value, index {@code ->} result += "$index($key$value)" }
* assert result == "0(a1)1(b3)"</pre>
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].eachWithIndex { entry, index {@code ->} result += "$index($entry)" }
* assert result == "0(a=1)1(b=3)"</pre>
*
* @param self the map over which we iterate
* @param closure a 2 or 3 arg Closure to operate on each item
* @return the self Object
* @since 1.5.0
*/
public static <K, V> Map<K, V> eachWithIndex(Map<K, V> self, @ClosureParams(value=MapEntryOrKeyValue.class, options="index=true") Closure closure) {
int counter = 0;
for (Map.Entry entry : self.entrySet()) {
callClosureForMapEntryAndCounter(closure, entry, counter++);
}
return self;
}
/**
* Iterate over each element of the list in the reverse order.
* <pre class="groovyTestCase">def result = []
* [1,2,3].reverseEach { result << it }
* assert result == [3,2,1]</pre>
*
* @param self a List
* @param closure a closure to which each item is passed.
* @return the original list
* @since 1.5.0
*/
public static <T> List<T> reverseEach(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
each(new ReverseListIterator<>(self), closure);
return self;
}
/**
* Iterate over each element of the array in the reverse order.
*
* @param self an array
* @param closure a closure to which each item is passed
* @return the original array
* @since 1.5.2
*/
public static <T> T[] reverseEach(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(new ReverseListIterator<>(Arrays.asList(self)), closure);
return self;
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this data structure).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.every { it {@code >} 2 }
* </pre>
*
* @param self the object over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 1.0
*/
public static boolean every(Object self, Closure predicate) {
return every(InvokerHelper.asIterator(self), predicate);
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this iterator).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.iterator().every { it {@code >} 2 }
* </pre>
*
* @param self the iterator over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 2.3.0
*/
public static <T> boolean every(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
while (self.hasNext()) {
if (!bcw.call(self.next())) {
return false;
}
}
return true;
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this Array).
*
* @param self an Array
* @param predicate the closure predicate used for matching
* @return true if every element of the Array matches the closure predicate
* @since 2.5.0
*/
public static <T> boolean every(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
return every(new ArrayIterator<>(self), predicate);
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this iterable).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.every { it {@code >} 2 }
* </pre>
*
* @param self the iterable over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 2.3.0
*/
public static <T> boolean every(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
return every(self.iterator(), predicate);
}
/**
* Iterates over the entries of a map, and checks whether a predicate is
* valid for all entries. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">def map = [a:1, b:2.0, c:2L]
* assert !map.every { key, value {@code ->} value instanceof Integer }
* assert map.every { entry {@code ->} entry.value instanceof Number }</pre>
*
* @param self the map over which we iterate
* @param predicate the 1 or 2 arg Closure predicate used for matching
* @return true if every entry of the map matches the closure predicate
* @since 1.5.0
*/
public static <K, V> boolean every(Map<K, V> self, @ClosureParams(value = MapEntryOrKeyValue.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (!bcw.callForMap(entry)) {
return false;
}
}
return true;
}
/**
* Iterates over every element of a collection, and checks whether all
* elements are <code>true</code> according to the Groovy Truth.
* Equivalent to <code>self.every({element {@code ->} element})</code>
* <pre class="groovyTestCase">
* assert [true, true].every()
* assert [1, 1].every()
* assert ![1, 0].every()
* </pre>
*
* @param self the object over which we iterate
* @return true if every item in the collection matches satisfies Groovy truth
* @since 1.5.0
*/
public static boolean every(Object self) {
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
if (!bmi.convertToBoolean(iter.next())) {
return false;
}
}
return true;
}
/**
* Iterates over the contents of an object or collection, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].any { it == 2 }
* assert ![1, 2, 3].any { it {@code >} 3 }
* </pre>
*
* @param self the object over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static boolean any(Object self, Closure predicate) {
return any(InvokerHelper.asIterator(self), predicate);
}
/**
* Iterates over the contents of an iterator, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].iterator().any { it == 2 }
* assert ![1, 2, 3].iterator().any { it {@code >} 3 }
* </pre>
*
* @param self the iterator over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static <T> boolean any(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
while (self.hasNext()) {
if (bcw.call(self.next())) return true;
}
return false;
}
/**
* Iterates over the contents of an iterable, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].any { it == 2 }
* assert ![1, 2, 3].any { it {@code >} 3 }
* </pre>
*
* @param self the iterable over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static <T> boolean any(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
return any(self.iterator(), predicate);
}
/**
* Iterates over the contents of an Array, and checks whether a
* predicate is valid for at least one element.
*
* @param self the array over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 2.5.0
*/
public static <T> boolean any(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
return any(new ArrayIterator<>(self), predicate);
}
/**
* Iterates over the entries of a map, and checks whether a predicate is
* valid for at least one entry. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">
* assert [2:3, 4:5, 5:10].any { key, value {@code ->} key * 2 == value }
* assert ![2:3, 4:5, 5:10].any { entry {@code ->} entry.key == entry.value * 2 }
* </pre>
*
* @param self the map over which we iterate
* @param predicate the 1 or 2 arg closure predicate used for matching
* @return true if any entry in the map matches the closure predicate
* @since 1.5.0
*/
public static <K, V> boolean any(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
return true;
}
}
return false;
}
/**
* Iterates over the elements of a collection, and checks whether at least
* one element is true according to the Groovy Truth.
* Equivalent to self.any({element {@code ->} element})
* <pre class="groovyTestCase">
* assert [false, true].any()
* assert [0, 1].any()
* assert ![0, 0].any()
* </pre>
*
* @param self the object over which we iterate
* @return true if any item in the collection matches the closure predicate
* @since 1.5.0
*/
public static boolean any(Object self) {
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
if (bmi.convertToBoolean(iter.next())) {
return true;
}
}
return false;
}
/**
* Iterates over the collection of items which this Object represents and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self the object over which we iterate
* @param filter the filter to perform on the object (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 1.5.6
*/
public static Collection grep(Object self, Object filter) {
Collection answer = createSimilarOrDefaultCollection(self);
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
Object object = iter.next();
if (bmi.invoke(filter, object)) {
answer.add(object);
}
}
return answer;
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self a collection
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 2.0
*/
public static <T> Collection<T> grep(Collection<T> self, Object filter) {
Collection<T> answer = createSimilarCollection(self);
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (T element : self) {
if (bmi.invoke(filter, element)) {
answer.add(element);
}
}
return answer;
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self a List
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a List of objects which match the filter
* @since 2.4.0
*/
public static <T> List<T> grep(List<T> self, Object filter) {
return (List<T>) grep((Collection<T>) self, filter);
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def set = ['a', 'b', 'aa', 'bc', 3, 4.5] as Set
* assert set.grep( ~/a+/ ) == ['a', 'aa'] as Set
* assert set.grep( ~/../ ) == ['aa', 'bc'] as Set
* assert set.grep( Number ) == [ 3, 4.5 ] as Set
* assert set.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ] as Set
* </pre>
*
* @param self a Set
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a Set of objects which match the filter
* @since 2.4.0
*/
public static <T> Set<T> grep(Set<T> self, Object filter) {
return (Set<T>) grep((Collection<T>) self, filter);
}
/**
* Iterates over the array of items and returns a collection of items that match
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def items = ['a', 'b', 'aa', 'bc', 3, 4.5] as Object[]
* assert items.grep( ~/a+/ ) == ['a', 'aa']
* assert items.grep( ~/../ ) == ['aa', 'bc']
* assert items.grep( Number ) == [ 3, 4.5 ]
* assert items.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self an array
* @param filter the filter to perform on each element of the array (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 2.0
*/
public static <T> Collection<T> grep(T[] self, Object filter) {
Collection<T> answer = new ArrayList<>();
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (T element : self) {
if (bmi.invoke(filter, element)) {
answer.add(element);
}
}
return answer;
}
/**
* Iterates over the collection of items which this Object represents and returns each item that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self the object over which we iterate
* @return a collection of objects which match the filter
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Collection grep(Object self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a Collection
* @return a collection of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.0
*/
public static <T> Collection<T> grep(Collection<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a List
* @return a List of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.4.0
*/
public static <T> List<T> grep(List<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Set
* assert items.grep() == [1, 2, true, 'foo', [4, 5]] as Set
* </pre>
*
* @param self a Set
* @return a Set of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.4.0
*/
public static <T> Set<T> grep(Set<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the array returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Object[]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an array
* @return a collection of elements which satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.0
*/
public static <T> Collection<T> grep(T[] self) {
return grep(self, Closure.IDENTITY);
}
/**
* Counts the number of occurrences of the given value from the
* items within this Iterator.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
* The iterator will become exhausted of elements after determining the count value.
*
* @param self the Iterator from which we count the number of matching occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.5.0
*/
public static Number count(Iterator self, Object value) {
long answer = 0;
while (self.hasNext()) {
if (DefaultTypeTransformation.compareEqual(self.next(), value)) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* Counts the number of occurrences which satisfy the given closure from the
* items within this Iterator.
* The iterator will become exhausted of elements after determining the count value.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].toSet().iterator().count{ it % 2 == 0 } == 2</pre>
*
* @param self the Iterator from which we count the number of matching occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 1.8.0
*/
public static <T> Number count(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
long answer = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (self.hasNext()) {
if (bcw.call(self.next())) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* @deprecated use count(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static Number count(Collection self, Object value) {
return count(self.iterator(), value);
}
/**
* Counts the number of occurrences of the given value inside this Iterable.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].count(4) == 2</pre>
*
* @param self the Iterable within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 2.2.0
*/
public static Number count(Iterable self, Object value) {
return count(self.iterator(), value);
}
/**
* @deprecated use count(Iterable, Closure)
* @since 1.8.0
*/
@Deprecated
public static Number count(Collection self, Closure closure) {
return count(self.iterator(), closure);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this Iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].count{ it % 2 == 0 } == 5</pre>
*
* @param self the Iterable within which we count the number of occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 2.2.0
*/
public static <T> Number count(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return count(self.iterator(), closure);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this map.
* If the closure takes one parameter then it will be passed the Map.Entry.
* Otherwise, the closure should take two parameters and will be passed the key and value.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [a:1, b:1, c:2, d:2].count{ k,v {@code ->} k == 'a' {@code ||} v == 2 } == 3</pre>
*
* @param self the map within which we count the number of occurrences
* @param closure a 1 or 2 arg Closure condition applying on the entries
* @return the number of occurrences
* @since 1.8.0
*/
public static <K,V> Number count(Map<K,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> closure) {
long answer = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Object entry : self.entrySet()) {
if (bcw.callForMap((Map.Entry)entry)) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(Object[] self, Object value) {
return count((Iterable)Arrays.asList(self), value);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this array.
*
* @param self the array within which we count the number of occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 1.8.0
*/
public static <T> Number count(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return count((Iterable)Arrays.asList(self), closure);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(int[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(long[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(short[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(char[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(boolean[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(double[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(float[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(byte[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* @deprecated Use the Iterable version of toList instead
* @see #toList(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> List<T> toList(Collection<T> self) {
List<T> answer = new ArrayList<T>(self.size());
answer.addAll(self);
return answer;
}
/**
* Convert an iterator to a List. The iterator will become
* exhausted of elements after making this conversion.
*
* @param self an iterator
* @return a List
* @since 1.5.0
*/
public static <T> List<T> toList(Iterator<T> self) {
List<T> answer = new ArrayList<>();
while (self.hasNext()) {
answer.add(self.next());
}
return answer;
}
/**
* Convert an Iterable to a List. The Iterable's iterator will
* become exhausted of elements after making this conversion.
* <p>
* Example usage:
* <pre class="groovyTestCase">def x = [1,2,3] as HashSet
* assert x.class == HashSet
* assert x.toList() instanceof List</pre>
*
* @param self an Iterable
* @return a List
* @since 1.8.7
*/
public static <T> List<T> toList(Iterable<T> self) {
return toList(self.iterator());
}
/**
* Convert an enumeration to a List.
*
* @param self an enumeration
* @return a List
* @since 1.5.0
*/
public static <T> List<T> toList(Enumeration<T> self) {
List<T> answer = new ArrayList<>();
while (self.hasMoreElements()) {
answer.add(self.nextElement());
}
return answer;
}
/**
* Collates this iterable into sub-lists of length <code>size</code>.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4, 5, 6, 7 ]
* def coll = list.collate( 3 )
* assert coll == [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size) {
return collate(self, size, true);
}
/**
* Collates an array.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @return a List containing the array values collated into sub-lists
* @see #collate(Iterable, int)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size) {
return collate((Iterable)Arrays.asList(self), size, true);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size ) {
return collate((Iterable<T>) self, size) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code> stepping through the code <code>step</code>
* elements for each subList.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4 ]
* def coll = list.collate( 3, 1 )
* assert coll == [ [ 1, 2, 3 ], [ 2, 3, 4 ], [ 3, 4 ], [ 4 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, int step) {
return collate(self, size, step, true);
}
/**
* Collates an array into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @return a List containing the array elements collated into sub-lists
* @see #collate(Iterable, int, int)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, int step) {
return collate((Iterable)Arrays.asList(self), size, step, true);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, int)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, int step ) {
return collate((Iterable<T>) self, size, step) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code>. Any remaining elements in
* the iterable after the subdivision will be dropped if <code>keepRemainder</code> is false.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4, 5, 6, 7 ]
* def coll = list.collate( 3, false )
* assert coll == [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, boolean keepRemainder) {
return collate(self, size, size, keepRemainder);
}
/**
* Collates this array into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the array elements collated into sub-lists
* @see #collate(Iterable, int, boolean)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, boolean keepRemainder) {
return collate((Iterable)Arrays.asList(self), size, size, keepRemainder);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, boolean)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, boolean keepRemainder ) {
return collate((Iterable<T>) self, size, keepRemainder) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code> stepping through the code <code>step</code>
* elements for each sub-list. Any remaining elements in the iterable after the subdivision will be dropped if
* <code>keepRemainder</code> is false.
* Example:
* <pre class="groovyTestCase">
* def list = [ 1, 2, 3, 4 ]
* assert list.collate( 2, 2, true ) == [ [ 1, 2 ], [ 3, 4 ] ]
* assert list.collate( 3, 1, true ) == [ [ 1, 2, 3 ], [ 2, 3, 4 ], [ 3, 4 ], [ 4 ] ]
* assert list.collate( 3, 1, false ) == [ [ 1, 2, 3 ], [ 2, 3, 4 ] ]
* </pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the data collated into sub-lists
* @throws IllegalArgumentException if the step is zero.
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, int step, boolean keepRemainder) {
List<T> selfList = asList(self);
List<List<T>> answer = new ArrayList<>();
if (size <= 0) {
answer.add(selfList);
} else {
if (step == 0) throw new IllegalArgumentException("step cannot be zero");
for (int pos = 0; pos < selfList.size() && pos > -1; pos += step) {
if (!keepRemainder && pos > selfList.size() - size) {
break ;
}
List<T> element = new ArrayList<>() ;
for (int offs = pos; offs < pos + size && offs < selfList.size(); offs++) {
element.add(selfList.get(offs));
}
answer.add( element ) ;
}
}
return answer ;
}
/**
* Collates this array into into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the array elements collated into sub-lists
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, int step, boolean keepRemainder) {
return collate((Iterable)Arrays.asList(self), size, step, keepRemainder);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, int, boolean)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, int step, boolean keepRemainder ) {
return collate((Iterable<T>) self, size, step, keepRemainder);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original object.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].iterator().collect()</pre>
*
* @param self an aggregate Object with an Iterator returning its items
* @return a Collection of the transformed values
* @see Closure#IDENTITY
* @since 1.8.5
*/
public static Collection collect(Object self) {
return collect(self, Closure.IDENTITY);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
* Example:
* <pre class="groovyTestCase">def list = [1, 'a', 1.23, true ]
* def types = list.collect { it.class }
* assert types == [Integer, String, BigDecimal, Boolean]</pre>
*
* @param self an aggregate Object with an Iterator returning its items
* @param transform the closure used to transform each item of the aggregate object
* @return a List of the transformed values
* @since 1.0
*/
public static <T> List<T> collect(Object self, Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<>(), transform);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
*
* @param self an aggregate Object with an Iterator returning its items
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item of the aggregate object
* @return the collector with all transformed values added to it
* @since 1.0
*/
public static <T> Collection<T> collect(Object self, Collection<T> collector, Closure<? extends T> transform) {
return collect(InvokerHelper.asIterator(self), collector, transform);
}
/**
* Iterates through this Array transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
*
* @param self an Array
* @param transform the closure used to transform each item of the Array
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> transform) {
return collect(new ArrayIterator<>(self), transform);
}
/**
* Iterates through this Array transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">
* Integer[] nums = [1,2,3]
* List<Integer> answer = []
* nums.collect(answer) { it * 2 }
* assert [2,4,6] == answer
* </pre>
*
* @param self an Array
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(S[] self, Collection<T> collector, @ClosureParams(FirstParam.Component.class) Closure<? extends T> transform) {
return collect(new ArrayIterator<>(self), collector, transform);
}
/**
* Iterates through this Iterator transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
*
* @param self an Iterator
* @param transform the closure used to transform each item
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(Iterator<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<>(), transform);
}
/**
* Iterates through this Iterator transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
*
* @param self an Iterator
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(Iterator<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
while (self.hasNext()) {
collector.add(transform.call(self.next()));
}
return collector;
}
/**
* Iterates through this collection transforming each entry into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original collection.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].collect()</pre>
*
* @param self a collection
* @return a List of the transformed values
* @see Closure#IDENTITY
* @since 1.8.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <T> List<T> collect(Collection<T> self) {
return collect((Iterable<T>) self);
}
/**
* Iterates through this collection transforming each entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
*
* @param self a collection
* @param transform the closure used to transform each item of the collection
* @return a List of the transformed values
* @deprecated use the Iterable version instead
* @since 1.0
*/
@Deprecated
public static <S,T> List<T> collect(Collection<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<T>(self.size()), transform);
}
/**
* Iterates through this collection transforming each value into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }</pre>
*
* @param self a collection
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item of the collection
* @return the collector with all transformed values added to it
* @deprecated use the Iterable version instead
* @since 1.0
*/
@Deprecated
public static <S,T> Collection<T> collect(Collection<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
for (S item : self) {
collector.add(transform.call(item));
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* Iterates through this collection transforming each entry into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original collection.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].collect()</pre>
*
* @param self an Iterable
* @return a List of the transformed values
* @see Closure#IDENTITY
* @since 2.5.0
*/
@SuppressWarnings("unchecked")
public static <T> List<T> collect(Iterable<T> self) {
return collect(self, (Closure<T>) Closure.IDENTITY);
}
/**
* Iterates through this Iterable transforming each entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
* <pre class="groovyTestCase">assert [2,4,6] == [1,2,3].collect { it * 2 }</pre>
*
* @param self an Iterable
* @param transform the closure used to transform each item of the collection
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(Iterable<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return collect(self.iterator(), transform);
}
/**
* Iterates through this collection transforming each value into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }</pre>
*
* @param self an Iterable
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(Iterable<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
for (S item : self) {
collector.add(transform.call(item));
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* Deprecated alias for collectNested
*
* @deprecated Use collectNested instead
* @see #collectNested(Collection, Closure)
*/
@Deprecated
public static List collectAll(Collection self, Closure transform) {
return collectNested(self, transform);
}
/**
* Recursively iterates through this collection transforming each non-Collection value
* into a new value using the closure as a transformer. Returns a potentially nested
* list of transformed values.
* <pre class="groovyTestCase">
* assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectNested { it * 2 }
* </pre>
*
* @param self a collection
* @param transform the closure used to transform each item of the collection
* @return the resultant collection
* @since 1.8.1
*/
public static List collectNested(Collection self, Closure transform) {
return (List) collectNested((Iterable) self, new ArrayList(self.size()), transform);
}
/**
* Recursively iterates through this Iterable transforming each non-Collection value
* into a new value using the closure as a transformer. Returns a potentially nested
* list of transformed values.
* <pre class="groovyTestCase">
* assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectNested { it * 2 }
* </pre>
*
* @param self an Iterable
* @param transform the closure used to transform each item of the Iterable
* @return the resultant list
* @since 2.2.0
*/
public static List collectNested(Iterable self, Closure transform) {
return (List) collectNested(self, new ArrayList(), transform);
}
/**
* Deprecated alias for collectNested
*
* @deprecated Use collectNested instead
* @see #collectNested(Iterable, Collection, Closure)
*/
@Deprecated
public static Collection collectAll(Collection self, Collection collector, Closure transform) {
return collectNested((Iterable)self, collector, transform);
}
/**
* @deprecated Use the Iterable version of collectNested instead
* @see #collectNested(Iterable, Collection, Closure)
* @since 1.8.1
*/
@Deprecated
public static Collection collectNested(Collection self, Collection collector, Closure transform) {
return collectNested((Iterable)self, collector, transform);
}
/**
* Recursively iterates through this Iterable transforming each non-Collection value
* into a new value using the <code>transform</code> closure. Returns a potentially nested
* collection of transformed values.
* <pre class="groovyTestCase">
* def x = [1,[2,3],[4],[]].collectNested(new Vector()) { it * 2 }
* assert x == [2,[4,6],[8],[]]
* assert x instanceof Vector
* </pre>
*
* @param self an Iterable
* @param collector an initial Collection to which the transformed values are added
* @param transform the closure used to transform each element of the Iterable
* @return the collector with all transformed values added to it
* @since 2.2.0
*/
public static Collection collectNested(Iterable self, Collection collector, Closure transform) {
for (Object item : self) {
if (item instanceof Collection) {
Collection c = (Collection) item;
collector.add(collectNested((Iterable)c, createSimilarCollection(collector, c.size()), transform));
} else {
collector.add(transform.call(item));
}
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* @deprecated Use the Iterable version of collectMany instead
* @see #collectMany(Iterable, Closure)
* @since 1.8.1
*/
@Deprecated
public static <T,E> List<T> collectMany(Collection<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)self, projection);
}
/**
* @deprecated Use the Iterable version of collectMany instead
* @see #collectMany(Iterable, Collection, Closure)
* @since 1.8.5
*/
@Deprecated
public static <T,E> Collection<T> collectMany(Collection<E> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)self, collector, projection);
}
/**
* Projects each item from a source Iterable to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def nums = 1..10
* def squaresAndCubesOfEvens = nums.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216, 64, 512, 100, 1000]
*
* def animals = ['CAT', 'DOG', 'ELEPHANT'] as Set
* def smallAnimals = animals.collectMany{ it.size() {@code >} 3 ? [] : [it.toLowerCase()] }
* assert smallAnimals == ['cat', 'dog']
*
* def orig = nums as Set
* def origPlusIncrements = orig.collectMany{ [it, it+1] }
* assert origPlusIncrements.size() == orig.size() * 2
* assert origPlusIncrements.unique().size() == orig.size() + 1
* </pre>
*
* @param self an Iterable
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(java.util.Collection, groovy.lang.Closure)
* @since 2.2.0
*/
public static <T,E> List<T> collectMany(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return (List<T>) collectMany(self, new ArrayList<>(), projection);
}
/**
* Projects each item from a source collection to a result collection and concatenates (flattens) the resulting
* collections adding them into the <code>collector</code>.
* <p>
* <pre class="groovyTestCase">
* def animals = ['CAT', 'DOG', 'ELEPHANT'] as Set
* def smallAnimals = animals.collectMany(['ant', 'bee']){ it.size() {@code >} 3 ? [] : [it.toLowerCase()] }
* assert smallAnimals == ['ant', 'bee', 'cat', 'dog']
*
* def nums = 1..5
* def origPlusIncrements = nums.collectMany([] as Set){ [it, it+1] }
* assert origPlusIncrements.size() == nums.size() + 1
* </pre>
*
* @param self an Iterable
* @param collector an initial collection to add the projected items to
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) into it
* @since 2.2.0
*/
public static <T,E> Collection<T> collectMany(Iterable<E> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
for (E next : self) {
collector.addAll(projection.call(next));
}
return collector;
}
/**
* Projects each item from a source map to a result collection and concatenates (flattens) the resulting
* collections adding them into the <code>collector</code>.
* <p>
* <pre class="groovyTestCase">
* def map = [bread:3, milk:5, butter:2]
* def result = map.collectMany(['x']){ k, v {@code ->} k.startsWith('b') ? k.toList() : [] }
* assert result == ['x', 'b', 'r', 'e', 'a', 'd', 'b', 'u', 't', 't', 'e', 'r']
* </pre>
*
* @param self a map
* @param collector an initial collection to add the projected items to
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) to it
* @since 1.8.8
*/
public static <T,K,V> Collection<T> collectMany(Map<K, V> self, Collection<T> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends Collection<? extends T>> projection) {
for (Map.Entry<K, V> entry : self.entrySet()) {
collector.addAll(callClosureForMapEntry(projection, entry));
}
return collector;
}
/**
* Projects each item from a source map to a result collection and concatenates (flattens) the resulting
* collections adding them into a collection.
* <p>
* <pre class="groovyTestCase">
* def map = [bread:3, milk:5, butter:2]
* def result = map.collectMany{ k, v {@code ->} k.startsWith('b') ? k.toList() : [] }
* assert result == ['b', 'r', 'e', 'a', 'd', 'b', 'u', 't', 't', 'e', 'r']
* </pre>
*
* @param self a map
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) to it
* @since 1.8.8
*/
public static <T,K,V> Collection<T> collectMany(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany(self, new ArrayList<>(), projection);
}
/**
* Projects each item from a source array to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def nums = [1, 2, 3, 4, 5, 6] as Object[]
* def squaresAndCubesOfEvens = nums.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216]
* </pre>
*
* @param self an array
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(Object[], groovy.lang.Closure)
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T,E> List<T> collectMany(E[] self, @ClosureParams(FirstParam.Component.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable<E>)toList(self), projection);
}
/**
* Projects each item from a source iterator to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def numsIter = [1, 2, 3, 4, 5, 6].iterator()
* def squaresAndCubesOfEvens = numsIter.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216]
* </pre>
*
* @param self an iterator
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(Iterator, groovy.lang.Closure)
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T,E> List<T> collectMany(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)toList(self), projection);
}
/**
* Iterates through this Map transforming each map entry into a new value using the <code>transform</code> closure
* returning the <code>collector</code> with all transformed values added to it.
* <pre class="groovyTestCase">assert [a:1, b:2].collect( [] as HashSet ) { key, value {@code ->} key*value } == ["a", "bb"] as Set
* assert [3:20, 2:30].collect( [] as HashSet ) { entry {@code ->} entry.key * entry.value } == [60] as Set</pre>
*
* @param self a Map
* @param collector the Collection to which transformed values are added
* @param transform the transformation closure which can take one (Map.Entry) or two (key, value) parameters
* @return the collector with all transformed values added to it
* @since 1.0
*/
public static <T,K,V> Collection<T> collect(Map<K, V> self, Collection<T> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends T> transform) {
for (Map.Entry<K, V> entry : self.entrySet()) {
collector.add(callClosureForMapEntry(transform, entry));
}
return collector;
}
/**
* Iterates through this Map transforming each map entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
* <pre class="groovyTestCase">assert [a:1, b:2].collect { key, value {@code ->} key*value } == ["a", "bb"]
* assert [3:20, 2:30].collect { entry {@code ->} entry.key * entry.value } == [60, 60]</pre>
*
* @param self a Map
* @param transform the transformation closure which can take one (Map.Entry) or two (key, value) parameters
* @return the resultant list of transformed values
* @since 1.0
*/
public static <T,K,V> List<T> collect(Map<K,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<>(self.size()), transform);
}
/**
* Iterates through this Map transforming each map entry using the <code>transform</code> closure
* returning a map of the transformed entries.
* <pre class="groovyTestCase">
* assert [a:1, b:2].collectEntries( [:] ) { k, v {@code ->} [v, k] } == [1:'a', 2:'b']
* assert [a:1, b:2].collectEntries( [30:'C'] ) { key, value {@code ->}
* [(value*10): key.toUpperCase()] } == [10:'A', 20:'B', 30:'C']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self a Map
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which can take one (Map.Entry) or two (key, value) parameters and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
public static <K, V, S, T> Map<K, V> collectEntries(Map<S, T> self, Map<K, V> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> transform) {
for (Map.Entry<S, T> entry : self.entrySet()) {
addEntry(collector, callClosureForMapEntry(transform, entry));
}
return collector;
}
/**
* Iterates through this Map transforming each entry using the <code>transform</code> closure
* and returning a map of the transformed entries.
* <pre class="groovyTestCase">
* assert [a:1, b:2].collectEntries { key, value {@code ->} [value, key] } == [1:'a', 2:'b']
* assert [a:1, b:2].collectEntries { key, value {@code ->}
* [(value*10): key.toUpperCase()] } == [10:'A', 20:'B']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self a Map
* @param transform the closure used for transforming, which can take one (Map.Entry) or two (key, value) parameters and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
public static <K,V> Map<?, ?> collectEntries(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> transform) {
return collectEntries(self, createSimilarMap(self), transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Closure)
* @since 1.7.9
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Closure<?> transform) {
return collectEntries((Iterable)self, new LinkedHashMap<K, V>(), transform);
}
/**
* A variant of collectEntries for Iterators.
*
* @param self an Iterator
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterable, Closure)
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self, new LinkedHashMap<>(), transform);
}
/**
* Iterates through this Iterable transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* // collect letters with index using list style
* assert (0..2).collectEntries { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* // collect letters with index using map style
* assert (0..2).collectEntries { index {@code ->} [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
*
* @param self an Iterable
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterator, Closure)
* @since 1.8.7
*/
public static <K,V,E> Map<K, V> collectEntries(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self.iterator(), transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable)
* @since 1.8.5
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self) {
return collectEntries((Iterable)self, new LinkedHashMap<K, V>(), Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterators using the identity closure as the transform.
*
* @param self an Iterator
* @return a Map of the transformed entries
* @see #collectEntries(Iterable)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterator<?> self) {
return collectEntries(self, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterable objects using the identity closure as the transform.
* The source Iterable should contain a list of <code>[key, value]</code> tuples or <code>Map.Entry</code> objects.
* <pre class="groovyTestCase">
* def nums = [1, 10, 100, 1000]
* def tuples = nums.collect{ [it, it.toString().size()] }
* assert tuples == [[1, 1], [10, 2], [100, 3], [1000, 4]]
* def map = tuples.collectEntries()
* assert map == [1:1, 10:2, 100:3, 1000:4]
* </pre>
*
* @param self an Iterable
* @return a Map of the transformed entries
* @see #collectEntries(Iterator)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterable<?> self) {
return collectEntries(self.iterator());
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Map, Closure)
* @since 1.7.9
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Map<K, V> collector, Closure<?> transform) {
return collectEntries((Iterable<?>)self, collector, transform);
}
/**
* A variant of collectEntries for Iterators using a supplied map as the destination of transformed entries.
*
* @param self an Iterator
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterator<E> self, Map<K, V> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
while (self.hasNext()) {
E next = self.next();
addEntry(collector, transform.call(next));
}
return collector;
}
/**
* Iterates through this Iterable transforming each item using the closure
* as a transformer into a map entry, returning the supplied map with all of the transformed entries added to it.
* <pre class="groovyTestCase">
* def letters = "abc"
* // collect letters with index
* assert (0..2).collectEntries( [:] ) { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* assert (0..2).collectEntries( [4:'d'] ) { index {@code ->}
* [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self an Iterable
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterator, Map, Closure)
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterable<E> self, Map<K, V> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self.iterator(), collector, transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Map)
* @since 1.8.5
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Map<K, V> collector) {
return collectEntries((Iterable<?>)self, collector, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterators using the identity closure as the
* transform and a supplied map as the destination of transformed entries.
*
* @param self an Iterator
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterable, Map)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterator<?> self, Map<K, V> collector) {
return collectEntries(self, collector, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterables using the identity closure as the
* transform and a supplied map as the destination of transformed entries.
*
* @param self an Iterable
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterator, Map)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterable<?> self, Map<K, V> collector) {
return collectEntries(self.iterator(), collector);
}
/**
* Iterates through this array transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* def nums = [0, 1, 2] as Integer[]
* // collect letters with index
* assert nums.collectEntries( [:] ) { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* assert nums.collectEntries( [4:'d'] ) { index {@code ->}
* [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self an array
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
@SuppressWarnings("unchecked")
public static <K, V, E> Map<K, V> collectEntries(E[] self, Map<K, V> collector, @ClosureParams(FirstParam.Component.class) Closure<?> transform) {
return collectEntries((Iterable)toList(self), collector, transform);
}
/**
* A variant of collectEntries using the identity closure as the transform.
*
* @param self an array
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Object[], Map, Closure)
* @since 1.8.5
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self, Map<K, V> collector) {
return collectEntries(self, collector, Closure.IDENTITY);
}
/**
* Iterates through this array transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* def nums = [0, 1, 2] as Integer[]
* // collect letters with index using list style
* assert nums.collectEntries { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* // collect letters with index using map style
* assert nums.collectEntries { index {@code ->} [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
*
* @param self a Collection
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterable, Map, Closure)
* @since 1.7.9
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self, @ClosureParams(FirstParam.Component.class) Closure<?> transform) {
return collectEntries((Iterable)toList(self), new LinkedHashMap<K, V>(), transform);
}
/**
* A variant of collectEntries using the identity closure as the transform.
*
* @param self an array
* @return the collector with all transformed values added to it
* @see #collectEntries(Object[], Closure)
* @since 1.8.5
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self) {
return collectEntries(self, Closure.IDENTITY);
}
private static <K, V> void addEntry(Map<K, V> result, Object newEntry) {
if (newEntry instanceof Map) {
leftShift(result, (Map)newEntry);
} else if (newEntry instanceof List) {
List list = (List) newEntry;
// def (key, value) == list
Object key = list.isEmpty() ? null : list.get(0);
Object value = list.size() <= 1 ? null : list.get(1);
leftShift(result, new MapEntry(key, value));
} else if (newEntry.getClass().isArray()) {
Object[] array = (Object[]) newEntry;
// def (key, value) == array.toList()
Object key = array.length == 0 ? null : array[0];
Object value = array.length <= 1 ? null : array[1];
leftShift(result, new MapEntry(key, value));
} else {
// TODO: enforce stricter behavior?
// given Map.Entry is an interface, we get a proxy which gives us lots
// of flexibility but sometimes the error messages might be unexpected
leftShift(result, asType(newEntry, Map.Entry.class));
}
}
/**
* Finds the first value matching the closure condition.
*
* <pre class="groovyTestCase">
* def numbers = [1, 2, 3]
* def result = numbers.find { it {@code >} 1}
* assert result == 2
* </pre>
*
* @param self an Object with an iterator returning its values
* @param closure a closure condition
* @return the first Object found or null if none was found
* @since 1.0
*/
public static Object find(Object self, Closure closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
Object value = iter.next();
if (bcw.call(value)) {
return value;
}
}
return null;
}
/**
* Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [null, 0, 0.0, false, '', [], 42, 43]
* assert items.find() == 42
* </pre>
*
* @param self an Object with an Iterator returning its values
* @return the first Object found or null if none was found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Object find(Object self) {
return find(self, Closure.IDENTITY);
}
/**
* Finds the first value matching the closure condition. Example:
* <pre class="groovyTestCase">def list = [1,2,3]
* assert 2 == list.find { it {@code >} 1 }
* </pre>
*
* @param self a Collection
* @param closure a closure condition
* @return the first Object found, in the order of the collections iterator, or null if no element matches
* @since 1.0
*/
public static <T> T find(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (T value : self) {
if (bcw.call(value)) {
return value;
}
}
return null;
}
/**
* Finds the first element in the array that matches the given closure condition.
* Example:
* <pre class="groovyTestCase">
* def list = [1,2,3] as Integer[]
* assert 2 == list.find { it {@code >} 1 }
* assert null == list.find { it {@code >} 5 }
* </pre>
*
* @param self an Array
* @param condition a closure condition
* @return the first element from the array that matches the condition or null if no element matches
* @since 2.0
*/
public static <T> T find(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T element : self) {
if (bcw.call(element)) {
return element;
}
}
return null;
}
/**
* Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [null, 0, 0.0, false, '', [], 42, 43]
* assert items.find() == 42
* </pre>
*
* @param self a Collection
* @return the first Object found or null if none was found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static <T> T find(Collection<T> self) {
return find(self, Closure.IDENTITY);
}
/**
* Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns null.
* <p>
* <pre class="groovyTestCase">
* int[] numbers = [1, 2, 3]
* assert numbers.findResult { if(it {@code >} 1) return it } == 2
* assert numbers.findResult { if(it {@code >} 4) return it } == null
* </pre>
*
* @param self an Object with an iterator returning its values
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result of the closure
* @since 1.7.5
*/
public static Object findResult(Object self, Closure condition) {
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
Object value = iter.next();
Object result = condition.call(value);
if (result != null) {
return result;
}
}
return null;
}
/**
* Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns the defaultResult.
* <p>
* <pre class="groovyTestCase">
* int[] numbers = [1, 2, 3]
* assert numbers.findResult(5) { if(it {@code >} 1) return it } == 2
* assert numbers.findResult(5) { if(it {@code >} 4) return it } == 5
* </pre>
*
* @param self an Object with an iterator returning its values
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result of the closure, otherwise the default value
* @since 1.7.5
*/
public static Object findResult(Object self, Object defaultResult, Closure condition) {
Object result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the collection calling the given closure for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
*
* @param self a Collection
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 1.7.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <S, T, U extends T, V extends T> T findResult(Collection<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
return findResult((Iterable<S>) self, defaultResult, condition);
}
/**
* Iterates through the collection calling the given closure for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self a Collection
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 1.7.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <S,T> T findResult(Collection<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
return findResult((Iterable<S>) self, condition);
}
/**
* Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
* <p>
* Examples:
* <pre class="groovyTestCase">
* def iter = [1,2,3].iterator()
* assert "Found 2" == iter.findResult("default") { it {@code >} 1 ? "Found $it" : null }
* assert "default" == iter.findResult("default") { it {@code >} 3 ? "Found $it" : null }
* </pre>
*
* @param self an Iterator
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(Iterator<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Iterator
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <T, U> T findResult(Iterator<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
while (self.hasNext()) {
U next = self.next();
T result = condition.call(next);
if (result != null) {
return result;
}
}
return null;
}
/**
* Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
* <p>
* Examples:
* <pre class="groovyTestCase">
* def list = [1,2,3]
* assert "Found 2" == list.findResult("default") { it {@code >} 1 ? "Found $it" : null }
* assert "default" == list.findResult("default") { it {@code >} 3 ? "Found $it" : null }
* </pre>
*
* @param self an Iterable
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(Iterable<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Iterable
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <T, U> T findResult(Iterable<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
return findResult(self.iterator(), condition);
}
/**
* Iterates through the Array calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
*
* @param self an Array
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(S[] self, U defaultResult, @ClosureParams(FirstParam.Component.class) Closure<V> condition) {
return findResult(new ArrayIterator<>(self), defaultResult, condition);
}
/**
* Iterates through the Array calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Array
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <S, T> T findResult(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> condition) {
return findResult(new ArrayIterator<>(self), condition);
}
/**
* Returns the first non-null closure result found by passing each map entry to the closure, otherwise null is returned.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">
* assert "Found b:3" == [a:1, b:3].findResult { if (it.value == 3) return "Found ${it.key}:${it.value}" }
* assert null == [a:1, b:3].findResult { if (it.value == 9) return "Found ${it.key}:${it.value}" }
* assert "Found a:1" == [a:1, b:3].findResult { k, v {@code ->} if (k.size() + v == 2) return "Found $k:$v" }
* </pre>
*
* @param self a Map
* @param condition a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
* @return the first non-null result collected by calling the closure, or null if no such result was found
* @since 1.7.5
*/
public static <T, K, V> T findResult(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> condition) {
for (Map.Entry<K, V> entry : self.entrySet()) {
T result = callClosureForMapEntry(condition, entry);
if (result != null) {
return result;
}
}
return null;
}
/**
* Returns the first non-null closure result found by passing each map entry to the closure, otherwise the defaultResult is returned.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">
* assert "Found b:3" == [a:1, b:3].findResult("default") { if (it.value == 3) return "Found ${it.key}:${it.value}" }
* assert "default" == [a:1, b:3].findResult("default") { if (it.value == 9) return "Found ${it.key}:${it.value}" }
* assert "Found a:1" == [a:1, b:3].findResult("default") { k, v {@code ->} if (k.size() + v == 2) return "Found $k:$v" }
* </pre>
*
* @param self a Map
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
* @return the first non-null result collected by calling the closure, or the defaultResult if no such result was found
* @since 1.7.5
*/
public static <T, U extends T, V extends T, A, B> T findResult(Map<A, B> self, U defaultResult, @ClosureParams(MapEntryOrKeyValue.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* @see #findResults(Iterable, Closure)
* @since 1.8.1
* @deprecated Use the Iterable version of findResults instead
*/
@Deprecated
public static <T, U> Collection<T> findResults(Collection<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
return findResults((Iterable<?>) self, filteringTransform);
}
/**
* Iterates through the Iterable transforming items using the supplied closure
* and collecting any non-null results.
* <p>
* Example:
* <pre class="groovyTestCase">
* def list = [1,2,3]
* def result = list.findResults { it {@code >} 1 ? "Found $it" : null }
* assert result == ["Found 2", "Found 3"]
* </pre>
*
* @param self an Iterable
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.2.0
*/
public static <T, U> Collection<T> findResults(Iterable<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
return findResults(self.iterator(), filteringTransform);
}
/**
* Iterates through the Iterator transforming items using the supplied closure
* and collecting any non-null results.
*
* @param self an Iterator
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.5.0
*/
public static <T, U> Collection<T> findResults(Iterator<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
List<T> result = new ArrayList<>();
while (self.hasNext()) {
U value = self.next();
T transformed = filteringTransform.call(value);
if (transformed != null) {
result.add(transformed);
}
}
return result;
}
/**
* Iterates through the Array transforming items using the supplied closure
* and collecting any non-null results.
*
* @param self an Array
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.5.0
*/
public static <T, U> Collection<T> findResults(U[] self, @ClosureParams(FirstParam.Component.class) Closure<T> filteringTransform) {
return findResults(new ArrayIterator<>(self), filteringTransform);
}
/**
* Iterates through the map transforming items using the supplied closure
* and collecting any non-null results.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <p>
* Example:
* <pre class="groovyTestCase">
* def map = [a:1, b:2, hi:2, cat:3, dog:2]
* def result = map.findResults { k, v {@code ->} k.size() == v ? "Found $k:$v" : null }
* assert result == ["Found a:1", "Found hi:2", "Found cat:3"]
* </pre>
*
* @param self a Map
* @param filteringTransform a 1 or 2 arg Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 1.8.1
*/
public static <T, K, V> Collection<T> findResults(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> filteringTransform) {
List<T> result = new ArrayList<>();
for (Map.Entry<K, V> entry : self.entrySet()) {
T transformed = callClosureForMapEntry(filteringTransform, entry);
if (transformed != null) {
result.add(transformed);
}
}
return result;
}
/**
* Finds the first entry matching the closure condition.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">assert [a:1, b:3].find { it.value == 3 }.key == "b"</pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure condition
* @return the first Object found
* @since 1.0
*/
public static <K, V> Map.Entry<K, V> find(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
return entry;
}
}
return null;
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert ([2,4] as Set) == ([1,2,3,4] as Set).findAll { it % 2 == 0 }</pre>
*
* @param self a Set
* @param closure a closure condition
* @return a Set of matching values
* @since 2.4.0
*/
public static <T> Set<T> findAll(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Set<T>) findAll((Collection<T>) self, closure);
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }</pre>
*
* @param self a List
* @param closure a closure condition
* @return a List of matching values
* @since 2.4.0
*/
public static <T> List<T> findAll(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<T>) findAll((Collection<T>) self, closure);
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }</pre>
*
* @param self a Collection
* @param closure a closure condition
* @return a Collection of matching values
* @since 1.5.6
*/
public static <T> Collection<T> findAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Collection<T> answer = createSimilarCollection(self);
Iterator<T> iter = self.iterator();
return findAll(closure, answer, iter);
}
/**
* Finds all elements of the array matching the given Closure condition.
* <pre class="groovyTestCase">
* def items = [1,2,3,4] as Integer[]
* assert [2,4] == items.findAll { it % 2 == 0 }
* </pre>
*
* @param self an array
* @param condition a closure condition
* @return a list of matching values
* @since 2.0
*/
public static <T> Collection<T> findAll(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
Collection<T> answer = new ArrayList<>();
return findAll(condition, answer, new ArrayIterator<>(self));
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Set
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]] as Set
* </pre>
*
* @param self a Set
* @return a Set of the values found
* @since 2.4.0
* @see Closure#IDENTITY
*/
public static <T> Set<T> findAll(Set<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a List
* @return a List of the values found
* @since 2.4.0
* @see Closure#IDENTITY
*/
public static <T> List<T> findAll(List<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a Collection
* @return a Collection of the values found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static <T> Collection<T> findAll(Collection<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the elements of the array matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Object[]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an array
* @return a collection of the elements found
* @see Closure#IDENTITY
* @since 2.0
*/
public static <T> Collection<T> findAll(T[] self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds all items matching the closure condition.
*
* @param self an Object with an Iterator returning its values
* @param closure a closure condition
* @return a List of the values found
* @since 1.6.0
*/
public static Collection findAll(Object self, Closure closure) {
List answer = new ArrayList();
Iterator iter = InvokerHelper.asIterator(self);
return findAll(closure, answer, iter);
}
/**
* Finds all items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an Object with an Iterator returning its values
* @return a List of the values found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Collection findAll(Object self) {
return findAll(self, Closure.IDENTITY);
}
private static <T> Collection<T> findAll(Closure closure, Collection<T> answer, Iterator<? extends T> iter) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (iter.hasNext()) {
T value = iter.next();
if (bcw.call(value)) {
answer.add(value);
}
}
return answer;
}
/**
* Returns <tt>true</tt> if this iterable contains the item.
*
* @param self an Iterable to be checked for containment
* @param item an Object to be checked for containment in this iterable
* @return <tt>true</tt> if this iterable contains the item
* @see Collection#contains(Object)
* @since 2.4.0
*/
public static boolean contains(Iterable self, Object item) {
for (Object e : self) {
if (Objects.equals(item, e)) {
return true;
}
}
return false;
}
/**
* Returns <tt>true</tt> if this iterable contains all of the elements
* in the specified array.
*
* @param self an Iterable to be checked for containment
* @param items array to be checked for containment in this iterable
* @return <tt>true</tt> if this collection contains all of the elements
* in the specified array
* @see Collection#containsAll(Collection)
* @since 2.4.0
*/
public static boolean containsAll(Iterable self, Object[] items) {
return asCollection(self).containsAll(Arrays.asList(items));
}
/**
* @deprecated use the Iterable variant instead
* @see #containsAll(Iterable, Object[])
* @since 1.7.2
*/
@Deprecated
public static boolean containsAll(Collection self, Object[] items) {
return self.containsAll(Arrays.asList(items));
}
/**
* Modifies this collection by removing its elements that are contained
* within the specified object array.
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which don't match some criteria while leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be removed from this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#removeAll(Collection)
* @since 1.7.2
*/
public static boolean removeAll(Collection self, Object[] items) {
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(Arrays.asList(items));
return self.removeAll(pickFrom);
}
/**
* Modifies this collection so that it retains only its elements that are contained
* in the specified array. In other words, removes from this collection all of
* its elements that are not contained in the specified array.
*
* See also <code>grep</code> and <code>findAll</code> when wanting to produce a new list
* containing items which match some specified items but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be retained from this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#retainAll(Collection)
* @since 1.7.2
*/
public static boolean retainAll(Collection self, Object[] items) {
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(Arrays.asList(items));
return self.retainAll(pickFrom);
}
/**
* Modifies this collection so that it retains only its elements
* that are matched according to the specified closure condition. In other words,
* removes from this collection all of its elements that don't match.
*
* <pre class="groovyTestCase">def list = ['a', 'b']
* list.retainAll { it == 'b' }
* assert list == ['b']</pre>
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which match some criteria but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param condition a closure condition
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Iterator#remove()
* @since 1.7.2
*/
public static <T> boolean retainAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Iterator iter = InvokerHelper.asIterator(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Object value = iter.next();
if (!bcw.call(value)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this map so that it retains only its elements that are matched
* according to the specified closure condition. In other words, removes from
* this map all of its elements that don't match. If the closure takes one
* parameter then it will be passed the <code>Map.Entry</code>. Otherwise the closure should
* take two parameters, which will be the key and the value.
*
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map.retainAll { k,v {@code ->} k == 'b' }
* assert map == [b:2]</pre>
*
* See also <code>findAll</code> when wanting to produce a new map containing items
* which match some criteria but leaving the original map unchanged.
*
* @param self a Map to be modified
* @param condition a 1 or 2 arg Closure condition applying on the entries
* @return <tt>true</tt> if this map changed as a result of the call
* @since 2.5.0
*/
public static <K, V> boolean retainAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
Iterator<Map.Entry<K, V>> iter = self.entrySet().iterator();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Map.Entry<K, V> entry = iter.next();
if (!bcw.callForMap(entry)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this collection by removing the elements that are matched according
* to the specified closure condition.
*
* <pre class="groovyTestCase">def list = ['a', 'b']
* list.removeAll { it == 'b' }
* assert list == ['a']</pre>
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which match some criteria but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param condition a closure condition
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Iterator#remove()
* @since 1.7.2
*/
public static <T> boolean removeAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Iterator iter = InvokerHelper.asIterator(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Object value = iter.next();
if (bcw.call(value)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this map by removing the elements that are matched according to the
* specified closure condition. If the closure takes one parameter then it will be
* passed the <code>Map.Entry</code>. Otherwise the closure should take two parameters, which
* will be the key and the value.
*
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map.removeAll { k,v {@code ->} k == 'b' }
* assert map == [a:1]</pre>
*
* See also <code>findAll</code> when wanting to produce a new map containing items
* which match some criteria but leaving the original map unchanged.
*
* @param self a Map to be modified
* @param condition a 1 or 2 arg Closure condition applying on the entries
* @return <tt>true</tt> if this map changed as a result of the call
* @since 2.5.0
*/
public static <K, V> boolean removeAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
Iterator<Map.Entry<K, V>> iter = self.entrySet().iterator();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Map.Entry<K, V> entry = iter.next();
if (bcw.callForMap(entry)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies the collection by adding all of the elements in the specified array to the collection.
* The behavior of this operation is undefined if
* the specified array is modified while the operation is in progress.
*
* See also <code>plus</code> or the '+' operator if wanting to produce a new collection
* containing additional items but while leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be added to this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#addAll(Collection)
* @since 1.7.2
*/
public static <T> boolean addAll(Collection<T> self, T[] items) {
return self.addAll(Arrays.asList(items));
}
/**
* Modifies this list by inserting all of the elements in the specified array into the
* list at the specified position. Shifts the
* element currently at that position (if any) and any subsequent
* elements to the right (increases their indices). The new elements
* will appear in this list in the order that they occur in the array.
* The behavior of this operation is undefined if the specified array
* is modified while the operation is in progress.
*
* See also <code>plus</code> for similar functionality with copy semantics, i.e. which produces a new
* list after adding the additional items at the specified position but leaves the original list unchanged.
*
* @param self a list to be modified
* @param items array containing elements to be added to this collection
* @param index index at which to insert the first element from the
* specified array
* @return <tt>true</tt> if this collection changed as a result of the call
* @see List#addAll(int, Collection)
* @since 1.7.2
*/
public static <T> boolean addAll(List<T> self, int index, T[] items) {
return self.addAll(index, Arrays.asList(items));
}
/**
* Splits all items into two lists based on the closure condition.
* The first list contains all items matching the closure expression.
* The second list all those that don't.
*
* @param self an Object with an Iterator returning its values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 1.6.0
*/
public static Collection split(Object self, Closure closure) {
List accept = new ArrayList();
List reject = new ArrayList();
return split(closure, accept, reject, InvokerHelper.asIterator(self));
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }</pre>
*
* @param self a Collection of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 1.6.0
*/
public static <T> Collection<Collection<T>> split(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Collection<T> accept = createSimilarCollection(self);
Collection<T> reject = createSimilarCollection(self);
Iterator<T> iter = self.iterator();
return split(closure, accept, reject, iter);
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
*
* @param self an Array
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.5.0
*/
public static <T> Collection<Collection<T>> split(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
List<T> accept = new ArrayList<>();
List<T> reject = new ArrayList<>();
Iterator<T> iter = new ArrayIterator<>(self);
return split(closure, accept, reject, iter);
}
private static <T> Collection<Collection<T>> split(Closure closure, Collection<T> accept, Collection<T> reject, Iterator<T> iter) {
List<Collection<T>> answer = new ArrayList<>();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (iter.hasNext()) {
T value = iter.next();
if (bcw.call(value)) {
accept.add(value);
} else {
reject.add(value);
}
}
answer.add(accept);
answer.add(reject);
return answer;
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }</pre>
*
* @param self a List of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.4.0
*/
@SuppressWarnings("unchecked")
public static <T> List<List<T>> split(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<List<T>>) (List<?>) split((Collection<T>) self, closure);
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4] as Set, [1,3] as Set] == ([1,2,3,4] as Set).split { it % 2 == 0 }</pre>
*
* @param self a Set of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.4.0
*/
@SuppressWarnings("unchecked")
public static <T> List<Set<T>> split(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<Set<T>>) (List<?>) split((Collection<T>) self, closure);
}
/**
* @deprecated Use the Iterable version of combinations instead
* @see #combinations(Iterable)
* @since 1.5.0
*/
@Deprecated
public static List combinations(Collection self) {
return combinations((Iterable)self);
}
/**
* Adds GroovyCollections#combinations(Iterable) as a method on Iterables.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [['a', 'b'],[1, 2, 3]].combinations() == [['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]
* </pre>
*
* @param self an Iterable of collections
* @return a List of the combinations found
* @see groovy.util.GroovyCollections#combinations(java.lang.Iterable)
* @since 2.2.0
*/
public static List combinations(Iterable self) {
return GroovyCollections.combinations(self);
}
/**
* Adds GroovyCollections#combinations(Iterable, Closure) as a method on collections.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2, 3],[4, 5, 6]].combinations {x,y {@code ->} x*y } == [8, 12, 10, 15, 12, 18]</pre>
*
* @param self a Collection of lists
* @param function a closure to be called on each combination
* @return a List of the results of applying the closure to each combinations found
* @see groovy.util.GroovyCollections#combinations(Iterable)
* @since 2.2.0
*/
public static List combinations(Iterable self, Closure<?> function) {
return collect((Iterable)GroovyCollections.combinations(self), function);
}
/**
* Applies a function on each combination of the input lists.
* <p>
* Example usage:
* <pre class="groovyTestCase">[[2, 3],[4, 5, 6]].eachCombination { println "Found $it" }</pre>
*
* @param self a Collection of lists
* @param function a closure to be called on each combination
* @see groovy.util.GroovyCollections#combinations(Iterable)
* @since 2.2.0
*/
public static void eachCombination(Iterable self, Closure<?> function) {
each(GroovyCollections.combinations(self), function);
}
/**
* Finds all non-null subsequences of a list.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [1, 2, 3].subsequences()
* assert result == [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] as Set</pre>
*
* @param self the List of items
* @return the subsequences from the list
* @since 1.7.0
*/
public static <T> Set<List<T>> subsequences(List<T> self) {
return GroovyCollections.subsequences(self);
}
/**
* Finds all permutations of an iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [1, 2, 3].permutations()
* assert result == [[3, 2, 1], [3, 1, 2], [1, 3, 2], [2, 3, 1], [2, 1, 3], [1, 2, 3]] as Set</pre>
*
* @param self the Iterable of items
* @return the permutations from the list
* @since 1.7.0
*/
public static <T> Set<List<T>> permutations(Iterable<T> self) {
Set<List<T>> ans = new HashSet<>();
PermutationGenerator<T> generator = new PermutationGenerator<>(self);
while (generator.hasNext()) {
ans.add(generator.next());
}
return ans;
}
/**
* @deprecated Use the Iterable version of permutations instead
* @see #permutations(Iterable)
* @since 1.7.0
*/
@Deprecated
public static <T> Set<List<T>> permutations(List<T> self) {
return permutations((Iterable<T>) self);
}
/**
* Finds all permutations of an iterable, applies a function to each permutation and collects the result
* into a list.
* <p>
* Example usage:
* <pre class="groovyTestCase">Set result = [1, 2, 3].permutations { it.collect { v {@code ->} 2*v }}
* assert result == [[6, 4, 2], [6, 2, 4], [2, 6, 4], [4, 6, 2], [4, 2, 6], [2, 4, 6]] as Set</pre>
*
* @param self the Iterable of items
* @param function the function to apply on each permutation
* @return the list of results of the application of the function on each permutation
* @since 2.2.0
*/
public static <T,V> List<V> permutations(Iterable<T> self, Closure<V> function) {
return collect((Iterable<List<T>>) permutations(self),function);
}
/**
* @deprecated Use the Iterable version of permutations instead
* @see #permutations(Iterable, Closure)
* @since 2.2.0
*/
@Deprecated
public static <T, V> List<V> permutations(List<T> self, Closure<V> function) {
return permutations((Iterable<T>) self, function);
}
/**
* @deprecated Use the Iterable version of eachPermutation instead
* @see #eachPermutation(Iterable, Closure)
* @since 1.7.0
*/
@Deprecated
public static <T> Iterator<List<T>> eachPermutation(Collection<T> self, Closure closure) {
return eachPermutation((Iterable<T>) self, closure);
}
/**
* Iterates over all permutations of a collection, running a closure for each iteration.
* <p>
* Example usage:
* <pre class="groovyTestCase">def permutations = []
* [1, 2, 3].eachPermutation{ permutations << it }
* assert permutations == [[1, 2, 3], [1, 3, 2], [2, 1, 3], [2, 3, 1], [3, 1, 2], [3, 2, 1]]</pre>
*
* @param self the Collection of items
* @param closure the closure to call for each permutation
* @return the permutations from the list
* @since 1.7.0
*/
public static <T> Iterator<List<T>> eachPermutation(Iterable<T> self, Closure closure) {
Iterator<List<T>> generator = new PermutationGenerator<>(self);
while (generator.hasNext()) {
closure.call(generator.next());
}
return generator;
}
/**
* Adds GroovyCollections#transpose(List) as a method on lists.
* A Transpose Function takes a collection of columns and returns a collection of
* rows. The first row consists of the first element from each column. Successive
* rows are constructed similarly.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [['a', 'b'], [1, 2]].transpose()
* assert result == [['a', 1], ['b', 2]]</pre>
* <pre class="groovyTestCase">def result = [['a', 'b'], [1, 2], [3, 4]].transpose()
* assert result == [['a', 1, 3], ['b', 2, 4]]</pre>
*
* @param self a List of lists
* @return a List of the transposed lists
* @see groovy.util.GroovyCollections#transpose(java.util.List)
* @since 1.5.0
*/
public static List transpose(List self) {
return GroovyCollections.transpose(self);
}
/**
* Finds all entries matching the closure condition. If the
* closure takes one parameter then it will be passed the Map.Entry.
* Otherwise if the closure should take two parameters, which will be
* the key and the value.
* <p>
* If the <code>self</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [a:1, b:2, c:4, d:5].findAll { it.value % 2 == 0 }
* assert result.every { it instanceof Map.Entry }
* assert result*.key == ["b", "c"]
* assert result*.value == [2, 4]
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure condition applying on the entries
* @return a new subMap
* @since 1.0
*/
public static <K, V> Map<K, V> findAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
Map<K, V> answer = createSimilarMap(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
answer.put(entry.getKey(), entry.getValue());
}
}
return answer;
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <K, T> Map<K, List<T>> groupBy(Collection<T> self, Closure<K> closure) {
return groupBy((Iterable<T>)self, closure);
}
/**
* Sorts all Iterable members into groups determined by the supplied mapping closure.
* The closure should return the key that this item should be grouped by. The returned
* LinkedHashMap will have an entry for each distinct key returned from the closure,
* with each value being a list of items for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [0:[2,4,6], 1:[1,3,5]] == [1,2,3,4,5,6].groupBy { it % 2 }
* </pre>
*
* @param self a collection to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @since 2.2.0
*/
public static <K, T> Map<K, List<T>> groupBy(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
Map<K, List<T>> answer = new LinkedHashMap<>();
for (T element : self) {
K value = closure.call(element);
groupAnswer(answer, element, value);
}
return answer;
}
/**
* Sorts all array members into groups determined by the supplied mapping closure.
* The closure should return the key that this item should be grouped by. The returned
* LinkedHashMap will have an entry for each distinct key returned from the closure,
* with each value being a list of items for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* Integer[] items = [1,2,3,4,5,6]
* assert [0:[2,4,6], 1:[1,3,5]] == items.groupBy { it % 2 }
* </pre>
*
* @param self an array to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @see #groupBy(Iterable, Closure)
* @since 2.2.0
*/
public static <K, T> Map<K, List<T>> groupBy(T[] self, @ClosureParams(FirstParam.Component.class) Closure<K> closure) {
return groupBy((Iterable<T>)Arrays.asList(self), closure);
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, Object...)
* @since 1.8.1
*/
@Deprecated
public static Map groupBy(Collection self, Object... closures) {
return groupBy((Iterable)self, closures);
}
/**
* Sorts all Iterable members into (sub)groups determined by the supplied
* mapping closures. Each closure should return the key that this item
* should be grouped by. The returned LinkedHashMap will have an entry for each
* distinct 'key path' returned from the closures, with each value being a list
* of items for that 'group path'.
*
* Example usage:
* <pre class="groovyTestCase">def result = [1,2,3,4,5,6].groupBy({ it % 2 }, { it {@code <} 4 })
* assert result == [1:[(true):[1, 3], (false):[5]], 0:[(true):[2], (false):[4, 6]]]</pre>
*
* Another example:
* <pre>def sql = groovy.sql.Sql.newInstance(/* ... */)
* def data = sql.rows("SELECT * FROM a_table").groupBy({ it.column1 }, { it.column2 }, { it.column3 })
* if (data.val1.val2.val3) {
* // there exists a record where:
* // a_table.column1 == val1
* // a_table.column2 == val2, and
* // a_table.column3 == val3
* } else {
* // there is no such record
* }</pre>
* If an empty array of closures is supplied the IDENTITY Closure will be used.
*
* @param self a collection to group
* @param closures an array of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @since 2.2.0
* @see Closure#IDENTITY
*/
public static Map groupBy(Iterable self, Object... closures) {
final Closure head = closures.length == 0 ? Closure.IDENTITY : (Closure) closures[0];
@SuppressWarnings("unchecked")
Map<Object, List> first = groupBy(self, head);
if (closures.length < 2)
return first;
final Object[] tail = new Object[closures.length - 1];
System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
// inject([:]) { a,e {@code ->} a {@code <<} [(e.key): e.value.groupBy(tail)] }
Map<Object, Map> acc = new LinkedHashMap<>();
for (Map.Entry<Object, List> item : first.entrySet()) {
acc.put(item.getKey(), groupBy((Iterable)item.getValue(), tail));
}
return acc;
}
/**
* Sorts all array members into (sub)groups determined by the supplied
* mapping closures as per the Iterable variant of this method.
*
* @param self an array to group
* @param closures an array of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @see #groupBy(Iterable, Object...)
* @see Closure#IDENTITY
* @since 2.2.0
*/
public static Map groupBy(Object[] self, Object... closures) {
return groupBy((Iterable)Arrays.asList(self), closures);
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, List)
* @since 1.8.1
*/
@Deprecated
public static Map groupBy(Collection self, List<Closure> closures) {
return groupBy((Iterable)self, closures);
}
/**
* Sorts all Iterable members into (sub)groups determined by the supplied
* mapping closures. Each closure should return the key that this item
* should be grouped by. The returned LinkedHashMap will have an entry for each
* distinct 'key path' returned from the closures, with each value being a list
* of items for that 'group path'.
*
* Example usage:
* <pre class="groovyTestCase">
* def result = [1,2,3,4,5,6].groupBy([{ it % 2 }, { it {@code <} 4 }])
* assert result == [1:[(true):[1, 3], (false):[5]], 0:[(true):[2], (false):[4, 6]]]
* </pre>
*
* Another example:
* <pre>
* def sql = groovy.sql.Sql.newInstance(/* ... */)
* def data = sql.rows("SELECT * FROM a_table").groupBy([{ it.column1 }, { it.column2 }, { it.column3 }])
* if (data.val1.val2.val3) {
* // there exists a record where:
* // a_table.column1 == val1
* // a_table.column2 == val2, and
* // a_table.column3 == val3
* } else {
* // there is no such record
* }
* </pre>
* If an empty list of closures is supplied the IDENTITY Closure will be used.
*
* @param self a collection to group
* @param closures a list of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @since 2.2.0
* @see Closure#IDENTITY
*/
public static Map groupBy(Iterable self, List<Closure> closures) {
return groupBy(self, closures.toArray());
}
/**
* Sorts all array members into (sub)groups determined by the supplied
* mapping closures as per the list variant of this method.
*
* @param self an array to group
* @param closures a list of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @see Closure#IDENTITY
* @see #groupBy(Iterable, List)
* @since 2.2.0
*/
public static Map groupBy(Object[] self, List<Closure> closures) {
return groupBy((Iterable)Arrays.asList(self), closures);
}
/**
* @deprecated Use the Iterable version of countBy instead
* @see #countBy(Iterable, Closure)
* @since 1.8.0
*/
@Deprecated
public static <K> Map<K, Integer> countBy(Collection self, Closure<K> closure) {
return countBy((Iterable) self, closure);
}
/**
* Sorts all collection members into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [0:2, 1:3] == [1,2,3,4,5].countBy { it % 2 }</pre>
*
* @param self a collection to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @since 2.2.0
*/
public static <K,E> Map<K, Integer> countBy(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
return countBy(self.iterator(), closure);
}
/**
* Sorts all array members into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert ([1,2,2,2,3] as Object[]).countBy{ it % 2 } == [1:2, 0:3]</pre>
*
* @param self an array to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @see #countBy(Collection, Closure)
* @since 1.8.0
*/
public static <K,E> Map<K, Integer> countBy(E[] self, @ClosureParams(FirstParam.Component.class) Closure<K> closure) {
return countBy((Iterable)Arrays.asList(self), closure);
}
/**
* Sorts all iterator items into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [1,2,2,2,3].toSet().iterator().countBy{ it % 2 } == [1:2, 0:1]</pre>
*
* @param self an iterator to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @see #countBy(Collection, Closure)
* @since 1.8.0
*/
public static <K,E> Map<K, Integer> countBy(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
Map<K, Integer> answer = new LinkedHashMap<>();
while (self.hasNext()) {
K value = closure.call(self.next());
countAnswer(answer, value);
}
return answer;
}
/**
* Groups all map entries into groups determined by the
* supplied mapping closure. The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the list of map entries that belong to each
* group. (If instead of a list of map entries, you want an actual map
* use {code}groupBy{code}.)
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupEntriesBy { it.value % 2 }
* assert result[0]*.key == ["b", "d", "f"]
* assert result[1]*.value == [1, 3, 5]</pre>
*
* @param self a map to group
* @param closure a 1 or 2 arg Closure mapping entries on keys
* @return a new Map grouped by keys
* @since 1.5.2
*/
public static <G, K, V> Map<G, List<Map.Entry<K, V>>> groupEntriesBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
final Map<G, List<Map.Entry<K, V>>> answer = new LinkedHashMap<>();
for (Map.Entry<K, V> entry : self.entrySet()) {
G value = callClosureForMapEntry(closure, entry);
groupAnswer(answer, entry, value);
}
return answer;
}
/**
* Groups the members of a map into sub maps determined by the
* supplied mapping closure. The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the map members from the original map that
* belong to each group. (If instead of a map, you want a list of map entries
* use {code}groupEntriesBy{code}.)
* <p>
* If the <code>self</code> map is one of TreeMap, Hashtable or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy { it.value % 2 }
* assert result == [0:[b:2, d:4, f:6], 1:[a:1, c:3, e:5]]</pre>
*
* @param self a map to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @since 1.0
*/
public static <G, K, V> Map<G, Map<K, V>> groupBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
final Map<G, List<Map.Entry<K, V>>> initial = groupEntriesBy(self, closure);
final Map<G, Map<K, V>> answer = new LinkedHashMap<>();
for (Map.Entry<G, List<Map.Entry<K, V>>> outer : initial.entrySet()) {
G key = outer.getKey();
List<Map.Entry<K, V>> entries = outer.getValue();
Map<K, V> target = createSimilarMap(self);
putAll(target, entries);
answer.put(key, target);
}
return answer;
}
/**
* Groups the members of a map into sub maps determined by the supplied
* mapping closures. Each closure will be passed a Map.Entry or key and
* value (depending on the number of parameters the closure accepts) and
* should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group path' returned by all
* closures, with values being the map members from the original map that
* belong to each such 'group path'.
*
* If the <code>self</code> map is one of TreeMap, Hashtable, or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
*
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy({ it.value % 2 }, { it.key.next() })
* assert result == [1:[b:[a:1], d:[c:3], f:[e:5]], 0:[c:[b:2], e:[d:4], g:[f:6]]]</pre>
* If an empty array of closures is supplied the IDENTITY Closure will be used.
*
* @param self a map to group
* @param closures an array of closures that map entries on keys
* @return a new map grouped by keys on each criterion
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Map<Object, Map> groupBy(Map self, Object... closures) {
@SuppressWarnings("unchecked")
final Closure<Object> head = closures.length == 0 ? Closure.IDENTITY : (Closure) closures[0];
@SuppressWarnings("unchecked")
Map<Object, Map> first = groupBy(self, head);
if (closures.length < 2)
return first;
final Object[] tail = new Object[closures.length - 1];
System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
Map<Object, Map> acc = new LinkedHashMap<>();
for (Map.Entry<Object, Map> item: first.entrySet()) {
acc.put(item.getKey(), groupBy(item.getValue(), tail));
}
return acc;
}
/**
* Groups the members of a map into sub maps determined by the supplied
* mapping closures. Each closure will be passed a Map.Entry or key and
* value (depending on the number of parameters the closure accepts) and
* should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group path' returned by all
* closures, with values being the map members from the original map that
* belong to each such 'group path'.
*
* If the <code>self</code> map is one of TreeMap, Hashtable, or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
*
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy([{ it.value % 2 }, { it.key.next() }])
* assert result == [1:[b:[a:1], d:[c:3], f:[e:5]], 0:[c:[b:2], e:[d:4], g:[f:6]]]</pre>
* If an empty list of closures is supplied the IDENTITY Closure will be used.
*
* @param self a map to group
* @param closures a list of closures that map entries on keys
* @return a new map grouped by keys on each criterion
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Map<Object, Map> groupBy(Map self, List<Closure> closures) {
return groupBy(self, closures.toArray());
}
/**
* Groups the members of a map into groups determined by the
* supplied mapping closure and counts the frequency of the created groups.
* The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the frequency counts for that 'group'.
* <p>
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5].countBy { it.value % 2 }
* assert result == [0:2, 1:3]</pre>
*
* @param self a map to group and count
* @param closure a closure mapping entries to frequency count keys
* @return a new Map grouped by keys with frequency counts
* @since 1.8.0
*/
public static <K,U,V> Map<K, Integer> countBy(Map<U,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<K> closure) {
Map<K, Integer> answer = new LinkedHashMap<>();
for (Map.Entry<U,V> entry : self.entrySet()) {
countAnswer(answer, callClosureForMapEntry(closure, entry));
}
return answer;
}
/**
* Groups the current element according to the value
*
* @param answer the map containing the results
* @param element the element to be placed
* @param value the value according to which the element will be placed
* @since 1.5.0
*/
protected static <K, T> void groupAnswer(final Map<K, List<T>> answer, T element, K value) {
List<T> groupedElements = answer.computeIfAbsent(value, k -> new ArrayList<>());
groupedElements.add(element);
}
private static <T> void countAnswer(final Map<T, Integer> answer, T mappedKey) {
Integer current = answer.get(mappedKey);
if (null == current) {
current = 0;
}
answer.put(mappedKey, current + 1);
}
// internal helper method
protected static <T, K, V> T callClosureForMapEntry(@ClosureParams(value=FromString.class, options={"K,V","Map.Entry<K,V>"}) Closure<T> closure, Map.Entry<K,V> entry) {
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(entry.getKey(), entry.getValue());
}
return closure.call(entry);
}
// internal helper method
protected static <T> T callClosureForLine(@ClosureParams(value=FromString.class, options={"String","String,Integer"}) Closure<T> closure, String line, int counter) {
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(line, counter);
}
return closure.call(line);
}
// internal helper method
protected static <T, K, V> T callClosureForMapEntryAndCounter(@ClosureParams(value=FromString.class, options={"K,V,Integer", "K,V","Map.Entry<K,V>"}) Closure<T> closure, Map.Entry<K,V> entry, int counter) {
if (closure.getMaximumNumberOfParameters() == 3) {
return closure.call(entry.getKey(), entry.getValue(), counter);
}
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(entry, counter);
}
return closure.call(entry);
}
/**
* Performs the same function as the version of inject that takes an initial value, but
* uses the head of the Collection as the initial value, and iterates over the tail.
* <pre class="groovyTestCase">
* assert 1 * 2 * 3 * 4 == [ 1, 2, 3, 4 ].inject { acc, val {@code ->} acc * val }
* assert ['b'] == [['a','b'], ['b','c'], ['d','b']].inject { acc, val {@code ->} acc.intersect( val ) }
* LinkedHashSet set = [ 't', 'i', 'm' ]
* assert 'tim' == set.inject { a, b {@code ->} a + b }
* </pre>
*
* @param self a Collection
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the collection is empty.
* @see #inject(Collection, Object, Closure)
* @since 1.8.7
*/
public static <T, V extends T> T inject(Collection<T> self, @ClosureParams(value=FromString.class,options="V,T") Closure<V> closure ) {
if( self.isEmpty() ) {
throw new NoSuchElementException( "Cannot call inject() on an empty collection without passing an initial value." ) ;
}
Iterator<T> iter = self.iterator();
T head = iter.next();
Collection<T> tail = tail(self);
if (!tail.iterator().hasNext()) {
return head;
}
// cast with explicit weaker generics for now to keep jdk6 happy, TODO: find better fix
return (T) inject((Collection) tail, head, closure);
}
/**
* Iterates through the given Collection, passing in the initial value to
* the 2-arg closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the entire collection
* has been used. Also known as <tt>foldLeft</tt> or <tt>reduce</tt> in functional parlance.
*
* Examples:
* <pre class="groovyTestCase">
* assert 1*1*2*3*4 == [1,2,3,4].inject(1) { acc, val {@code ->} acc * val }
*
* assert 0+1+2+3+4 == [1,2,3,4].inject(0) { acc, val {@code ->} acc + val }
*
* assert 'The quick brown fox' ==
* ['quick', 'brown', 'fox'].inject('The') { acc, val {@code ->} acc + ' ' + val }
*
* assert 'bat' ==
* ['rat', 'bat', 'cat'].inject('zzz') { min, next {@code ->} next {@code <} min ? next : min }
*
* def max = { a, b {@code ->} [a, b].max() }
* def animals = ['bat', 'rat', 'cat']
* assert 'rat' == animals.inject('aaa', max)
* </pre>
* Visual representation of the last example above:
* <pre>
* initVal animals[0]
* v v
* max('aaa', 'bat') {@code =>} 'bat' animals[1]
* v v
* max('bat', 'rat') {@code =>} 'rat' animals[2]
* v v
* max('rat', 'cat') {@code =>} 'rat'
* </pre>
*
* @param self a Collection
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @since 1.0
*/
public static <E, T, U extends T, V extends T> T inject(Collection<E> self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
// cast with explicit weaker generics for now to keep jdk6 happy, TODO: find better fix
return (T) inject((Iterator) self.iterator(), initialValue, closure);
}
/**
* Iterates through the given Map, passing in the initial value to
* the 2-arg Closure along with the first item (or 3-arg Closure along with the first key and value).
* The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the entire collection
* has been used. Also known as <tt>foldLeft</tt> or <tt>reduce</tt> in functional parlance.
*
* Examples:
* <pre class="groovyTestCase">
* def map = [a:1, b:2, c:3]
* assert map.inject([]) { list, k, v {@code ->}
* list + [k] * v
* } == ['a', 'b', 'b', 'c', 'c', 'c']
* </pre>
*
* @param self a Map
* @param initialValue some initial value
* @param closure a 2 or 3 arg Closure
* @return the result of the last closure call
* @since 1.8.1
*/
public static <K, V, T, U extends T, W extends T> T inject(Map<K, V> self, U initialValue, @ClosureParams(value=FromString.class,options={"U,Map.Entry<K,V>","U,K,V"}) Closure<W> closure) {
T value = initialValue;
for (Map.Entry<K, V> entry : self.entrySet()) {
if (closure.getMaximumNumberOfParameters() == 3) {
value = closure.call(value, entry.getKey(), entry.getValue());
} else {
value = closure.call(value, entry);
}
}
return value;
}
/**
* Iterates through the given Iterator, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the Iterator has been
* expired of values. Also known as foldLeft in functional parlance.
*
* @param self an Iterator
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <E,T, U extends T, V extends T> T inject(Iterator<E> self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
T value = initialValue;
Object[] params = new Object[2];
while (self.hasNext()) {
Object item = self.next();
params[0] = value;
params[1] = item;
value = closure.call(params);
}
return value;
}
/**
* Iterates through the given Object, passing in the first value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until further iteration of
* the object is not possible. Also known as foldLeft in functional parlance.
*
* @param self an Object
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the collection is empty.
* @see #inject(Collection, Object, Closure)
* @since 1.8.7
*/
public static <T, V extends T> T inject(Object self, Closure<V> closure) {
Iterator iter = InvokerHelper.asIterator(self);
if( !iter.hasNext() ) {
throw new NoSuchElementException( "Cannot call inject() over an empty iterable without passing an initial value." ) ;
}
Object initialValue = iter.next() ;
return (T) inject(iter, initialValue, closure);
}
/**
* Iterates through the given Object, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until further iteration of
* the object is not possible. Also known as foldLeft in functional parlance.
*
* @param self an Object
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <T, U extends T, V extends T> T inject(Object self, U initialValue, Closure<V> closure) {
Iterator iter = InvokerHelper.asIterator(self);
return (T) inject(iter, initialValue, closure);
}
/**
* Iterates through the given array as with inject(Object[],initialValue,closure), but
* using the first element of the array as the initialValue, and then iterating
* the remaining elements of the array.
*
* @param self an Object[]
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the array is empty.
* @see #inject(Object[], Object, Closure)
* @since 1.8.7
*/
public static <E,T, V extends T> T inject(E[] self, @ClosureParams(value=FromString.class,options="E,E") Closure<V> closure) {
return inject( (Object)self, closure ) ;
}
/**
* Iterates through the given array, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until all elements of the array
* have been used. Also known as foldLeft in functional parlance.
*
* @param self an Object[]
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <E, T, U extends T, V extends T> T inject(E[] self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
Object[] params = new Object[2];
T value = initialValue;
for (Object next : self) {
params[0] = value;
params[1] = next;
value = closure.call(params);
}
return value;
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable)
* @since 1.0
*/
@Deprecated
public static Object sum(Collection self) {
return sum((Iterable)self);
}
/**
* Sums the items in an Iterable. This is equivalent to invoking the
* "plus" method on all items in the Iterable.
* <pre class="groovyTestCase">assert 1+2+3+4 == [1,2,3,4].sum()</pre>
*
* @param self Iterable of values to add together
* @return The sum of all of the items
* @since 2.2.0
*/
public static Object sum(Iterable self) {
return sum(self, null, true);
}
/**
* Sums the items in an array. This is equivalent to invoking the
* "plus" method on all items in the array.
*
* @param self The array of values to add together
* @return The sum of all of the items
* @see #sum(java.util.Iterator)
* @since 1.7.1
*/
public static Object sum(Object[] self) {
return sum(toList(self), null, true);
}
/**
* Sums the items from an Iterator. This is equivalent to invoking the
* "plus" method on all items from the Iterator. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self an Iterator for the values to add together
* @return The sum of all of the items
* @since 1.5.5
*/
public static Object sum(Iterator<Object> self) {
return sum(toList(self), null, true);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static byte sum(byte[] self) {
return sum(self, (byte) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as short) == ([1,2,3,4] as short[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static short sum(short[] self) {
return sum(self, (short) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert 1+2+3+4 == ([1,2,3,4] as int[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static int sum(int[] self) {
return sum(self, 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as long) == ([1,2,3,4] as long[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static long sum(long[] self) {
return sum(self, 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as char) == ([1,2,3,4] as char[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static char sum(char[] self) {
return sum(self, (char) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as float) == ([1,2,3,4] as float[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static float sum(float[] self) {
return sum(self, (float) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as double) == ([1,2,3,4] as double[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static double sum(double[] self) {
return sum(self, 0);
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Object)
* @since 1.5.0
*/
@Deprecated
public static Object sum(Collection self, Object initialValue) {
return sum(self, initialValue, false);
}
/**
* Sums the items in an Iterable, adding the result to some initial value.
* <pre class="groovyTestCase">
* assert 5+1+2+3+4 == [1,2,3,4].sum(5)
* </pre>
*
* @param self an Iterable of values to sum
* @param initialValue the items in the collection will be summed to this initial value
* @return The sum of all of the items.
* @since 2.2.0
*/
public static Object sum(Iterable self, Object initialValue) {
return sum(self, initialValue, false);
}
/**
* Sums the items in an array, adding the result to some initial value.
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 1.7.1
*/
public static Object sum(Object[] self, Object initialValue) {
return sum(toList(self), initialValue, false);
}
/**
* Sums the items from an Iterator, adding the result to some initial value. This is
* equivalent to invoking the "plus" method on all items from the Iterator. The iterator
* will become exhausted of elements after determining the sum value.
*
* @param self an Iterator for the values to add together
* @param initialValue the items in the collection will be summed to this initial value
* @return The sum of all of the items
* @since 1.5.5
*/
public static Object sum(Iterator<Object> self, Object initialValue) {
return sum(toList(self), initialValue, false);
}
private static Object sum(Iterable self, Object initialValue, boolean first) {
Object result = initialValue;
Object[] param = new Object[1];
for (Object next : self) {
param[0] = next;
if (first) {
result = param[0];
first = false;
continue;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", param);
}
return result;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum(5 as byte)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static byte sum(byte[] self, byte initialValue) {
byte s = initialValue;
for (byte v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as short) == ([1,2,3,4] as short[]).sum(5 as short)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static short sum(short[] self, short initialValue) {
short s = initialValue;
for (short v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert 5+1+2+3+4 == ([1,2,3,4] as int[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static int sum(int[] self, int initialValue) {
int s = initialValue;
for (int v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as long) == ([1,2,3,4] as long[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static long sum(long[] self, long initialValue) {
long s = initialValue;
for (long v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as char) == ([1,2,3,4] as char[]).sum(5 as char)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static char sum(char[] self, char initialValue) {
char s = initialValue;
for (char v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as float) == ([1,2,3,4] as float[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static float sum(float[] self, float initialValue) {
float s = initialValue;
for (float v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as double) == ([1,2,3,4] as double[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static double sum(double[] self, double initialValue) {
double s = initialValue;
for (double v : self) {
s += v;
}
return s;
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static Object sum(Collection self, Closure closure) {
return sum((Iterable)self, closure);
}
/**
* Sums the result of applying a closure to each item of an Iterable.
* <code>coll.sum(closure)</code> is equivalent to:
* <code>coll.collect(closure).sum()</code>.
* <pre class="groovyTestCase">assert 4+6+10+12 == [2,3,5,6].sum { it * 2 }</pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item of the Iterable.
* @since 2.2.0
*/
public static <T> Object sum(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self.iterator(), null, closure, true);
}
/**
* Sums the result of applying a closure to each item of an array.
* <code>array.sum(closure)</code> is equivalent to:
* <code>array.collect(closure).sum()</code>.
*
* @param self An array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item of the array.
* @since 1.7.1
*/
public static <T> Object sum(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return sum(new ArrayIterator<>(self), null, closure, true);
}
/**
* Sums the result of applying a closure to each item returned from an iterator.
* <code>iter.sum(closure)</code> is equivalent to:
* <code>iter.collect(closure).sum()</code>. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self An Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item from the Iterator.
* @since 1.7.1
*/
public static <T> Object sum(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self, null, closure, true);
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Object, Closure)
* @since 1.5.0
*/
@Deprecated
public static Object sum(Collection self, Object initialValue, Closure closure) {
return sum((Iterable)self, initialValue, closure);
}
/**
* Sums the result of applying a closure to each item of an Iterable to some initial value.
* <code>iter.sum(initVal, closure)</code> is equivalent to:
* <code>iter.collect(closure).sum(initVal)</code>.
* <pre class="groovyTestCase">assert 50+4+6+10+12 == [2,3,5,6].sum(50) { it * 2 }</pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item of the collection.
* @since 1.5.0
*/
public static <T> Object sum(Iterable<T> self, Object initialValue, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self.iterator(), initialValue, closure, false);
}
/**
* Sums the result of applying a closure to each item of an array to some initial value.
* <code>array.sum(initVal, closure)</code> is equivalent to:
* <code>array.collect(closure).sum(initVal)</code>.
*
* @param self an array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item of the array.
* @since 1.7.1
*/
public static <T> Object sum(T[] self, Object initialValue, @ClosureParams(FirstParam.Component.class) Closure closure) {
return sum(new ArrayIterator<>(self), initialValue, closure, false);
}
/**
* Sums the result of applying a closure to each item of an Iterator to some initial value.
* <code>iter.sum(initVal, closure)</code> is equivalent to:
* <code>iter.collect(closure).sum(initVal)</code>. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self an Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item from the Iterator.
* @since 1.7.1
*/
public static <T> Object sum(Iterator<T> self, Object initialValue, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self, initialValue, closure, false);
}
private static <T> Object sum(Iterator<T> self, Object initialValue, Closure closure, boolean first) {
Object result = initialValue;
Object[] closureParam = new Object[1];
Object[] plusParam = new Object[1];
while (self.hasNext()) {
closureParam[0] = self.next();
plusParam[0] = closure.call(closureParam);
if (first) {
result = plusParam[0];
first = false;
continue;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", plusParam);
}
return result;
}
/**
* Averages the items in an Iterable. This is equivalent to invoking the
* "plus" method on all items in the Iterable and then dividing by the
* total count using the "div" method for the resulting sum.
* <pre class="groovyTestCase">assert 3 == [1, 2, 6].average()</pre>
*
* @param self Iterable of values to average
* @return The average of all of the items
* @since 3.0.0
*/
public static Object average(Iterable self) {
Object result = null;
long count = 0;
Object[] param = new Object[1];
for (Object next : self) {
param[0] = next;
if (count == 0) {
result = param[0];
} else {
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", param);
}
count++;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", count);
return result;
}
/**
* Averages the items in an array. This is equivalent to invoking the
* "plus" method on all items in the array and then dividing by the
* total count using the "div" method for the resulting sum.
* <pre class="groovyTestCase">assert 3 == ([1, 2, 6] as Integer[]).average()</pre>
*
* @param self The array of values to average
* @return The average of all of the items
* @see #sum(java.lang.Object[])
* @since 3.0.0
*/
public static Object average(Object[] self) {
Object result = sum(self);
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", self.length);
return result;
}
/**
* Averages the items from an Iterator. This is equivalent to invoking the
* "plus" method on all items in the array and then dividing by the
* total count using the "div" method for the resulting sum.
* The iterator will become exhausted of elements after determining the average value.
*
* @param self an Iterator for the values to average
* @return The average of all of the items
* @since 3.0.0
*/
public static Object average(Iterator<Object> self) {
return average(toList(self));
}
/**
* Calculates the average of the bytes in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as byte[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(byte[] self) {
long s = 0;
int count = 0;
for (byte v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the shorts in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as short[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(short[] self) {
long s = 0;
int count = 0;
for (short v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the ints in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as int[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(int[] self) {
long s = 0;
int count = 0;
for (int v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the longs in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as long[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(long[] self) {
long s = 0;
int count = 0;
for (long v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the floats in the array.
* <pre class="groovyTestCase">assert 5.0d == ([2,4,6,8] as float[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static double average(float[] self) {
double s = 0.0d;
int count = 0;
for (float v : self) {
s += v;
count++;
}
return s/count;
}
/**
* Calculates the average of the doubles in the array.
* <pre class="groovyTestCase">assert 5.0d == ([2,4,6,8] as double[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static double average(double[] self) {
double s = 0.0d;
int count = 0;
for (double v : self) {
s += v;
count++;
}
return s/count;
}
/**
* Averages the result of applying a closure to each item of an Iterable.
* <code>iter.average(closure)</code> is equivalent to:
* <code>iter.collect(closure).average()</code>.
* <pre class="groovyTestCase">
* assert 20 == [1, 3].average { it * 10 }
* assert 3 == ['to', 'from'].average { it.size() }
* </pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item of the Iterable.
* @since 3.0.0
*/
public static <T> Object average(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return average(self.iterator(), closure);
}
/**
* Averages the result of applying a closure to each item of an array.
* <code>array.average(closure)</code> is equivalent to:
* <code>array.collect(closure).average()</code>.
* <pre class="groovyTestCase">
* def (nums, strings) = [[1, 3] as Integer[], ['to', 'from'] as String[]]
* assert 20 == nums.average { it * 10 }
* assert 3 == strings.average { it.size() }
* assert 3 == strings.average (String::size)
* </pre>
*
* @param self An array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item of the array.
* @since 3.0.0
*/
public static <T> Object average(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return average(new ArrayIterator<>(self), closure);
}
/**
* Averages the result of applying a closure to each item returned from an iterator.
* <code>iter.average(closure)</code> is equivalent to:
* <code>iter.collect(closure).average()</code>.
* The iterator will become exhausted of elements after determining the average value.
*
* @param self An Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item from the Iterator.
* @since 3.0.0
*/
public static <T> Object average(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Object result = null;
long count = 0;
Object[] closureParam = new Object[1];
Object[] plusParam = new Object[1];
while (self.hasNext()) {
closureParam[0] = self.next();
plusParam[0] = closure.call(closureParam);
if (count == 0) {
result = plusParam[0];
} else {
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", plusParam);
}
count++;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", count);
return result;
}
/**
* Concatenates the <code>toString()</code> representation of each
* item from the iterator, with the given String as a separator between
* each item. The iterator will become exhausted of elements after
* determining the resulting conjoined value.
*
* @param self an Iterator of items
* @param separator a String separator
* @return the joined String
* @since 1.5.5
*/
public static String join(Iterator<Object> self, String separator) {
return join((Iterable)toList(self), separator);
}
/**
* @deprecated Use the Iterable version of join instead
* @see #join(Iterable, String)
* @since 1.0
*/
@Deprecated
public static String join(Collection self, String separator) {
return join((Iterable)self, separator);
}
/**
* Concatenates the <code>toString()</code> representation of each
* item in this Iterable, with the given String as a separator between each item.
* <pre class="groovyTestCase">assert "1, 2, 3" == [1,2,3].join(", ")</pre>
*
* @param self an Iterable of objects
* @param separator a String separator
* @return the joined String
* @since 1.0
*/
public static String join(Iterable self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (Object value : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(InvokerHelper.toString(value));
}
return buffer.toString();
}
/**
* Concatenates the <code>toString()</code> representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of Object
* @param separator a String separator
* @return the joined String
* @since 1.0
*/
public static String join(Object[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (Object next : self) {
String value = InvokerHelper.toString(next);
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(value);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of boolean
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(boolean[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (boolean next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of byte
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(byte[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (byte next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of char
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(char[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (char next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of double
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(double[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (double next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of float
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(float[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (float next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of int
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(int[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (int next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of long
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(long[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (long next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of short
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(short[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (short next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self) {
return GroovyCollections.min(self);
}
/**
* Adds min() method to Collection objects.
* <pre class="groovyTestCase">assert 2 == [4,2,5].min()</pre>
*
* @param self a Collection
* @return the minimum value
* @see groovy.util.GroovyCollections#min(java.util.Collection)
* @since 1.0
*/
public static <T> T min(Iterable<T> self) {
return GroovyCollections.min(self);
}
/**
* Adds min() method to Iterator objects. The iterator will become
* exhausted of elements after determining the minimum value.
*
* @param self an Iterator
* @return the minimum value
* @see #min(java.util.Collection)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self) {
return min((Iterable<T>)toList(self));
}
/**
* Adds min() method to Object arrays.
*
* @param self an array
* @return the minimum value
* @see #min(java.util.Collection)
* @since 1.5.5
*/
public static <T> T min(T[] self) {
return min((Iterable<T>)toList(self));
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self, Comparator<T> comparator) {
return min((Iterable<T>) self, comparator);
}
/**
* Selects the minimum value found in the Iterable using the given comparator.
* <pre class="groovyTestCase">assert "hi" == ["hello","hi","hey"].min( { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )</pre>
*
* @param self an Iterable
* @param comparator a Comparator
* @return the minimum value or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T min(Iterable<T> self, Comparator<T> comparator) {
T answer = null;
boolean first = true;
for (T value : self) {
if (first) {
first = false;
answer = value;
} else if (comparator.compare(value, answer) < 0) {
answer = value;
}
}
return answer;
}
/**
* Selects the minimum value found from the Iterator using the given comparator.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the minimum value
* @see #min(java.util.Collection, java.util.Comparator)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self, Comparator<T> comparator) {
return min((Iterable<T>)toList(self), comparator);
}
/**
* Selects the minimum value found from the Object array using the given comparator.
*
* @param self an array
* @param comparator a Comparator
* @return the minimum value
* @see #min(java.util.Collection, java.util.Comparator)
* @since 1.5.5
*/
public static <T> T min(T[] self, Comparator<T> comparator) {
return min((Iterable<T>)toList(self), comparator);
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self, Closure closure) {
return min((Iterable<T>)self, closure);
}
/**
* Selects the item in the iterable which when passed as a parameter to the supplied closure returns the
* minimum value. A null return value represents the least possible return value. If more than one item
* has the minimum value, an arbitrary choice is made between the items having the minimum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">
* assert "hi" == ["hello","hi","hey"].min { it.length() }
* </pre>
* <pre class="groovyTestCase">
* def lastDigit = { a, b {@code ->} a % 10 {@code <=>} b % 10 }
* assert [19, 55, 91].min(lastDigit) == 91
* </pre>
* <pre class="groovyTestCase">
* def pets = ['dog', 'cat', 'anaconda']
* def shortestName = pets.min{ it.size() } // one of 'dog' or 'cat'
* assert shortestName.size() == 3
* </pre>
*
* @param self an Iterable
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return an item from the Iterable having the minimum value returned by calling the supplied closure with that item as parameter or null for an empty Iterable
* @since 1.0
*/
public static <T> T min(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
int params = closure.getMaximumNumberOfParameters();
if (params != 1) {
return min(self, new ClosureComparator<>(closure));
}
boolean first = true;
T answer = null;
Object answerValue = null;
for (T item : self) {
Object value = closure.call(item);
if (first) {
first = false;
answer = item;
answerValue = value;
} else if (ScriptBytecodeAdapter.compareLessThan(value, answerValue)) {
answer = item;
answerValue = value;
}
}
return answer;
}
/**
* Selects an entry in the map having the minimum
* calculated value as determined by the supplied closure.
* If more than one entry has the minimum value,
* an arbitrary choice is made between the entries having the minimum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def leastCommonEntry = zoo.min{ it.value }
* assert leastCommonEntry.value == 5
* def mostCommonEntry = zoo.min{ a, b {@code ->} b.value {@code <=>} a.value } // double negative!
* assert mostCommonEntry.value == 7
* </pre>
* Edge case for multiple min values:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def lastCharOfName = { e {@code ->} e.key[-1] }
* def ans = zoo.min(lastCharOfName) // some random entry
* assert lastCharOfName(ans) == 's'
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return the Map.Entry having the minimum value as determined by the closure
* @since 1.7.6
*/
public static <K, V> Map.Entry<K, V> min(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>", "Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
return min((Iterable<Map.Entry<K, V>>)self.entrySet(), closure);
}
/**
* Selects an entry in the map having the maximum
* calculated value as determined by the supplied closure.
* If more than one entry has the maximum value,
* an arbitrary choice is made between the entries having the maximum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison. An example:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def mostCommonEntry = zoo.max{ it.value }
* assert mostCommonEntry.value == 7
* def leastCommonEntry = zoo.max{ a, b {@code ->} b.value {@code <=>} a.value } // double negative!
* assert leastCommonEntry.value == 5
* </pre>
* Edge case for multiple max values:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def lengthOfNamePlusNumber = { e {@code ->} e.key.size() + e.value }
* def ans = zoo.max(lengthOfNamePlusNumber) // one of [monkeys:6, tigers:7]
* assert lengthOfNamePlusNumber(ans) == 13
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return the Map.Entry having the maximum value as determined by the closure
* @since 1.7.6
*/
public static <K, V> Map.Entry<K, V> max(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>", "Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
return max((Iterable<Map.Entry<K, V>>)self.entrySet(), closure);
}
/**
* Selects the minimum value found from the Iterator
* using the closure to determine the correct ordering.
* The iterator will become
* exhausted of elements after this operation.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an Iterator
* @param closure a Closure used to determine the correct ordering
* @return the minimum value
* @see #min(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return min((Iterable<T>)toList(self), closure);
}
/**
* Selects the minimum value found from the Object array
* using the closure to determine the correct ordering.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an array
* @param closure a Closure used to determine the correct ordering
* @return the minimum value
* @see #min(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T min(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return min((Iterable<T>)toList(self), closure);
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self) {
return GroovyCollections.max((Iterable<T>)self);
}
/**
* Adds max() method to Iterable objects.
* <pre class="groovyTestCase">
* assert 5 == [2,3,1,5,4].max()
* </pre>
*
* @param self an Iterable
* @return the maximum value
* @see groovy.util.GroovyCollections#max(java.lang.Iterable)
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self) {
return GroovyCollections.max(self);
}
/**
* Adds max() method to Iterator objects. The iterator will become
* exhausted of elements after determining the maximum value.
*
* @param self an Iterator
* @return the maximum value
* @see groovy.util.GroovyCollections#max(java.util.Collection)
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self) {
return max((Iterable<T>)toList(self));
}
/**
* Adds max() method to Object arrays.
*
* @param self an array
* @return the maximum value
* @see #max(java.util.Collection)
* @since 1.5.5
*/
public static <T> T max(T[] self) {
return max((Iterable<T>)toList(self));
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self, Closure closure) {
return max((Iterable<T>) self, closure);
}
/**
* Selects the item in the iterable which when passed as a parameter to the supplied closure returns the
* maximum value. A null return value represents the least possible return value, so any item for which
* the supplied closure returns null, won't be selected (unless all items return null). If more than one item
* has the maximum value, an arbitrary choice is made between the items having the maximum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert "hello" == ["hello","hi","hey"].max { it.length() }</pre>
* <pre class="groovyTestCase">assert "hello" == ["hello","hi","hey"].max { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
* <pre class="groovyTestCase">
* def pets = ['dog', 'elephant', 'anaconda']
* def longestName = pets.max{ it.size() } // one of 'elephant' or 'anaconda'
* assert longestName.size() == 8
* </pre>
*
* @param self an Iterable
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return an item from the Iterable having the maximum value returned by calling the supplied closure with that item as parameter or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
int params = closure.getMaximumNumberOfParameters();
if (params != 1) {
return max(self, new ClosureComparator<>(closure));
}
boolean first = true;
T answer = null;
Object answerValue = null;
for (T item : self) {
Object value = closure.call(item);
if (first) {
first = false;
answer = item;
answerValue = value;
} else if (ScriptBytecodeAdapter.compareLessThan(answerValue, value)) {
answer = item;
answerValue = value;
}
}
return answer;
}
/**
* Selects the maximum value found from the Iterator
* using the closure to determine the correct ordering.
* The iterator will become exhausted of elements after this operation.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an Iterator
* @param closure a Closure used to determine the correct ordering
* @return the maximum value
* @see #max(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return max((Iterable<T>)toList(self), closure);
}
/**
* Selects the maximum value found from the Object array
* using the closure to determine the correct ordering.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an array
* @param closure a Closure used to determine the correct ordering
* @return the maximum value
* @see #max(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T max(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return max((Iterable<T>)toList(self), closure);
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self, Comparator<T> comparator) {
return max((Iterable<T>)self, comparator);
}
/**
* Selects the maximum value found in the Iterable using the given comparator.
* <pre class="groovyTestCase">
* assert "hello" == ["hello","hi","hey"].max( { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )
* </pre>
*
* @param self an Iterable
* @param comparator a Comparator
* @return the maximum value or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self, Comparator<T> comparator) {
T answer = null;
boolean first = true;
for (T value : self) {
if (first) {
first = false;
answer = value;
} else if (comparator.compare(value, answer) > 0) {
answer = value;
}
}
return answer;
}
/**
* Selects the maximum value found from the Iterator using the given comparator.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the maximum value
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self, Comparator<T> comparator) {
return max((Iterable<T>)toList(self), comparator);
}
/**
* Selects the maximum value found from the Object array using the given comparator.
*
* @param self an array
* @param comparator a Comparator
* @return the maximum value
* @since 1.5.5
*/
public static <T> T max(T[] self, Comparator<T> comparator) {
return max((Iterable<T>)toList(self), comparator);
}
/**
* Returns indices of the collection.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert 0..2 == [5, 6, 7].indices
* </pre>
*
* @param self a collection
* @return an index range
* @since 2.4.0
*/
public static IntRange getIndices(Collection self) {
return new IntRange(false, 0, self.size());
}
/**
* Returns indices of the array.
* <p>
* Example:
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c', 'd']
* {@code assert 0..<4 == letters.indices}
* </pre>
*
* @param self an array
* @return an index range
* @since 2.4.0
*/
public static <T> IntRange getIndices(T[] self) {
return new IntRange(false, 0, self.length);
}
/**
* Provide the standard Groovy <code>size()</code> method for <code>Iterator</code>.
* The iterator will become exhausted of elements after determining the size value.
*
* @param self an Iterator
* @return the length of the Iterator
* @since 1.5.5
*/
public static int size(Iterator self) {
int count = 0;
while (self.hasNext()) {
self.next();
count++;
}
return count;
}
/**
* Provide the standard Groovy <code>size()</code> method for <code>Iterable</code>.
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def iterable = { [ hasNext:{ !items.isEmpty() }, next:{ items.pop() } ] as Iterator } as Iterable
* assert iterable.size() == 3
* </pre>
*
* @param self an Iterable
* @return the length of the Iterable
* @since 2.3.8
*/
public static int size(Iterable self) {
return size(self.iterator());
}
/**
* Provide the standard Groovy <code>size()</code> method for an array.
*
* @param self an Array of objects
* @return the size (length) of the Array
* @since 1.0
*/
public static int size(Object[] self) {
return self.length;
}
/**
* Check whether an <code>Iterable</code> has elements
* <pre class="groovyTestCase">
* def items = [1]
* def iterable = { [ hasNext:{ !items.isEmpty() }, next:{ items.pop() } ] as Iterator } as Iterable
* assert !iterable.isEmpty()
* iterable.iterator().next()
* assert iterable.isEmpty()
* </pre>
*
* @param self an Iterable
* @return true if the iterable has no elements, false otherwise
* @since 2.5.0
*/
public static boolean isEmpty(Iterable self) {
return !self.iterator().hasNext();
}
/**
* Support the range subscript operator for a List.
* <pre class="groovyTestCase">def list = [1, "a", 4.5, true]
* assert list[1..2] == ["a", 4.5]</pre>
*
* @param self a List
* @param range a Range indicating the items to get
* @return a new list instance based on range borders
*
* @since 1.0
*/
public static <T> List<T> getAt(List<T> self, Range range) {
RangeInfo info = subListBorders(self.size(), range);
List<T> subList = self.subList(info.from, info.to);
if (info.reverse) {
subList = reverse(subList);
}
// trying to guess the concrete list type and create a new instance from it
List<T> answer = createSimilarList(self, subList.size());
answer.addAll(subList);
return answer;
}
/**
* Select a List of items from an eager or lazy List using a Collection to
* identify the indices to be selected.
* <pre class="groovyTestCase">def list = [].withDefault { 42 }
* assert list[1,0,2] == [42, 42, 42]</pre>
*
* @param self a ListWithDefault
* @param indices a Collection of indices
*
* @return a new eager or lazy list of the values at the given indices
*/
@SuppressWarnings("unchecked")
public static <T> List<T> getAt(ListWithDefault<T> self, Collection indices) {
List<T> answer = ListWithDefault.newInstance(new ArrayList<>(indices.size()), self.isLazyDefaultValues(), self.getInitClosure());
for (Object value : indices) {
if (value instanceof Collection) {
answer.addAll((List<T>) InvokerHelper.invokeMethod(self, "getAt", value));
} else {
int idx = normaliseIndex(DefaultTypeTransformation.intUnbox(value), self.size());
answer.add(self.getAt(idx));
}
}
return answer;
}
/**
* Support the range subscript operator for an eager or lazy List.
* <pre class="groovyTestCase">def list = [].withDefault { 42 }
* assert list[1..2] == [null, 42]</pre>
*
* @param self a ListWithDefault
* @param range a Range indicating the items to get
*
* @return a new eager or lazy list instance based on range borders
*/
public static <T> List<T> getAt(ListWithDefault<T> self, Range range) {
RangeInfo info = subListBorders(self.size(), range);
// if a positive index is accessed not initialized so far
// initialization up to that index takes place
if (self.size() < info.to) {
self.get(info.to - 1);
}
List<T> answer = self.subList(info.from, info.to);
if (info.reverse) {
answer = ListWithDefault.newInstance(reverse(answer), self.isLazyDefaultValues(), self.getInitClosure());
} else {
// instead of using the SubList backed by the parent list, a new ArrayList instance is used
answer = ListWithDefault.newInstance(new ArrayList<>(answer), self.isLazyDefaultValues(), self.getInitClosure());
}
return answer;
}
/**
* Support the range subscript operator for an eager or lazy List.
* <pre class="groovyTestCase">
* def list = [true, 1, 3.4].withDefault{ 42 }
* {@code assert list[0..<0] == []}
* </pre>
*
* @param self a ListWithDefault
* @param range a Range indicating the items to get
*
* @return a new list instance based on range borders
*
*/
public static <T> List<T> getAt(ListWithDefault<T> self, EmptyRange range) {
return ListWithDefault.newInstance(new ArrayList<>(), self.isLazyDefaultValues(), self.getInitClosure());
}
/**
* Support the range subscript operator for a List.
* <pre class="groovyTestCase">
* def list = [true, 1, 3.4]
* {@code assert list[0..<0] == []}
* </pre>
*
* @param self a List
* @param range a Range indicating the items to get
* @return a new list instance based on range borders
*
* @since 1.0
*/
public static <T> List<T> getAt(List<T> self, EmptyRange range) {
return createSimilarList(self, 0);
}
/**
* Select a List of items from a List using a Collection to
* identify the indices to be selected.
* <pre class="groovyTestCase">def list = [true, 1, 3.4, false]
* assert list[1,0,2] == [1, true, 3.4]</pre>
*
* @param self a List
* @param indices a Collection of indices
* @return a new list of the values at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> List<T> getAt(List<T> self, Collection indices) {
List<T> answer = new ArrayList<>(indices.size());
for (Object value : indices) {
if (value instanceof Collection) {
answer.addAll((List<T>)InvokerHelper.invokeMethod(self, "getAt", value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(getAt(self, idx));
}
}
return answer;
}
/**
* Select a List of items from an array using a Collection to
* identify the indices to be selected.
*
* @param self an array
* @param indices a Collection of indices
* @return a new list of the values at the given indices
* @since 1.0
*/
public static <T> List<T> getAt(T[] self, Collection indices) {
List<T> answer = new ArrayList<>(indices.size());
for (Object value : indices) {
if (value instanceof Range) {
answer.addAll(getAt(self, (Range) value));
} else if (value instanceof Collection) {
answer.addAll(getAt(self, (Collection) value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(getAtImpl(self, idx));
}
}
return answer;
}
/**
* Creates a sub-Map containing the given keys. This method is similar to
* List.subList() but uses keys rather than index ranges.
* <pre class="groovyTestCase">assert [1:10, 2:20, 4:40].subMap( [2, 4] ) == [2:20, 4:40]</pre>
*
* @param map a Map
* @param keys a Collection of keys
* @return a new Map containing the given keys
* @since 1.0
*/
public static <K, V> Map<K, V> subMap(Map<K, V> map, Collection<K> keys) {
Map<K, V> answer = new LinkedHashMap<>(keys.size());
for (K key : keys) {
if (map.containsKey(key)) {
answer.put(key, map.get(key));
}
}
return answer;
}
/**
* Creates a sub-Map containing the given keys. This method is similar to
* List.subList() but uses keys rather than index ranges. The original
* map is unaltered.
* <pre class="groovyTestCase">
* def orig = [1:10, 2:20, 3:30, 4:40]
* assert orig.subMap([1, 3] as int[]) == [1:10, 3:30]
* assert orig.subMap([2, 4] as Integer[]) == [2:20, 4:40]
* assert orig.size() == 4
* </pre>
*
* @param map a Map
* @param keys an array of keys
* @return a new Map containing the given keys
* @since 2.1.0
*/
public static <K, V> Map<K, V> subMap(Map<K, V> map, K[] keys) {
Map<K, V> answer = new LinkedHashMap<>(keys.length);
for (K key : keys) {
if (map.containsKey(key)) {
answer.put(key, map.get(key));
}
}
return answer;
}
/**
* Looks up an item in a Map for the given key and returns the value - unless
* there is no entry for the given key in which case add the default value
* to the map and return that.
* <pre class="groovyTestCase">def map=[:]
* map.get("a", []) << 5
* assert map == [a:[5]]</pre>
*
* @param map a Map
* @param key the key to lookup the value of
* @param defaultValue the value to return and add to the map for this key if
* there is no entry for the given key
* @return the value of the given key or the default value, added to the map if the
* key did not exist
* @since 1.0
*/
public static <K, V> V get(Map<K, V> map, K key, V defaultValue) {
if (!map.containsKey(key)) {
map.put(key, defaultValue);
}
return map.get(key);
}
/**
* Support the range subscript operator for an Array
*
* @param array an Array of Objects
* @param range a Range
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, Range range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
/**
*
* @param array an Array of Objects
* @param range an IntRange
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, IntRange range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
/**
*
* @param array an Array of Objects
* @param range an EmptyRange
* @return an empty Range
* @since 1.5.0
*/
public static <T> List<T> getAt(T[] array, EmptyRange range) {
return new ArrayList<>();
}
/**
*
* @param array an Array of Objects
* @param range an ObjectRange
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, ObjectRange range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
private static <T> T getAtImpl(T[] array, int idx) {
return array[normaliseIndex(idx, array.length)];
}
/**
* Allows conversion of arrays into a mutable List.
*
* @param array an Array of Objects
* @return the array as a List
* @since 1.0
*/
public static <T> List<T> toList(T[] array) {
return new ArrayList<>(Arrays.asList(array));
}
/**
* Support the subscript operator for a List.
* <pre class="groovyTestCase">def list = [2, "a", 5.3]
* assert list[1] == "a"</pre>
*
* @param self a List
* @param idx an index
* @return the value at the given index
* @since 1.0
*/
public static <T> T getAt(List<T> self, int idx) {
int size = self.size();
int i = normaliseIndex(idx, size);
if (i < size) {
return self.get(i);
} else {
return null;
}
}
/**
* Support subscript operator for list access.
*/
public static <T> T getAt(List<T> self, Number idx) {
return getAt(self, idx.intValue());
}
/**
* Support the subscript operator for an Iterator. The iterator
* will be partially exhausted up until the idx entry after returning
* if a +ve or 0 idx is used, or fully exhausted if a -ve idx is used
* or no corresponding entry was found. Typical usage:
* <pre class="groovyTestCase">
* def iter = [2, "a", 5.3].iterator()
* assert iter[1] == "a"
* </pre>
* A more elaborate example:
* <pre class="groovyTestCase">
* def items = [2, "a", 5.3]
* def iter = items.iterator()
* assert iter[-1] == 5.3
* // iter exhausted, so reset
* iter = items.iterator()
* assert iter[1] == "a"
* // iter partially exhausted so now idx starts after "a"
* assert iter[0] == 5.3
* </pre>
*
* @param self an Iterator
* @param idx an index value (-self.size() <= idx < self.size())
* @return the value at the given index (after normalisation) or null if no corresponding value was found
* @since 1.7.2
*/
public static <T> T getAt(Iterator<T> self, int idx) {
if (idx < 0) {
// calculate whole list in this case
// recommend avoiding -ve's as this is not as efficient
List<T> list = toList(self);
int adjustedIndex = idx + list.size();
if (adjustedIndex < 0 || adjustedIndex >= list.size()) return null;
return list.get(adjustedIndex);
}
int count = 0;
while (self.hasNext()) {
if (count == idx) {
return self.next();
} else {
count++;
self.next();
}
}
return null;
}
/**
* Support the subscript operator for an Iterable. Typical usage:
* <pre class="groovyTestCase">
* // custom Iterable example:
* class MyIterable implements Iterable {
* Iterator iterator() { [1, 2, 3].iterator() }
* }
* def myIterable = new MyIterable()
* assert myIterable[1] == 2
*
* // Set example:
* def set = [1,2,3] as LinkedHashSet
* assert set[1] == 2
* </pre>
*
* @param self an Iterable
* @param idx an index value (-self.size() <= idx < self.size()) but using -ve index values will be inefficient
* @return the value at the given index (after normalisation) or null if no corresponding value was found
* @since 2.1.0
*/
public static <T> T getAt(Iterable<T> self, int idx) {
return getAt(self.iterator(), idx);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = [2, 3]
* list[0] = 1
* assert list == [1, 3]</pre>
*
* @param self a List
* @param idx an index
* @param value the value to put at the given index
* @since 1.0
*/
public static <T> void putAt(List<T> self, int idx, T value) {
int size = self.size();
idx = normaliseIndex(idx, size);
if (idx < size) {
self.set(idx, value);
} else {
while (size < idx) {
self.add(size++, null);
}
self.add(idx, value);
}
}
/**
* Support subscript operator for list modification.
*/
public static <T> void putAt(List<T> self, Number idx, T value) {
putAt(self, idx.intValue(), value);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">
* def list = ["a", true]
* {@code list[1..<1] = 5}
* assert list == ["a", 5, true]
* </pre>
*
* @param self a List
* @param range the (in this case empty) subset of the list to set
* @param value the values to put at the given sublist or a Collection of values
* @since 1.0
*/
public static void putAt(List self, EmptyRange range, Object value) {
RangeInfo info = subListBorders(self.size(), range);
List sublist = self.subList(info.from, info.to);
sublist.clear();
if (value instanceof Collection) {
Collection col = (Collection) value;
if (col.isEmpty()) return;
sublist.addAll(col);
} else {
sublist.add(value);
}
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">
* def list = ["a", true]
* {@code list[1..<1] = [4, 3, 2]}
* assert list == ["a", 4, 3, 2, true]
* </pre>
*
* @param self a List
* @param range the (in this case empty) subset of the list to set
* @param value the Collection of values
* @since 1.0
* @see #putAt(java.util.List, groovy.lang.EmptyRange, java.lang.Object)
*/
public static void putAt(List self, EmptyRange range, Collection value) {
putAt(self, range, (Object)value);
}
private static <T> List<T> resizeListWithRangeAndGetSublist(List<T> self, IntRange range) {
RangeInfo info = subListBorders(self.size(), range);
int size = self.size();
if (info.to >= size) {
while (size < info.to) {
self.add(size++, null);
}
}
List<T> sublist = self.subList(info.from, info.to);
sublist.clear();
return sublist;
}
/**
* List subscript assignment operator when given a range as the index and
* the assignment operand is a collection.
* Example: <pre class="groovyTestCase">def myList = [4, 3, 5, 1, 2, 8, 10]
* myList[3..5] = ["a", true]
* assert myList == [4, 3, 5, "a", true, 10]</pre>
*
* Items in the given
* range are replaced with items from the collection.
*
* @param self a List
* @param range the subset of the list to set
* @param col the collection of values to put at the given sublist
* @since 1.5.0
*/
public static void putAt(List self, IntRange range, Collection col) {
List sublist = resizeListWithRangeAndGetSublist(self, range);
if (col.isEmpty()) return;
sublist.addAll(col);
}
/**
* List subscript assignment operator when given a range as the index.
* Example: <pre class="groovyTestCase">def myList = [4, 3, 5, 1, 2, 8, 10]
* myList[3..5] = "b"
* assert myList == [4, 3, 5, "b", 10]</pre>
*
* Items in the given
* range are replaced with the operand. The <code>value</code> operand is
* always treated as a single value.
*
* @param self a List
* @param range the subset of the list to set
* @param value the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, IntRange range, Object value) {
List sublist = resizeListWithRangeAndGetSublist(self, range);
sublist.add(value);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = ["a", true, 42, 9.4]
* list[1, 4] = ["x", false]
* assert list == ["a", "x", 42, 9.4, false]</pre>
*
* @param self a List
* @param splice the subset of the list to set
* @param values the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, List splice, List values) {
if (splice.isEmpty()) {
if ( ! values.isEmpty() )
throw new IllegalArgumentException("Trying to replace 0 elements with "+values.size()+" elements");
return;
}
Object first = splice.iterator().next();
if (first instanceof Integer) {
if (values.size() != splice.size())
throw new IllegalArgumentException("Trying to replace "+splice.size()+" elements with "+values.size()+" elements");
Iterator<?> valuesIter = values.iterator();
for (Object index : splice) {
putAt(self, (Integer) index, valuesIter.next());
}
} else {
throw new IllegalArgumentException("Can only index a List with another List of Integers, not a List of "+first.getClass().getName());
}
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = ["a", true, 42, 9.4]
* list[1, 3] = 5
* assert list == ["a", 5, 42, 5]</pre>
*
* @param self a List
* @param splice the subset of the list to set
* @param value the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, List splice, Object value) {
if (splice.isEmpty()) {
return;
}
Object first = splice.get(0);
if (first instanceof Integer) {
for (Object index : splice) {
self.set((Integer) index, value);
}
} else {
throw new IllegalArgumentException("Can only index a List with another List of Integers, not a List of "+first.getClass().getName());
}
}
// todo: remove after putAt(Splice) gets deleted
@Deprecated
protected static List getSubList(List self, List splice) {
int left /* = 0 */;
int right = 0;
boolean emptyRange = false;
if (splice.size() == 2) {
left = DefaultTypeTransformation.intUnbox(splice.get(0));
right = DefaultTypeTransformation.intUnbox(splice.get(1));
} else if (splice instanceof IntRange) {
IntRange range = (IntRange) splice;
left = range.getFrom();
right = range.getTo();
} else if (splice instanceof EmptyRange) {
RangeInfo info = subListBorders(self.size(), (EmptyRange) splice);
left = info.from;
emptyRange = true;
} else {
throw new IllegalArgumentException("You must specify a list of 2 indexes to create a sub-list");
}
int size = self.size();
left = normaliseIndex(left, size);
right = normaliseIndex(right, size);
List sublist /* = null */;
if (!emptyRange) {
sublist = self.subList(left, right + 1);
} else {
sublist = self.subList(left, left);
}
return sublist;
}
/**
* Support the subscript operator for a Map.
* <pre class="groovyTestCase">def map = [a:10]
* assert map["a"] == 10</pre>
*
* @param self a Map
* @param key an Object as a key for the map
* @return the value corresponding to the given key
* @since 1.0
*/
public static <K,V> V getAt(Map<K,V> self, Object key) {
return self.get(key);
}
/**
* Returns a new <code>Map</code> containing all entries from <code>left</code> and <code>right</code>,
* giving precedence to <code>right</code>. Any keys appearing in both Maps
* will appear in the resultant map with values from the <code>right</code>
* operand. If the <code>left</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
* <p>
* Roughly equivalent to <code>Map m = new HashMap(); m.putAll(left); m.putAll(right); return m;</code>
* but with some additional logic to preserve the <code>left</code> Map type for common cases as
* described above.
* <pre class="groovyTestCase">
* assert [a:10, b:20] + [a:5, c:7] == [a:5, b:20, c:7]
* </pre>
*
* @param left a Map
* @param right a Map
* @return a new Map containing all entries from left and right
* @since 1.5.0
*/
public static <K, V> Map<K, V> plus(Map<K, V> left, Map<K, V> right) {
Map<K, V> map = cloneSimilarMap(left);
map.putAll(right);
return map;
}
/**
* A helper method to allow maps to work with subscript operators
*
* @param self a Map
* @param key an Object as a key for the map
* @param value the value to put into the map
* @return the value corresponding to the given key
* @since 1.0
*/
public static <K,V> V putAt(Map<K,V> self, K key, V value) {
self.put(key, value);
return value;
}
/**
* Support the subscript operator for Collection.
* <pre class="groovyTestCase">
* assert [String, Long, Integer] == ["a",5L,2]["class"]
* </pre>
*
* @param coll a Collection
* @param property a String
* @return a List
* @since 1.0
*/
public static List getAt(Collection coll, String property) {
List<Object> answer = new ArrayList<>(coll.size());
return getAtIterable(coll, property, answer);
}
private static List getAtIterable(Iterable coll, String property, List<Object> answer) {
for (Object item : coll) {
if (item == null) continue;
Object value;
try {
value = InvokerHelper.getProperty(item, property);
} catch (MissingPropertyExceptionNoStack mpe) {
String causeString = new MissingPropertyException(mpe.getProperty(), mpe.getType()).toString();
throw new MissingPropertyException("Exception evaluating property '" + property +
"' for " + coll.getClass().getName() + ", Reason: " + causeString);
}
answer.add(value);
}
return answer;
}
/**
* A convenience method for creating an immutable Map.
*
* @param self a Map
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Map)
* @since 1.0
*/
public static <K, V> Map<K, V> asImmutable(Map<K, V> self) {
return asUnmodifiable(new LinkedHashMap<>(self));
}
/**
* A convenience method for creating an immutable SortedMap.
*
* @param self a SortedMap
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.SortedMap)
* @since 1.0
*/
public static <K, V> SortedMap<K, V> asImmutable(SortedMap<K, V> self) {
return asUnmodifiable(new TreeMap<>(self));
}
/**
* A convenience method for creating an immutable List.
* <pre class="groovyTestCase">
* def mutable = [1,2,3]
* def immutable = mutable.asImmutable()
* try {
* immutable << 4
* assert false
* } catch (UnsupportedOperationException) {
* assert true
* }
* mutable << 4
* assert mutable.size() == 4
* assert immutable.size() == 3
* </pre>
*
* @param self a List
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asUnmodifiable(java.util.List)
* @since 1.0
*/
public static <T> List<T> asImmutable(List<T> self) {
return asUnmodifiable(new ArrayList<>(self));
}
/**
* A convenience method for creating an immutable Set.
*
* @param self a Set
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Set)
* @since 1.0
*/
public static <T> Set<T> asImmutable(Set<T> self) {
return asUnmodifiable(new LinkedHashSet<>(self));
}
/**
* A convenience method for creating an immutable SortedSet.
*
* @param self a SortedSet
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.SortedSet)
* @since 1.0
*/
public static <T> SortedSet<T> asImmutable(SortedSet<T> self) {
return asUnmodifiable(new TreeSet<>(self));
}
/**
* A convenience method for creating an immutable Collection.
*
* @param self a Collection
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Collection)
* @since 1.5.0
*/
public static <T> Collection<T> asImmutable(Collection<T> self) {
return asUnmodifiable((Collection<T>)new ArrayList<>(self));
}
/**
* Creates an unmodifiable view of a Map.
*
* @param self a Map
* @return an unmodifiable view of the Map
* @see java.util.Collections#unmodifiableMap(java.util.Map)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <K, V> Map<K, V> asUnmodifiable(Map<K, V> self) {
return Collections.unmodifiableMap(self);
}
/**
* Creates an unmodifiable view of a SortedMap.
*
* @param self a SortedMap
* @return an unmodifiable view of the SortedMap
* @see java.util.Collections#unmodifiableSortedMap(java.util.SortedMap)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <K, V> SortedMap<K, V> asUnmodifiable(SortedMap<K, V> self) {
return Collections.unmodifiableSortedMap(self);
}
/**
* Creates an unmodifiable view of a List.
* <pre class="groovyTestCase">
* def mutable = [1,2,3]
* def unmodifiable = mutable.asUnmodifiable()
* try {
* unmodifiable << 4
* assert false
* } catch (UnsupportedOperationException) {
* assert true
* }
* mutable << 4
* assert unmodifiable.size() == 4
* </pre>
*
* @param self a List
* @return an unmodifiable view of the List
* @see java.util.Collections#unmodifiableList(java.util.List)
* @since 2.5.0
*/
public static <T> List<T> asUnmodifiable(List<T> self) {
return Collections.unmodifiableList(self);
}
/**
* Creates an unmodifiable view of a Set.
*
* @param self a Set
* @return an unmodifiable view of the Set
* @see java.util.Collections#unmodifiableSet(java.util.Set)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> Set<T> asUnmodifiable(Set<T> self) {
return Collections.unmodifiableSet(self);
}
/**
* Creates an unmodifiable view of a SortedSet.
*
* @param self a SortedSet
* @return an unmodifiable view of the SortedSet
* @see java.util.Collections#unmodifiableSortedSet(java.util.SortedSet)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> SortedSet<T> asUnmodifiable(SortedSet<T> self) {
return Collections.unmodifiableSortedSet(self);
}
/**
* Creates an unmodifiable view of a Collection.
*
* @param self a Collection
* @return an unmodifiable view of the Collection
* @see java.util.Collections#unmodifiableCollection(java.util.Collection)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> Collection<T> asUnmodifiable(Collection<T> self) {
return Collections.unmodifiableCollection(self);
}
/**
* A convenience method for creating a synchronized Map.
*
* @param self a Map
* @return a synchronized Map
* @see java.util.Collections#synchronizedMap(java.util.Map)
* @since 1.0
*/
public static <K,V> Map<K,V> asSynchronized(Map<K,V> self) {
return Collections.synchronizedMap(self);
}
/**
* A convenience method for creating a synchronized SortedMap.
*
* @param self a SortedMap
* @return a synchronized SortedMap
* @see java.util.Collections#synchronizedSortedMap(java.util.SortedMap)
* @since 1.0
*/
public static <K,V> SortedMap<K,V> asSynchronized(SortedMap<K,V> self) {
return Collections.synchronizedSortedMap(self);
}
/**
* A convenience method for creating a synchronized Collection.
*
* @param self a Collection
* @return a synchronized Collection
* @see java.util.Collections#synchronizedCollection(java.util.Collection)
* @since 1.0
*/
public static <T> Collection<T> asSynchronized(Collection<T> self) {
return Collections.synchronizedCollection(self);
}
/**
* A convenience method for creating a synchronized List.
*
* @param self a List
* @return a synchronized List
* @see java.util.Collections#synchronizedList(java.util.List)
* @since 1.0
*/
public static <T> List<T> asSynchronized(List<T> self) {
return Collections.synchronizedList(self);
}
/**
* A convenience method for creating a synchronized Set.
*
* @param self a Set
* @return a synchronized Set
* @see java.util.Collections#synchronizedSet(java.util.Set)
* @since 1.0
*/
public static <T> Set<T> asSynchronized(Set<T> self) {
return Collections.synchronizedSet(self);
}
/**
* A convenience method for creating a synchronized SortedSet.
*
* @param self a SortedSet
* @return a synchronized SortedSet
* @see java.util.Collections#synchronizedSortedSet(java.util.SortedSet)
* @since 1.0
*/
public static <T> SortedSet<T> asSynchronized(SortedSet<T> self) {
return Collections.synchronizedSortedSet(self);
}
/**
* Synonym for {@link #toSpreadMap(java.util.Map)}.
* @param self a map
* @return a newly created SpreadMap
* @since 1.0
*/
public static SpreadMap spread(Map self) {
return toSpreadMap(self);
}
/**
* Returns a new <code>SpreadMap</code> from this map.
* <p>
* The example below shows the various possible use cases:
* <pre class="groovyTestCase">
* def fn(Map m) { return m.a + m.b + m.c + m.d }
*
* assert fn(a:1, b:2, c:3, d:4) == 10
* assert fn(a:1, *:[b:2, c:3], d:4) == 10
* assert fn([a:1, b:2, c:3, d:4].toSpreadMap()) == 10
* assert fn((['a', 1, 'b', 2, 'c', 3, 'd', 4] as Object[]).toSpreadMap()) == 10
* assert fn(['a', 1, 'b', 2, 'c', 3, 'd', 4].toSpreadMap()) == 10
* assert fn(['abcd'.toList(), 1..4].transpose().flatten().toSpreadMap()) == 10
* </pre>
* Note that toSpreadMap() is not normally used explicitly but under the covers by Groovy.
*
* @param self a map to be converted into a SpreadMap
* @return a newly created SpreadMap if this map is not null and its size is positive.
* @see groovy.lang.SpreadMap#SpreadMap(java.util.Map)
* @since 1.0
*/
public static SpreadMap toSpreadMap(Map self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Map to SpreadMap, because it is null.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this array.
* <p>
* @param self an object array
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.lang.Object[])
* @see #toSpreadMap(java.util.Map)
* @since 1.0
*/
public static SpreadMap toSpreadMap(Object[] self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Object[] to SpreadMap, because it is null.");
else if (self.length % 2 != 0)
throw new GroovyRuntimeException("Fail to convert Object[] to SpreadMap, because it's size is not even.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this list.
* <p>
* @param self a list
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.util.List)
* @see #toSpreadMap(java.util.Map)
* @since 1.8.0
*/
public static SpreadMap toSpreadMap(List self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert List to SpreadMap, because it is null.");
else if (self.size() % 2 != 0)
throw new GroovyRuntimeException("Fail to convert List to SpreadMap, because it's size is not even.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this iterable.
* <p>
* @param self an iterable
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.util.List)
* @see #toSpreadMap(java.util.Map)
* @since 2.4.0
*/
public static SpreadMap toSpreadMap(Iterable self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Iterable to SpreadMap, because it is null.");
else
return toSpreadMap(asList(self));
}
/**
* Wraps a map using the decorator pattern with a wrapper that intercepts all calls
* to <code>get(key)</code>. If an unknown key is found, a default value will be
* stored into the Map before being returned. The default value stored will be the
* result of calling the supplied Closure with the key as the parameter to the Closure.
* Example usage:
* <pre class="groovyTestCase">
* def map = [a:1, b:2].withDefault{ k {@code ->} k.toCharacter().isLowerCase() ? 10 : -10 }
* def expected = [a:1, b:2, c:10, D:-10]
* assert expected.every{ e {@code ->} e.value == map[e.key] }
*
* def constMap = [:].withDefault{ 42 }
* assert constMap.foo == 42
* assert constMap.size() == 1
* </pre>
*
* @param self a Map
* @param init a Closure which is passed the unknown key
* @return the wrapped Map
* @since 1.7.1
*/
public static <K, V> Map<K, V> withDefault(Map<K, V> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> init) {
return MapWithDefault.newInstance(self, init);
}
/**
* An alias for <code>withLazyDefault</code> which decorates a list allowing
* it to grow when called with index values outside the normal list bounds.
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the decorated List
* @see #withLazyDefault(java.util.List, groovy.lang.Closure)
* @see #withEagerDefault(java.util.List, groovy.lang.Closure)
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withDefault(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return withLazyDefault(self, init);
}
@Deprecated
public static <T> List<T> withDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return withDefault(self, init);
}
/**
* Decorates a list allowing it to grow when called with a non-existent index value.
* When called with such values, the list is grown in size and a default value
* is placed in the list by calling a supplied <code>init</code> Closure. Subsequent
* retrieval operations if finding a null value in the list assume it was set
* as null from an earlier growing operation and again call the <code>init</code> Closure
* to populate the retrieved value; consequently the list can't be used to store null values.
* <p>
* How it works: The decorated list intercepts all calls
* to <code>getAt(index)</code> and <code>get(index)</code>. If an index greater than
* or equal to the current <code>size()</code> is used, the list will grow automatically
* up to the specified index. Gaps will be filled by {@code null}. If a default value
* should also be used to fill gaps instead of {@code null}, use <code>withEagerDefault</code>.
* If <code>getAt(index)</code> or <code>get(index)</code> are called and a null value
* is found, it is assumed that the null value was a consequence of an earlier grow list
* operation and the <code>init</code> Closure is called to populate the value.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def list = [0, 1].withLazyDefault{ 42 }
* assert list[0] == 0
* assert list[1] == 1
* assert list[3] == 42 // default value
* assert list == [0, 1, null, 42] // gap filled with null
*
* // illustrate using the index when generating default values
* def list2 = [5].withLazyDefault{ index {@code ->} index * index }
* assert list2[3] == 9
* assert list2 == [5, null, null, 9]
* assert list2[2] == 4
* assert list2 == [5, null, 4, 9]
*
* // illustrate what happens with null values
* list2[2] = null
* assert list2[2] == 4
* </pre>
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the decorated List
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withLazyDefault(List<T> self, @ClosureParams(value=SimpleType.class, options="int") Closure<T> init) {
return ListWithDefault.newInstance(self, true, init);
}
@Deprecated
public static <T> List<T> withLazyDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return ListWithDefault.newInstance(self, true, init);
}
/**
* Decorates a list allowing it to grow when called with a non-existent index value.
* When called with such values, the list is grown in size and a default value
* is placed in the list by calling a supplied <code>init</code> Closure. Null values
* can be stored in the list.
* <p>
* How it works: The decorated list intercepts all calls
* to <code>getAt(index)</code> and <code>get(index)</code>. If an index greater than
* or equal to the current <code>size()</code> is used, the list will grow automatically
* up to the specified index. Gaps will be filled by calling the <code>init</code> Closure.
* If generating a default value is a costly operation consider using <code>withLazyDefault</code>.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def list = [0, 1].withEagerDefault{ 42 }
* assert list[0] == 0
* assert list[1] == 1
* assert list[3] == 42 // default value
* assert list == [0, 1, 42, 42] // gap filled with default value
*
* // illustrate using the index when generating default values
* def list2 = [5].withEagerDefault{ index {@code ->} index * index }
* assert list2[3] == 9
* assert list2 == [5, 1, 4, 9]
*
* // illustrate what happens with null values
* list2[2] = null
* assert list2[2] == null
* assert list2 == [5, 1, null, 9]
* </pre>
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the wrapped List
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withEagerDefault(List<T> self, @ClosureParams(value=SimpleType.class, options="int") Closure<T> init) {
return ListWithDefault.newInstance(self, false, init);
}
@Deprecated
public static <T> List<T> withEagerDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return ListWithDefault.newInstance(self, false, init);
}
/**
* Zips an Iterable with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 0], ["b", 1]] == ["a", "b"].withIndex()
* assert ["0: a", "1: b"] == ["a", "b"].withIndex().collect { str, idx {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @return a zipped list with indices
* @see #indexed(Iterable)
* @since 2.4.0
*/
public static <E> List<Tuple2<E, Integer>> withIndex(Iterable<E> self) {
return withIndex(self, 0);
}
/**
* Zips an Iterable with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [0: "a", 1: "b"] == ["a", "b"].indexed()
* assert ["0: a", "1: b"] == ["a", "b"].indexed().collect { idx, str {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @return a zipped map with indices
* @see #withIndex(Iterable)
* @since 2.4.0
*/
public static <E> Map<Integer, E> indexed(Iterable<E> self) {
return indexed(self, 0);
}
/**
* Zips an Iterable with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 5], ["b", 6]] == ["a", "b"].withIndex(5)
* assert ["1: a", "2: b"] == ["a", "b"].withIndex(1).collect { str, idx {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @param offset an index to start from
* @return a zipped list with indices
* @see #indexed(Iterable, int)
* @since 2.4.0
*/
public static <E> List<Tuple2<E, Integer>> withIndex(Iterable<E> self, int offset) {
return toList(withIndex(self.iterator(), offset));
}
/**
* Zips an Iterable with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [5: "a", 6: "b"] == ["a", "b"].indexed(5)
* assert ["1: a", "2: b"] == ["a", "b"].indexed(1).collect { idx, str {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @param offset an index to start from
* @return a Map (since the keys/indices are unique) containing the elements from the iterable zipped with indices
* @see #withIndex(Iterable, int)
* @since 2.4.0
*/
public static <E> Map<Integer, E> indexed(Iterable<E> self, int offset) {
Map<Integer, E> result = new LinkedHashMap<>();
Iterator<Tuple2<Integer, E>> indexed = indexed(self.iterator(), offset);
while (indexed.hasNext()) {
Tuple2<Integer, E> next = indexed.next();
result.put(next.getV1(), next.getV2());
}
return result;
}
/**
* Zips an iterator with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 0], ["b", 1]] == ["a", "b"].iterator().withIndex().toList()
* assert ["0: a", "1: b"] == ["a", "b"].iterator().withIndex().collect { str, idx {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @return a zipped iterator with indices
* @see #indexed(Iterator)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<E, Integer>> withIndex(Iterator<E> self) {
return withIndex(self, 0);
}
/**
* Zips an iterator with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [[0, "a"], [1, "b"]] == ["a", "b"].iterator().indexed().collect{ tuple {@code ->} [tuple.first, tuple.second] }
* assert ["0: a", "1: b"] == ["a", "b"].iterator().indexed().collect { idx, str {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @return a zipped iterator with indices
* @see #withIndex(Iterator)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<Integer, E>> indexed(Iterator<E> self) {
return indexed(self, 0);
}
/**
* Zips an iterator with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 5], ["b", 6]] == ["a", "b"].iterator().withIndex(5).toList()
* assert ["1: a", "2: b"] == ["a", "b"].iterator().withIndex(1).collect { str, idx {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @param offset an index to start from
* @return a zipped iterator with indices
* @see #indexed(Iterator, int)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<E, Integer>> withIndex(Iterator<E> self, int offset) {
return new ZipPostIterator<>(self, offset);
}
/**
* Zips an iterator with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [[5, "a"], [6, "b"]] == ["a", "b"].iterator().indexed(5).toList()
* assert ["a: 1", "b: 2"] == ["a", "b"].iterator().indexed(1).collect { idx, str {@code ->} "$str: $idx" }.toList()
* </pre>
*
* @param self an iterator
* @param offset an index to start from
* @return a zipped iterator with indices
* @see #withIndex(Iterator, int)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<Integer, E>> indexed(Iterator<E> self, int offset) {
return new ZipPreIterator<>(self, offset);
}
private static final class ZipPostIterator<E> implements Iterator<Tuple2<E, Integer>> {
private final Iterator<E> delegate;
private int index;
private ZipPostIterator(Iterator<E> delegate, int offset) {
this.delegate = delegate;
this.index = offset;
}
public boolean hasNext() {
return delegate.hasNext();
}
public Tuple2<E, Integer> next() {
if (!hasNext()) throw new NoSuchElementException();
return new Tuple2<>(delegate.next(), index++);
}
public void remove() {
delegate.remove();
}
}
private static final class ZipPreIterator<E> implements Iterator<Tuple2<Integer, E>> {
private final Iterator<E> delegate;
private int index;
private ZipPreIterator(Iterator<E> delegate, int offset) {
this.delegate = delegate;
this.index = offset;
}
public boolean hasNext() {
return delegate.hasNext();
}
public Tuple2<Integer, E> next() {
if (!hasNext()) throw new NoSuchElementException();
return new Tuple2<>(index++, delegate.next());
}
public void remove() {
delegate.remove();
}
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable,boolean)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self) {
return sort((Iterable<T>) self, true);
}
/**
* Sorts the Collection. Assumes that the collection items are comparable
* and uses their natural ordering to determine the resulting order.
* If the Collection is a List, it is sorted in place and returned.
* Otherwise, the elements are first placed into a new list which is then
* sorted and returned - leaving the original Collection unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [3,1,2].sort()</pre>
*
* @param self the Iterable to be sorted
* @return the sorted Iterable as a List
* @see #sort(Collection, boolean)
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self) {
return sort(self, true);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate) {
return sort((Iterable<T>) self, mutate);
}
/**
* Sorts the Iterable. Assumes that the Iterable items are
* comparable and uses their natural ordering to determine the resulting order.
* If the Iterable is a List and mutate is true,
* it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [3,1,2].sort()</pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2]
* def sorted = orig.sort(false)
* assert orig == [1, 3, 2]
* assert sorted == [1, 2, 3]
* </pre>
*
* @param self the iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @return the sorted iterable as a List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate) {
List<T> answer = mutate ? asList(self) : toList(self);
answer.sort(new NumberAwareComparator<>());
return answer;
}
/**
* Sorts the elements from the given map into a new ordered map using
* the closure as a comparator to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">def map = [a:5, b:3, c:6, d:4].sort { a, b {@code ->} a.value {@code <=>} b.value }
* assert map == [b:3, d:4, a:5, c:6]</pre>
*
* @param self the original unsorted map
* @param closure a Closure used as a comparator
* @return the sorted map
* @since 1.6.0
*/
public static <K, V> Map<K, V> sort(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
Map<K, V> result = new LinkedHashMap<>();
List<Map.Entry<K, V>> entries = asList((Iterable<Map.Entry<K, V>>) self.entrySet());
sort((Iterable<Map.Entry<K, V>>) entries, closure);
for (Map.Entry<K, V> entry : entries) {
result.put(entry.getKey(), entry.getValue());
}
return result;
}
/**
* Sorts the elements from the given map into a new ordered Map using
* the specified key comparator to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">def map = [ba:3, cz:6, ab:5].sort({ a, b {@code ->} a[-1] {@code <=>} b[-1] } as Comparator)
* assert map*.value == [3, 5, 6]</pre>
*
* @param self the original unsorted map
* @param comparator a Comparator
* @return the sorted map
* @since 1.7.2
*/
public static <K, V> Map<K, V> sort(Map<K, V> self, Comparator<? super K> comparator) {
Map<K, V> result = new TreeMap<>(comparator);
result.putAll(self);
return result;
}
/**
* Sorts the elements from the given map into a new ordered Map using
* the natural ordering of the keys to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">map = [ba:3, cz:6, ab:5].sort()
* assert map*.value == [5, 3, 6]
* </pre>
*
* @param self the original unsorted map
* @return the sorted map
* @since 1.7.2
*/
public static <K, V> Map<K, V> sort(Map<K, V> self) {
return new TreeMap<>(self);
}
/**
* Modifies this array so that its elements are in sorted order.
* The array items are assumed to be comparable.
*
* @param self the array to be sorted
* @return the sorted array
* @since 1.5.5
*/
public static <T> T[] sort(T[] self) {
Arrays.sort(self, new NumberAwareComparator<>());
return self;
}
/**
* Sorts the given array into sorted order.
* The array items are assumed to be comparable.
* If mutate is true, the array is sorted in place and returned. Otherwise, a new sorted
* array is returned and the original array remains unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false)
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["Hey","hello","hi"] as String[]
* orig.sort(true)
* assert orig == ["Hey","hello","hi"] as String[]
* </pre>
*
* @param self the array to be sorted
* @param mutate false will always cause a new array to be created, true will mutate the array in place
* @return the sorted array
* @since 1.8.1
*/
public static <T> T[] sort(T[] self, boolean mutate) {
T[] answer = mutate ? self : self.clone();
Arrays.sort(answer, new NumberAwareComparator<>());
return answer;
}
/**
* Sorts the given iterator items into a sorted iterator. The items are
* assumed to be comparable. The original iterator will become
* exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self) {
return sort((Iterable<T>) toList(self)).listIterator();
}
/**
* Sorts the given iterator items into a sorted iterator using the comparator. The
* original iterator will become exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @param comparator a Comparator used for comparing items
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self, Comparator<? super T> comparator) {
return sort(toList(self), true, comparator).listIterator();
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, Comparator<T> comparator) {
return sort((Iterable<T>) self, true, comparator);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Comparator)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate, Comparator<T> comparator) {
return sort((Iterable<T>) self, mutate, comparator);
}
/**
* Sorts the Iterable using the given Comparator. If the Iterable is a List and mutate
* is true, it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* assert ["hi","hey","hello"] == ["hello","hi","hey"].sort(false, { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )
* </pre>
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.sort(false, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param comparator a Comparator used for the comparison
* @return a sorted List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate, Comparator<? super T> comparator) {
List<T> list = mutate ? asList(self) : toList(self);
list.sort(comparator);
return list;
}
/**
* Sorts the given array into sorted order using the given comparator.
*
* @param self the array to be sorted
* @param comparator a Comparator used for the comparison
* @return the sorted array
* @since 1.5.5
*/
public static <T> T[] sort(T[] self, Comparator<? super T> comparator) {
return sort(self, true, comparator);
}
/**
* Modifies this array so that its elements are in sorted order as determined by the given comparator.
* If mutate is true, the array is sorted in place and returned. Otherwise, a new sorted
* array is returned and the original array remains unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["hello","Hey","hi"] as String[]
* orig.sort(true, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","Hey","hi"] as String[]
* </pre>
*
* @param self the array containing elements to be sorted
* @param mutate false will always cause a new array to be created, true will mutate arrays in place
* @param comparator a Comparator used for the comparison
* @return a sorted array
* @since 1.8.1
*/
public static <T> T[] sort(T[] self, boolean mutate, Comparator<? super T> comparator) {
T[] answer = mutate ? self : self.clone();
Arrays.sort(answer, comparator);
return answer;
}
/**
* Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.
* The original iterator will be fully processed after the method call.
* <p>
* If the closure has two parameters it is used like a traditional Comparator.
* I.e. it should compare its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than, equal to,
* or greater than the second respectively. Otherwise, the Closure is assumed
* to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the Iterator to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort((Iterable<T>) toList(self), closure).listIterator();
}
/**
* Sorts the elements from this array into a newly created array using
* the Closure to determine the correct ordering.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the array containing the elements to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted array
* @since 1.5.5
*/
public static <T> T[] sort(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort(self, false, closure);
}
/**
* Modifies this array so that its elements are in sorted order using the Closure to determine the correct ordering.
* If mutate is false, a new array is returned and the original array remains unchanged.
* Otherwise, the original array is sorted in place and returned.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false) { it.size() }
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["hi","Hey","hello"] as String[]
* orig.sort(true) { it.size() }
* assert orig == ["hi","Hey","hello"] as String[]
* </pre>
*
* @param self the array to be sorted
* @param mutate false will always cause a new array to be created, true will mutate arrays in place
* @param closure a Closure used to determine the correct ordering
* @return the sorted array
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T> T[] sort(T[] self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
T[] answer = (T[]) sort((Iterable<T>) toList(self), closure).toArray();
if (mutate) {
System.arraycopy(answer, 0, self, 0, answer.length);
}
return mutate ? self : answer;
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Closure)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate, Closure closure) {
return sort((Iterable<T>)self, mutate, closure);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort((Iterable<T>)self, closure);
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. If the Iterable is a List,
* it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the Closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
*
* @param self the Iterable to be sorted
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @see #sort(Collection, boolean, Closure)
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort(self, true, closure);
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. If the Iterable is a List
* and mutate is true, it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.sort(false) { it.toUpperCase() }
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
List<T> list = mutate ? asList(self) : toList(self);
// use a comparator of one item or two
int params = closure.getMaximumNumberOfParameters();
if (params == 1) {
list.sort(new OrderBy<>(closure));
} else {
list.sort(new ClosureComparator<>(closure));
}
return list;
}
/**
* Avoids doing unnecessary work when sorting an already sorted set (i.e. an identity function for an already sorted set).
*
* @param self an already sorted set
* @return the set
* @since 1.0
*/
public static <T> SortedSet<T> sort(SortedSet<T> self) {
return self;
}
/**
* Avoids doing unnecessary work when sorting an already sorted map (i.e. an identity function for an already sorted map).
*
* @param self an already sorted map
* @return the map
* @since 1.8.1
*/
public static <K, V> SortedMap<K, V> sort(SortedMap<K, V> self) {
return self;
}
/**
* Sorts the Iterable. Assumes that the Iterable elements are
* comparable and uses a {@link NumberAwareComparator} to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterable elements. The elements are first placed into a new list which
* is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* def orig = [1, 3, 2]
* def sorted = orig.toSorted()
* assert orig == [1, 3, 2]
* assert sorted == [1, 2, 3]
* </pre>
*
* @param self the Iterable to be sorted
* @return the sorted iterable as a List
* @see #toSorted(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self) {
return toSorted(self, new NumberAwareComparator<>());
}
/**
* Sorts the Iterable using the given Comparator. The elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.toSorted(String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param comparator a Comparator used for the comparison
* @return a sorted List
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self, Comparator<T> comparator) {
List<T> list = toList(self);
list.sort(comparator);
return list;
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. The elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the Closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
*
* @param self the Iterable to be sorted
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @see #toSorted(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(closure) : new ClosureComparator<>(
closure);
return toSorted(self, comparator);
}
/**
* Sorts the Iterator. Assumes that the Iterator elements are
* comparable and uses a {@link NumberAwareComparator} to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterator elements.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @return the sorted items as an Iterator
* @see #toSorted(Iterator, Comparator)
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self) {
return toSorted(self, new NumberAwareComparator<>());
}
/**
* Sorts the given iterator items using the comparator. The
* original iterator will become exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @param comparator a Comparator used for comparing items
* @return the sorted items as an Iterator
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self, Comparator<T> comparator) {
return toSorted(toList(self), comparator).listIterator();
}
/**
* Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.
* The original iterator will be fully processed after the method call.
* <p>
* If the closure has two parameters it is used like a traditional Comparator.
* I.e. it should compare its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than, equal to,
* or greater than the second respectively. Otherwise, the Closure is assumed
* to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the Iterator to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted items as an Iterator
* @see #toSorted(Iterator, Comparator)
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(closure) : new ClosureComparator<>(
closure);
return toSorted(self, comparator);
}
/**
* Returns a sorted version of the given array using the supplied comparator.
*
* @param self the array to be sorted
* @return the sorted array
* @see #toSorted(Object[], Comparator)
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self) {
return toSorted(self, new NumberAwareComparator<>());
}
/**
* Returns a sorted version of the given array using the supplied comparator to determine the resulting order.
* <pre class="groovyTestCase">
* def sumDigitsComparator = [compare: { num1, num2 {@code ->} num1.toString().toList()*.toInteger().sum() {@code <=>} num2.toString().toList()*.toInteger().sum() }] as Comparator
* Integer[] nums = [9, 44, 222, 7000]
* def result = nums.toSorted(sumDigitsComparator)
* assert result instanceof Integer[]
* assert result == [222, 7000, 44, 9]
* </pre>
*
* @param self the array to be sorted
* @param comparator a Comparator used for the comparison
* @return the sorted array
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self, Comparator<T> comparator) {
T[] answer = self.clone();
Arrays.sort(answer, comparator);
return answer;
}
/**
* Sorts the elements from this array into a newly created array using
* the Closure to determine the correct ordering.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the array containing the elements to be sorted
* @param condition a Closure used to determine the correct ordering
* @return a sorted array
* @see #toSorted(Object[], Comparator)
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(condition) : new ClosureComparator<>(
condition);
return toSorted(self, comparator);
}
/**
* Sorts the elements from the given map into a new ordered map using
* a {@link NumberAwareComparator} on map entry values to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterator elements. The original map is unchanged.
* <pre class="groovyTestCase">
* def map = [a:5L, b:3, c:6, d:4.0].toSorted()
* assert map.toString() == '[b:3, d:4.0, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self) {
return toSorted(self, new NumberAwareValueComparator<>());
}
private static class NumberAwareValueComparator<K, V> implements Comparator<Map.Entry<K, V>> {
private final Comparator<V> delegate = new NumberAwareComparator<>();
@Override
public int compare(Map.Entry<K, V> e1, Map.Entry<K, V> e2) {
return delegate.compare(e1.getValue(), e2.getValue());
}
}
/**
* Sorts the elements from the given map into a new ordered map using
* the supplied comparator to determine the ordering. The original map is unchanged.
* <pre class="groovyTestCase">
* def keyComparator = [compare: { e1, e2 {@code ->} e1.key {@code <=>} e2.key }] as Comparator
* def valueComparator = [compare: { e1, e2 {@code ->} e1.value {@code <=>} e2.value }] as Comparator
* def map1 = [a:5, b:3, d:4, c:6].toSorted(keyComparator)
* assert map1.toString() == '[a:5, b:3, c:6, d:4]'
* def map2 = [a:5, b:3, d:4, c:6].toSorted(valueComparator)
* assert map2.toString() == '[b:3, d:4, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @param comparator a Comparator used for the comparison
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self, Comparator<Map.Entry<K, V>> comparator) {
List<Map.Entry<K, V>> sortedEntries = toSorted(self.entrySet(), comparator);
Map<K, V> result = new LinkedHashMap<>();
for (Map.Entry<K, V> entry : sortedEntries) {
result.put(entry.getKey(), entry.getValue());
}
return result;
}
/**
* Sorts the elements from the given map into a new ordered map using
* the supplied Closure condition as a comparator to determine the ordering. The original map is unchanged.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two entry parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single entry parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
* <pre class="groovyTestCase">
* def map = [a:5, b:3, c:6, d:4].toSorted { a, b {@code ->} a.value {@code <=>} b.value }
* assert map.toString() == '[b:3, d:4, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @param condition a Closure used as a comparator
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure condition) {
Comparator<Map.Entry<K,V>> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(
condition) : new ClosureComparator<>(condition);
return toSorted(self, comparator);
}
/**
* Avoids doing unnecessary work when sorting an already sorted set
*
* @param self an already sorted set
* @return an ordered copy of the sorted set
* @since 2.4.0
*/
public static <T> Set<T> toSorted(SortedSet<T> self) {
return new LinkedHashSet<>(self);
}
/**
* Avoids doing unnecessary work when sorting an already sorted map
*
* @param self an already sorted map
* @return an ordered copy of the map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(SortedMap<K, V> self) {
return new LinkedHashMap<>(self);
}
/**
* Removes the initial item from the List.
*
* <pre class="groovyTestCase">
* def list = ["a", false, 2]
* assert list.pop() == 'a'
* assert list == [false, 2]
* </pre>
*
* This is similar to pop on a Stack where the first item in the list
* represents the top of the stack.
*
* Note: The behavior of this method changed in Groovy 2.5 to align with Java.
* If you need the old behavior use 'removeLast'.
*
* @param self a List
* @return the item removed from the List
* @throws NoSuchElementException if the list is empty
* @since 1.0
*/
public static <T> T pop(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot pop() an empty List");
}
return self.remove(0);
}
/**
* Removes the last item from the List.
*
* <pre class="groovyTestCase">
* def list = ["a", false, 2]
* assert list.removeLast() == 2
* assert list == ["a", false]
* </pre>
*
* Using add() and removeLast() is similar to push and pop on a Stack
* where the last item in the list represents the top of the stack.
*
* @param self a List
* @return the item removed from the List
* @throws NoSuchElementException if the list is empty
* @since 2.5.0
*/
public static <T> T removeLast(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot removeLast() an empty List");
}
return self.remove(self.size() - 1);
}
/**
* Provides an easy way to append multiple Map.Entry values to a Map.
*
* @param self a Map
* @param entries a Collection of Map.Entry items to be added to the Map.
* @return the same map, after the items have been added to it.
* @since 1.6.1
*/
public static <K, V> Map<K, V> putAll(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) {
for (Map.Entry<? extends K, ? extends V> entry : entries) {
self.put(entry.getKey(), entry.getValue());
}
return self;
}
/**
* Returns a new <code>Map</code> containing all entries from <code>self</code> and <code>entries</code>,
* giving precedence to <code>entries</code>. Any keys appearing in both Maps
* will appear in the resultant map with values from the <code>entries</code>
* operand. If <code>self</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
*
* @param self a Map
* @param entries a Collection of Map.Entry items to be added to the Map.
* @return a new Map containing all key, value pairs from self and entries
* @since 1.6.1
*/
public static <K, V> Map<K, V> plus(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) {
Map<K, V> map = cloneSimilarMap(self);
putAll(map, entries);
return map;
}
/**
* Prepends an item to the start of the List.
*
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* list.push("x")
* assert list == ['x', 3, 4, 2]
* </pre>
*
* This is similar to push on a Stack where the first item in the list
* represents the top of the stack.
*
* Note: The behavior of this method changed in Groovy 2.5 to align with Java.
* If you need the old behavior use 'add'.
*
* @param self a List
* @param value element to be prepended to this list.
* @return <tt>true</tt> (for legacy compatibility reasons).
* @since 1.5.5
*/
public static <T> boolean push(List<T> self, T value) {
self.add(0, value);
return true;
}
/**
* Returns the last item from the List.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.last() == 2
* // check original is unaltered
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return the last item from the List
* @throws NoSuchElementException if the list is empty and you try to access the last() item.
* @since 1.5.5
*/
public static <T> T last(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot access last() element from an empty List");
}
return self.get(self.size() - 1);
}
/**
* Returns the last item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.last() == 2
* // check original unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The last element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the last item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the last() item.
* @since 1.8.7
*/
public static <T> T last(Iterable<T> self) {
Iterator<T> iterator = self.iterator();
if (!iterator.hasNext()) {
throw new NoSuchElementException("Cannot access last() element from an empty Iterable");
}
T result = null;
while (iterator.hasNext()) {
result = iterator.next();
}
return result;
}
/**
* Returns the last item from the array.
* <pre class="groovyTestCase">
* def array = [3, 4, 2].toArray()
* assert array.last() == 2
* </pre>
*
* @param self an array
* @return the last item from the array
* @throws NoSuchElementException if the array is empty and you try to access the last() item.
* @since 1.7.3
*/
public static <T> T last(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access last() element from an empty Array");
}
return self[self.length - 1];
}
/**
* Returns the first item from the List.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.first() == 3
* // check original is unaltered
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return the first item from the List
* @throws NoSuchElementException if the list is empty and you try to access the first() item.
* @since 1.5.5
*/
public static <T> T first(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot access first() element from an empty List");
}
return self.get(0);
}
/**
* Returns the first item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.first() == 3
* // check original is unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The first element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the first item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the first() item.
* @since 1.8.7
*/
public static <T> T first(Iterable<T> self) {
Iterator<T> iterator = self.iterator();
if (!iterator.hasNext()) {
throw new NoSuchElementException("Cannot access first() element from an empty Iterable");
}
return iterator.next();
}
/**
* Returns the first item from the array.
* <pre class="groovyTestCase">
* def array = [3, 4, 2].toArray()
* assert array.first() == 3
* </pre>
*
* @param self an array
* @return the first item from the array
* @throws NoSuchElementException if the array is empty and you try to access the first() item.
* @since 1.7.3
*/
public static <T> T first(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access first() element from an empty array");
}
return self[0];
}
/**
* Returns the first item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.head() == 3
* // check original is unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The first element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the first item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the head() item.
* @since 2.4.0
*/
public static <T> T head(Iterable<T> self) {
return first(self);
}
/**
* Returns the first item from the List.
* <pre class="groovyTestCase">def list = [3, 4, 2]
* assert list.head() == 3
* assert list == [3, 4, 2]</pre>
*
* @param self a List
* @return the first item from the List
* @throws NoSuchElementException if the list is empty and you try to access the head() item.
* @since 1.5.5
*/
public static <T> T head(List<T> self) {
return first(self);
}
/**
* Returns the first item from the Object array.
* <pre class="groovyTestCase">def array = [3, 4, 2].toArray()
* assert array.head() == 3</pre>
*
* @param self an array
* @return the first item from the Object array
* @throws NoSuchElementException if the array is empty and you try to access the head() item.
* @since 1.7.3
*/
public static <T> T head(T[] self) {
return first(self);
}
/**
* Returns the items from the List excluding the first item.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.tail() == [4, 2]
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return a List without its first element
* @throws NoSuchElementException if the List is empty and you try to access the tail()
* @since 1.5.6
*/
public static <T> List<T> tail(List<T> self) {
return (List<T>) tail((Iterable<T>)self);
}
/**
* Returns the items from the SortedSet excluding the first item.
* <pre class="groovyTestCase">
* def sortedSet = [3, 4, 2] as SortedSet
* assert sortedSet.tail() == [3, 4] as SortedSet
* assert sortedSet == [3, 4, 2] as SortedSet
* </pre>
*
* @param self a SortedSet
* @return a SortedSet without its first element
* @throws NoSuchElementException if the SortedSet is empty and you try to access the tail()
* @since 2.4.0
*/
public static <T> SortedSet<T> tail(SortedSet<T> self) {
return (SortedSet<T>) tail((Iterable<T>) self);
}
/**
* Calculates the tail values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of tail on the items.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].tails() == [[1, 2, 3, 4], [2, 3, 4], [3, 4], [4], []]
* </pre>
*
* @param self an Iterable
* @return a List of the tail values from the given Iterable
* @since 2.5.0
*/
public static <T> List<List<T>> tails(Iterable<T> self) {
return GroovyCollections.tails(self);
}
/**
* Returns the items from the Iterable excluding the first item.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.tail() == [4, 2]
* assert list == [3, 4, 2]
* </pre>
*
* @param self an Iterable
* @return a collection without its first element
* @throws NoSuchElementException if the iterable is empty and you try to access the tail()
* @since 2.4.0
*/
public static <T> Collection<T> tail(Iterable<T> self) {
if (!self.iterator().hasNext()) {
throw new NoSuchElementException("Cannot access tail() for an empty iterable");
}
Collection<T> result = createSimilarCollection(self);
addAll(result, tail(self.iterator()));
return result;
}
/**
* Returns the items from the array excluding the first item.
* <pre class="groovyTestCase">
* String[] strings = ["a", "b", "c"]
* def result = strings.tail()
* assert result.class.componentType == String
* String[] expected = ["b", "c"]
* assert result == expected
* </pre>
*
* @param self an array
* @return an array without its first element
* @throws NoSuchElementException if the array is empty and you try to access the tail()
* @since 1.7.3
*/
public static <T> T[] tail(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access tail() for an empty array");
}
T[] result = createSimilarArray(self, self.length - 1);
System.arraycopy(self, 1, result, 0, self.length - 1);
return result;
}
/**
* Returns the original iterator after throwing away the first element.
*
* @param self the original iterator
* @return the iterator without its first element
* @throws NoSuchElementException if the array is empty and you try to access the tail()
* @since 1.8.1
*/
public static <T> Iterator<T> tail(Iterator<T> self) {
if (!self.hasNext()) {
throw new NoSuchElementException("Cannot access tail() for an empty Iterator");
}
self.next();
return self;
}
/**
* Calculates the init values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of init on the items.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].inits() == [[1, 2, 3, 4], [1, 2, 3], [1, 2], [1], []]
* </pre>
*
* @param self an Iterable
* @return a List of the init values from the given Iterable
* @since 2.5.0
*/
public static <T> List<List<T>> inits(Iterable<T> self) {
return GroovyCollections.inits(self);
}
/**
* Returns the items from the Iterable excluding the last item. Leaves the original Iterable unchanged.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.init() == [3, 4]
* assert list == [3, 4, 2]
* </pre>
*
* @param self an Iterable
* @return a Collection without its last element
* @throws NoSuchElementException if the iterable is empty and you try to access init()
* @since 2.4.0
*/
public static <T> Collection<T> init(Iterable<T> self) {
if (!self.iterator().hasNext()) {
throw new NoSuchElementException("Cannot access init() for an empty Iterable");
}
Collection<T> result;
if (self instanceof Collection) {
Collection<T> selfCol = (Collection<T>) self;
result = createSimilarCollection(selfCol, selfCol.size() - 1);
} else {
result = new ArrayList<>();
}
addAll(result, init(self.iterator()));
return result;
}
/**
* Returns the items from the List excluding the last item. Leaves the original List unchanged.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.init() == [3, 4]
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return a List without its last element
* @throws NoSuchElementException if the List is empty and you try to access init()
* @since 2.4.0
*/
public static <T> List<T> init(List<T> self) {
return (List<T>) init((Iterable<T>) self);
}
/**
* Returns the items from the SortedSet excluding the last item. Leaves the original SortedSet unchanged.
* <pre class="groovyTestCase">
* def sortedSet = [3, 4, 2] as SortedSet
* assert sortedSet.init() == [2, 3] as SortedSet
* assert sortedSet == [3, 4, 2] as SortedSet
* </pre>
*
* @param self a SortedSet
* @return a SortedSet without its last element
* @throws NoSuchElementException if the SortedSet is empty and you try to access init()
* @since 2.4.0
*/
public static <T> SortedSet<T> init(SortedSet<T> self) {
return (SortedSet<T>) init((Iterable<T>) self);
}
/**
* Returns an Iterator containing all of the items from this iterator except the last one.
* <pre class="groovyTestCase">
* def iter = [3, 4, 2].listIterator()
* def result = iter.init()
* assert result.toList() == [3, 4]
* </pre>
*
* @param self an Iterator
* @return an Iterator without the last element from the original Iterator
* @throws NoSuchElementException if the iterator is empty and you try to access init()
* @since 2.4.0
*/
public static <T> Iterator<T> init(Iterator<T> self) {
if (!self.hasNext()) {
throw new NoSuchElementException("Cannot access init() for an empty Iterator");
}
return new InitIterator<>(self);
}
private static final class InitIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private boolean exhausted;
private E next;
private InitIterator(Iterator<E> delegate) {
this.delegate = delegate;
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
advance();
}
private void advance() {
next = delegate.next();
exhausted = !delegate.hasNext();
}
}
/**
* Returns the items from the Object array excluding the last item.
* <pre class="groovyTestCase">
* String[] strings = ["a", "b", "c"]
* def result = strings.init()
* assert result.length == 2
* assert strings.class.componentType == String
* </pre>
*
* @param self an array
* @return an array without its last element
* @throws NoSuchElementException if the array is empty and you try to access the init() item.
* @since 2.4.0
*/
public static <T> T[] init(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access init() for an empty Object array");
}
T[] result = createSimilarArray(self, self.length - 1);
System.arraycopy(self, 0, result, 0, self.length - 1);
return result;
}
/**
* Returns the first <code>num</code> elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == []
* assert strings.take( 2 ) == [ 'a', 'b' ]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ]
* </pre>
*
* @param self the original List
* @param num the number of elements to take from this List
* @return a List consisting of the first <code>num</code> elements from this List,
* or else all the elements from the List if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> List<T> take(List<T> self, int num) {
return (List<T>) take((Iterable<T>)self, num);
}
/**
* Returns the first <code>num</code> elements from the head of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.take( 0 ) == [] as SortedSet
* assert strings.take( 2 ) == [ 'a', 'b' ] as SortedSet
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to take from this SortedSet
* @return a SortedSet consisting of the first <code>num</code> elements from this List,
* or else all the elements from the SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> take(SortedSet<T> self, int num) {
return (SortedSet<T>) take((Iterable<T>) self, num);
}
/**
* Returns the first <code>num</code> elements from the head of this array.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == [] as String[]
* assert strings.take( 2 ) == [ 'a', 'b' ] as String[]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to take from this array
* @return an array consisting of the first <code>num</code> elements of this array,
* or else the whole array if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> T[] take(T[] self, int num) {
if (self.length == 0 || num <= 0) {
return createSimilarArray(self, 0);
}
if (self.length <= num) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, num);
System.arraycopy(self, 0, ret, 0, num);
return ret;
}
/**
* Returns the first <code>num</code> elements from the head of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == []
* assert strings.take( 2 ) == [ 'a', 'b' ]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ]
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.take(0) == []
* assert abc.take(1) == ['a']
* assert abc.take(3) == ['a', 'b', 'c']
* assert abc.take(5) == ['a', 'b', 'c']
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to take from this Iterable
* @return a Collection consisting of the first <code>num</code> elements from this Iterable,
* or else all the elements from the Iterable if it has less then <code>num</code> elements.
* @since 1.8.7
*/
public static <T> Collection<T> take(Iterable<T> self, int num) {
Collection<T> result = self instanceof Collection ? createSimilarCollection((Collection<T>) self, Math.max(num, 0)) : new ArrayList<>();
addAll(result, take(self.iterator(), num));
return result;
}
/**
* Adds all items from the iterator to the Collection.
*
* @param self the collection
* @param items the items to add
* @return true if the collection changed
*/
public static <T> boolean addAll(Collection<T> self, Iterator<? extends T> items) {
boolean changed = false;
while (items.hasNext()) {
T next = items.next();
if (self.add(next)) changed = true;
}
return changed;
}
/**
* Adds all items from the iterable to the Collection.
*
* @param self the collection
* @param items the items to add
* @return true if the collection changed
*/
public static <T> boolean addAll(Collection<T> self, Iterable<? extends T> items) {
boolean changed = false;
for (T next : items) {
if (self.add(next)) changed = true;
}
return changed;
}
/**
* Returns a new map containing the first <code>num</code> elements from the head of this map.
* If the map instance does not have ordered keys, then this function could return a random <code>num</code>
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
* <pre class="groovyTestCase">
* def strings = [ 'a':10, 'b':20, 'c':30 ]
* assert strings.take( 0 ) == [:]
* assert strings.take( 2 ) == [ 'a':10, 'b':20 ]
* assert strings.take( 5 ) == [ 'a':10, 'b':20, 'c':30 ]
* </pre>
*
* @param self the original map
* @param num the number of elements to take from this map
* @return a new map consisting of the first <code>num</code> elements of this map,
* or else the whole map if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <K, V> Map<K, V> take(Map<K, V> self, int num) {
if (self.isEmpty() || num <= 0) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
for (Map.Entry<K, V> entry : self.entrySet()) {
K key = entry.getKey();
V value = entry.getValue();
ret.put(key, value);
if (--num <= 0) {
break;
}
}
return ret;
}
/**
* Returns an iterator of up to the first <code>num</code> elements from this iterator.
* The original iterator is stepped along by <code>num</code> elements.
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ true }, next:{ a++ } ] as Iterator
* def iteratorCompare( Iterator a, List b ) {
* a.collect { it } == b
* }
* assert iteratorCompare( iter.take( 0 ), [] )
* assert iteratorCompare( iter.take( 2 ), [ 0, 1 ] )
* assert iteratorCompare( iter.take( 5 ), [ 2, 3, 4, 5, 6 ] )
* </pre>
*
* @param self the Iterator
* @param num the number of elements to take from this iterator
* @return an iterator consisting of up to the first <code>num</code> elements of this iterator.
* @since 1.8.1
*/
public static <T> Iterator<T> take(Iterator<T> self, int num) {
return new TakeIterator<>(self, num);
}
private static final class TakeIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private Integer num;
private TakeIterator(Iterator<E> delegate, Integer num) {
this.delegate = delegate;
this.num = num;
}
public boolean hasNext() {
return num > 0 && delegate.hasNext();
}
public E next() {
if (num <= 0) throw new NoSuchElementException();
num--;
return delegate.next();
}
public void remove() {
delegate.remove();
}
}
@Deprecated
public static CharSequence take(CharSequence self, int num) {
return StringGroovyMethods.take(self, num);
}
/**
* Returns the last <code>num</code> elements from the tail of this array.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == [] as String[]
* assert strings.takeRight( 2 ) == [ 'b', 'c' ] as String[]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to take from this array
* @return an array consisting of the last <code>num</code> elements of this array,
* or else the whole array if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> T[] takeRight(T[] self, int num) {
if (self.length == 0 || num <= 0) {
return createSimilarArray(self, 0);
}
if (self.length <= num) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, num);
System.arraycopy(self, self.length - num, ret, 0, num);
return ret;
}
/**
* Returns the last <code>num</code> elements from the tail of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == []
* assert strings.takeRight( 2 ) == [ 'b', 'c' ]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ]
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.takeRight(0) == []
* assert abc.takeRight(1) == ['c']
* assert abc.takeRight(3) == ['a', 'b', 'c']
* assert abc.takeRight(5) == ['a', 'b', 'c']
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to take from this Iterable
* @return a Collection consisting of the last <code>num</code> elements from this Iterable,
* or else all the elements from the Iterable if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Collection<T> takeRight(Iterable<T> self, int num) {
if (num <= 0 || !self.iterator().hasNext()) {
return self instanceof Collection ? createSimilarCollection((Collection<T>) self, 0) : new ArrayList<>();
}
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
if (selfCol.size() <= num) {
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size());
ret.addAll(selfCol);
return ret;
}
Collection<T> ret = createSimilarCollection(selfCol, num);
ret.addAll(asList((Iterable<T>) selfCol).subList(selfCol.size() - num, selfCol.size()));
return ret;
}
/**
* Returns the last <code>num</code> elements from the tail of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == []
* assert strings.takeRight( 2 ) == [ 'b', 'c' ]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ]
* </pre>
*
* @param self the original List
* @param num the number of elements to take from this List
* @return a List consisting of the last <code>num</code> elements from this List,
* or else all the elements from the List if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> List<T> takeRight(List<T> self, int num) {
return (List<T>) takeRight((Iterable<T>) self, num);
}
/**
* Returns the last <code>num</code> elements from the tail of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.takeRight( 0 ) == [] as SortedSet
* assert strings.takeRight( 2 ) == [ 'b', 'c' ] as SortedSet
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to take from this SortedSet
* @return a SortedSet consisting of the last <code>num</code> elements from this SortedSet,
* or else all the elements from the SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> takeRight(SortedSet<T> self, int num) {
return (SortedSet<T>) takeRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ] as SortedSet
* assert strings.drop( 2 ) == [ 'c' ] as SortedSet
* assert strings.drop( 5 ) == [] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to drop from this Iterable
* @return a SortedSet consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> drop(SortedSet<T> self, int num) {
return (SortedSet<T>) drop((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.drop( 2 ) == [ 'c' ]
* assert strings.drop( 5 ) == []
* </pre>
*
* @param self the original List
* @param num the number of elements to drop from this Iterable
* @return a List consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> List<T> drop(List<T> self, int num) {
return (List<T>) drop((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.drop( 2 ) == [ 'c' ]
* assert strings.drop( 5 ) == []
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.drop(0) == ['a', 'b', 'c']
* assert abc.drop(1) == ['b', 'c']
* assert abc.drop(3) == []
* assert abc.drop(5) == []
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to drop from this Iterable
* @return a Collection consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 1.8.7
*/
public static <T> Collection<T> drop(Iterable<T> self, int num) {
Collection<T> result = createSimilarCollection(self);
addAll(result, drop(self.iterator(), num));
return result;
}
/**
* Drops the given number of elements from the head of this array
* if they are available.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ] as String[]
* assert strings.drop( 2 ) == [ 'c' ] as String[]
* assert strings.drop( 5 ) == [] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to drop from this array
* @return an array consisting of all elements of this array except the
* first <code>num</code> ones, or else the empty array, if this
* array has less than <code>num</code> elements.
* @since 1.8.1
*/
public static <T> T[] drop(T[] self, int num) {
if (self.length <= num) {
return createSimilarArray(self, 0);
}
if (num <= 0) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, self.length - num);
System.arraycopy(self, num, ret, 0, self.length - num);
return ret;
}
/**
* Drops the given number of key/value pairs from the head of this map if they are available.
* <pre class="groovyTestCase">
* def strings = [ 'a':10, 'b':20, 'c':30 ]
* assert strings.drop( 0 ) == [ 'a':10, 'b':20, 'c':30 ]
* assert strings.drop( 2 ) == [ 'c':30 ]
* assert strings.drop( 5 ) == [:]
* </pre>
* If the map instance does not have ordered keys, then this function could drop a random <code>num</code>
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self the original map
* @param num the number of elements to drop from this map
* @return a map consisting of all key/value pairs of this map except the first
* <code>num</code> ones, or else the empty map, if this map has
* less than <code>num</code> elements.
* @since 1.8.1
*/
public static <K, V> Map<K, V> drop(Map<K, V> self, int num) {
if (self.size() <= num) {
return createSimilarMap(self);
}
if (num == 0) {
return cloneSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
for (Map.Entry<K, V> entry : self.entrySet()) {
K key = entry.getKey();
V value = entry.getValue();
if (num-- <= 0) {
ret.put(key, value);
}
}
return ret;
}
/**
* Drops the given number of elements from the head of this iterator if they are available.
* The original iterator is stepped along by <code>num</code> elements.
* <pre class="groovyTestCase">
* def iteratorCompare( Iterator a, List b ) {
* a.collect { it } == b
* }
* def iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 0 ), [ 1, 2, 3, 4, 5 ] )
* iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 2 ), [ 3, 4, 5 ] )
* iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 5 ), [] )
* </pre>
*
* @param self the original iterator
* @param num the number of elements to drop from this iterator
* @return The iterator stepped along by <code>num</code> elements if they exist.
* @since 1.8.1
*/
public static <T> Iterator<T> drop(Iterator<T> self, int num) {
while (num-- > 0 && self.hasNext()) {
self.next();
}
return self;
}
/**
* Drops the given number of elements from the tail of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ] as SortedSet
* assert strings.dropRight( 2 ) == [ 'a' ] as SortedSet
* assert strings.dropRight( 5 ) == [] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to drop from this SortedSet
* @return a List consisting of all the elements of this SortedSet minus the last <code>num</code> elements,
* or an empty SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> dropRight(SortedSet<T> self, int num) {
return (SortedSet<T>) dropRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the tail of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.dropRight( 2 ) == [ 'a' ]
* assert strings.dropRight( 5 ) == []
* </pre>
*
* @param self the original List
* @param num the number of elements to drop from this List
* @return a List consisting of all the elements of this List minus the last <code>num</code> elements,
* or an empty List if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> List<T> dropRight(List<T> self, int num) {
return (List<T>) dropRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the tail of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.dropRight( 2 ) == [ 'a' ]
* assert strings.dropRight( 5 ) == []
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.dropRight(0) == ['a', 'b', 'c']
* assert abc.dropRight(1) == ['a', 'b']
* assert abc.dropRight(3) == []
* assert abc.dropRight(5) == []
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to drop from this Iterable
* @return a Collection consisting of all the elements of this Iterable minus the last <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Collection<T> dropRight(Iterable<T> self, int num) {
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
if (selfCol.size() <= num) {
return createSimilarCollection(selfCol, 0);
}
if (num <= 0) {
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size());
ret.addAll(selfCol);
return ret;
}
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size() - num);
ret.addAll(asList((Iterable<T>)selfCol).subList(0, selfCol.size() - num));
return ret;
}
/**
* Drops the given number of elements from the tail of this Iterator.
* <pre class="groovyTestCase">
* def getObliterator() { "obliter8".iterator() }
* assert obliterator.dropRight(-1).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r', '8']
* assert obliterator.dropRight(0).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r', '8']
* assert obliterator.dropRight(1).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r']
* assert obliterator.dropRight(4).toList() == ['o', 'b', 'l', 'i']
* assert obliterator.dropRight(7).toList() == ['o']
* assert obliterator.dropRight(8).toList() == []
* assert obliterator.dropRight(9).toList() == []
* </pre>
*
* @param self the original Iterator
* @param num the number of elements to drop
* @return an Iterator consisting of all the elements of this Iterator minus the last <code>num</code> elements,
* or an empty Iterator if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Iterator<T> dropRight(Iterator<T> self, int num) {
if (num <= 0) {
return self;
}
return new DropRightIterator<>(self, num);
}
private static final class DropRightIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final LinkedList<E> discards;
private boolean exhausted;
private int num;
private DropRightIterator(Iterator<E> delegate, int num) {
this.delegate = delegate;
this.num = num;
discards = new LinkedList<>();
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = discards.removeFirst();
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
while (discards.size() <= num && !exhausted) {
exhausted = !delegate.hasNext();
if (!exhausted) {
discards.add(delegate.next());
}
}
}
}
/**
* Drops the given number of elements from the tail of this array
* if they are available.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ] as String[]
* assert strings.dropRight( 2 ) == [ 'a' ] as String[]
* assert strings.dropRight( 5 ) == [] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to drop from this array
* @return an array consisting of all elements of this array except the
* last <code>num</code> ones, or else the empty array, if this
* array has less than <code>num</code> elements.
* @since 2.4.0
*/
public static <T> T[] dropRight(T[] self, int num) {
if (self.length <= num) {
return createSimilarArray(self, 0);
}
if (num <= 0) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, self.length - num);
System.arraycopy(self, 0, ret, 0, self.length - num);
return ret;
}
/**
* Returns the longest prefix of this list where each element
* passed to the given closure condition evaluates to true.
* Similar to {@link #takeWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original list.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ]
* assert nums.takeWhile{ it {@code <} 1 } == []
* assert nums.takeWhile{ it {@code <} 3 } == [ 1 ]
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 3, 2 ]
* </pre>
*
* @param self the original list
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given list where each element passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <T> List<T> takeWhile(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T value : self) {
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return take(self, num);
}
/**
* Returns a Collection containing the longest prefix of the elements from this Iterable
* where each element passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.takeWhile{ it {@code <} 'b' } == ['a']
* assert abc.takeWhile{ it {@code <=} 'b' } == ['a', 'b']
* </pre>
*
* @param self an Iterable
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a Collection containing a prefix of the elements from the given Iterable where
* each element passed to the given closure evaluates to true
* @since 1.8.7
*/
public static <T> Collection<T> takeWhile(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Collection<T> result = createSimilarCollection(self);
addAll(result, takeWhile(self.iterator(), condition));
return result;
}
/**
* Returns the longest prefix of this SortedSet where each element
* passed to the given closure condition evaluates to true.
* Similar to {@link #takeWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original SortedSet.
* <pre class="groovyTestCase">
* def nums = [ 1, 2, 3 ] as SortedSet
* assert nums.takeWhile{ it {@code <} 1 } == [] as SortedSet
* assert nums.takeWhile{ it {@code <} 2 } == [ 1 ] as SortedSet
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 2, 3 ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given SortedSet where each element passed to
* the given closure evaluates to true
* @since 2.4.0
*/
public static <T> SortedSet<T> takeWhile(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return (SortedSet<T>) takeWhile((Iterable<T>) self, condition);
}
/**
* Returns the longest prefix of this Map where each entry (or key/value pair) when
* passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* def shopping = [milk:1, bread:2, chocolate:3]
* assert shopping.takeWhile{ it.key.size() {@code <} 6 } == [milk:1, bread:2]
* assert shopping.takeWhile{ it.value % 2 } == [milk:1]
* assert shopping.takeWhile{ k, v {@code ->} k.size() + v {@code <=} 7 } == [milk:1, bread:2]
* </pre>
* If the map instance does not have ordered keys, then this function could appear to take random
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self a Map
* @param condition a 1 (or 2) arg Closure that must evaluate to true for the
* entry (or key and value) to continue taking elements
* @return a prefix of the given Map where each entry (or key/value pair) passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <K, V> Map<K, V> takeWhile(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
if (self.isEmpty()) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (!bcw.callForMap(entry)) break;
ret.put(entry.getKey(), entry.getValue());
}
return ret;
}
/**
* Returns the longest prefix of this array where each element
* passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ] as Integer[]
* assert nums.takeWhile{ it {@code <} 1 } == [] as Integer[]
* assert nums.takeWhile{ it {@code <} 3 } == [ 1 ] as Integer[]
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 3, 2 ] as Integer[]
* </pre>
*
* @param self the original array
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given array where each element passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <T> T[] takeWhile(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (num < self.length) {
T value = self[num];
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return take(self, num);
}
/**
* Returns the longest prefix of elements in this iterator where
* each element passed to the given condition closure evaluates to true.
* <p>
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ true }, next:{ a++ } ] as Iterator
*
* assert [].iterator().takeWhile{ it {@code <} 3 }.toList() == []
* assert [1, 2, 3, 4, 5].iterator().takeWhile{ it {@code <} 3 }.toList() == [ 1, 2 ]
* assert iter.takeWhile{ it {@code <} 5 }.toList() == [ 0, 1, 2, 3, 4 ]
* </pre>
*
* @param self the Iterator
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of elements in the given iterator where each
* element passed to the given closure evaluates to true
* @since 1.8.7
*/
public static <T> Iterator<T> takeWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return new TakeWhileIterator<>(self, condition);
}
private static final class TakeWhileIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final BooleanClosureWrapper condition;
private boolean exhausted;
private E next;
private TakeWhileIterator(Iterator<E> delegate, Closure condition) {
this.delegate = delegate;
this.condition = new BooleanClosureWrapper(condition);
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
exhausted = !delegate.hasNext();
if (!exhausted) {
next = delegate.next();
if (!condition.call(next)) {
exhausted = true;
next = null;
}
}
}
}
/**
* Returns a suffix of this SortedSet where elements are dropped from the front
* while the given Closure evaluates to true.
* Similar to {@link #dropWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original SortedSet.
* <pre class="groovyTestCase">
* def nums = [ 1, 2, 3 ] as SortedSet
* assert nums.dropWhile{ it {@code <} 4 } == [] as SortedSet
* assert nums.dropWhile{ it {@code <} 2 } == [ 2, 3 ] as SortedSet
* assert nums.dropWhile{ it != 3 } == [ 3 ] as SortedSet
* assert nums.dropWhile{ it == 0 } == [ 1, 2, 3 ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of the given SortedSet such that the given closure condition
* evaluates to true for each element dropped from the front of the SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> dropWhile(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return (SortedSet<T>) dropWhile((Iterable<T>) self, condition);
}
/**
* Returns a suffix of this List where elements are dropped from the front
* while the given Closure evaluates to true.
* Similar to {@link #dropWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original list.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ]
* assert nums.dropWhile{ it {@code <} 4 } == []
* assert nums.dropWhile{ it {@code <} 3 } == [ 3, 2 ]
* assert nums.dropWhile{ it != 2 } == [ 2 ]
* assert nums.dropWhile{ it == 0 } == [ 1, 3, 2 ]
* </pre>
*
* @param self the original list
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of the given List such that the given closure condition
* evaluates to true for each element dropped from the front of the List
* @since 1.8.7
*/
public static <T> List<T> dropWhile(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T value : self) {
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return drop(self, num);
}
/**
* Returns a suffix of this Iterable where elements are dropped from the front
* while the given closure evaluates to true.
* <pre class="groovyTestCase">
* class HorseIterable implements Iterable<String> {
* Iterator<String> iterator() { "horse".iterator() }
* }
* def horse = new HorseIterable()
* assert horse.dropWhile{ it {@code <} 'r' } == ['r', 's', 'e']
* assert horse.dropWhile{ it {@code <=} 'r' } == ['s', 'e']
* </pre>
*
* @param self an Iterable
* @param condition the closure that must evaluate to true to continue dropping elements
* @return a Collection containing the shortest suffix of the given Iterable such that the given closure condition
* evaluates to true for each element dropped from the front of the Iterable
* @since 1.8.7
*/
public static <T> Collection<T> dropWhile(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
Collection<T> result = createSimilarCollection(selfCol);
addAll(result, dropWhile(self.iterator(), condition));
return result;
}
/**
* Create a suffix of the given Map by dropping as many entries as possible from the
* front of the original Map such that calling the given closure condition evaluates to
* true when passed each of the dropped entries (or key/value pairs).
* <pre class="groovyTestCase">
* def shopping = [milk:1, bread:2, chocolate:3]
* assert shopping.dropWhile{ it.key.size() {@code <} 6 } == [chocolate:3]
* assert shopping.dropWhile{ it.value % 2 } == [bread:2, chocolate:3]
* assert shopping.dropWhile{ k, v {@code ->} k.size() + v {@code <=} 7 } == [chocolate:3]
* </pre>
* If the map instance does not have ordered keys, then this function could appear to drop random
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self a Map
* @param condition a 1 (or 2) arg Closure that must evaluate to true for the
* entry (or key and value) to continue dropping elements
* @return the shortest suffix of the given Map such that the given closure condition
* evaluates to true for each element dropped from the front of the Map
* @since 1.8.7
*/
public static <K, V> Map<K, V> dropWhile(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
if (self.isEmpty()) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
boolean dropping = true;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (dropping && !bcw.callForMap(entry)) dropping = false;
if (!dropping) ret.put(entry.getKey(), entry.getValue());
}
return ret;
}
/**
* Create a suffix of the given array by dropping as many elements as possible from the
* front of the original array such that calling the given closure condition evaluates to
* true when passed each of the dropped elements.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ] as Integer[]
* assert nums.dropWhile{ it {@code <=} 3 } == [ ] as Integer[]
* assert nums.dropWhile{ it {@code <} 3 } == [ 3, 2 ] as Integer[]
* assert nums.dropWhile{ it != 2 } == [ 2 ] as Integer[]
* assert nums.dropWhile{ it == 0 } == [ 1, 3, 2 ] as Integer[]
* </pre>
*
* @param self the original array
* @param condition the closure that must evaluate to true to
* continue dropping elements
* @return the shortest suffix of the given array such that the given closure condition
* evaluates to true for each element dropped from the front of the array
* @since 1.8.7
*/
public static <T> T[] dropWhile(T[] self, @ClosureParams(FirstParam.Component.class) Closure<?> condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (num < self.length) {
if (bcw.call(self[num])) {
num += 1;
} else {
break;
}
}
return drop(self, num);
}
/**
* Creates an Iterator that returns a suffix of the elements from an original Iterator. As many elements
* as possible are dropped from the front of the original Iterator such that calling the given closure
* condition evaluates to true when passed each of the dropped elements.
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ a {@code <} 10 }, next:{ a++ } ] as Iterator
* assert [].iterator().dropWhile{ it {@code <} 3 }.toList() == []
* assert [1, 2, 3, 4, 5].iterator().dropWhile{ it {@code <} 3 }.toList() == [ 3, 4, 5 ]
* assert iter.dropWhile{ it {@code <} 5 }.toList() == [ 5, 6, 7, 8, 9 ]
* </pre>
*
* @param self the Iterator
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of elements from the given Iterator such that the given closure condition
* evaluates to true for each element dropped from the front of the Iterator
* @since 1.8.7
*/
public static <T> Iterator<T> dropWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> condition) {
return new DropWhileIterator<>(self, condition);
}
private static final class DropWhileIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final Closure condition;
private boolean buffering = false;
private E buffer = null;
private DropWhileIterator(Iterator<E> delegate, Closure condition) {
this.delegate = delegate;
this.condition = condition;
prepare();
}
public boolean hasNext() {
return buffering || delegate.hasNext();
}
public E next() {
if (buffering) {
E result = buffer;
buffering = false;
buffer = null;
return result;
} else {
return delegate.next();
}
}
public void remove() {
if (buffering) {
buffering = false;
buffer = null;
} else {
delegate.remove();
}
}
private void prepare() {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (delegate.hasNext()) {
E next = delegate.next();
if (!bcw.call(next)) {
buffer = next;
buffering = true;
break;
}
}
}
}
/**
* Converts this Iterable to a Collection. Returns the original Iterable
* if it is already a Collection.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert new HashSet().asCollection() instanceof Collection
* </pre>
*
* @param self an Iterable to be converted into a Collection
* @return a newly created List if this Iterable is not already a Collection
* @since 2.4.0
*/
public static <T> Collection<T> asCollection(Iterable<T> self) {
if (self instanceof Collection) {
return (Collection<T>) self;
} else {
return toList(self);
}
}
/**
* @deprecated Use the Iterable version of asList instead
* @see #asList(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> List<T> asList(Collection<T> self) {
return asList((Iterable<T>)self);
}
/**
* Converts this Iterable to a List. Returns the original Iterable
* if it is already a List.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert new HashSet().asList() instanceof List
* </pre>
*
* @param self an Iterable to be converted into a List
* @return a newly created List if this Iterable is not already a List
* @since 2.2.0
*/
public static <T> List<T> asList(Iterable<T> self) {
if (self instanceof List) {
return (List<T>) self;
} else {
return toList(self);
}
}
/**
* Coerce an object instance to a boolean value.
* An object is coerced to true if it's not null, to false if it is null.
*
* @param object the object to coerce
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Object object) {
return object != null;
}
/**
* Coerce a Boolean instance to a boolean value.
*
* @param bool the Boolean
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Boolean bool) {
if (null == bool) {
return false;
}
return bool;
}
/**
* Coerce a collection instance to a boolean value.
* A collection is coerced to false if it's empty, and to true otherwise.
* <pre class="groovyTestCase">assert [1,2].asBoolean() == true</pre>
* <pre class="groovyTestCase">assert [].asBoolean() == false</pre>
*
* @param collection the collection
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Collection collection) {
if (null == collection) {
return false;
}
return !collection.isEmpty();
}
/**
* Coerce a map instance to a boolean value.
* A map is coerced to false if it's empty, and to true otherwise.
* <pre class="groovyTestCase">assert [:] as Boolean == false
* assert [a:2] as Boolean == true</pre>
*
* @param map the map
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Map map) {
if (null == map) {
return false;
}
return !map.isEmpty();
}
/**
* Coerce an iterator instance to a boolean value.
* An iterator is coerced to false if there are no more elements to iterate over,
* and to true otherwise.
*
* @param iterator the iterator
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Iterator iterator) {
if (null == iterator) {
return false;
}
return iterator.hasNext();
}
/**
* Coerce an enumeration instance to a boolean value.
* An enumeration is coerced to false if there are no more elements to enumerate,
* and to true otherwise.
*
* @param enumeration the enumeration
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Enumeration enumeration) {
if (null == enumeration) {
return false;
}
return enumeration.hasMoreElements();
}
/**
* Coerce an Object array to a boolean value.
* An Object array is false if the array is of length 0.
* and to true otherwise
*
* @param array the array
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Object[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a byte array to a boolean value.
* A byte array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(byte[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a short array to a boolean value.
* A short array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(short[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces an int array to a boolean value.
* An int array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(int[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a long array to a boolean value.
* A long array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(long[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a float array to a boolean value.
* A float array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(float[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a double array to a boolean value.
* A double array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(double[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a boolean array to a boolean value.
* A boolean array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(boolean[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a char array to a boolean value.
* A char array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(char[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerce a character to a boolean value.
* A character is coerced to false if it's character value is equal to 0,
* and to true otherwise.
*
* @param character the character
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Character character) {
if (null == character) {
return false;
}
return character != 0;
}
/**
* Coerce a Float instance to a boolean value.
*
* @param object the Float
* @return {@code true} for non-zero and non-NaN values, else {@code false}
* @since 2.6.0
*/
public static boolean asBoolean(Float object) {
float f = object;
return f != 0.0f && !Float.isNaN(f);
}
/**
* Coerce a Double instance to a boolean value.
*
* @param object the Double
* @return {@code true} for non-zero and non-NaN values, else {@code false}
* @since 2.6.0
*/
public static boolean asBoolean(Double object) {
double d = object;
return d != 0.0d && !Double.isNaN(d);
}
/**
* Coerce a number to a boolean value.
* A number is coerced to false if its double value is equal to 0, and to true otherwise.
*
* @param number the number
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Number number) {
if (null == number) {
return false;
}
return number.doubleValue() != 0;
}
/**
* Converts the given iterable to another type.
*
* @param iterable a Iterable
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(Collection, Class)
* @since 2.4.12
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Iterable iterable, Class<T> clazz) {
if (Collection.class.isAssignableFrom(clazz)) {
return asType((Collection) toList(iterable), clazz);
}
return asType((Object) iterable, clazz);
}
/**
* Converts the given collection to another type. A default concrete
* type is used for List, Set, or SortedSet. If the given type has
* a constructor taking a collection, that is used. Otherwise, the
* call is deferred to {@link #asType(Object,Class)}. If this
* collection is already of the given type, the same instance is
* returned.
*
* @param col a collection
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(java.lang.Object, java.lang.Class)
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Collection col, Class<T> clazz) {
if (col.getClass() == clazz) {
return (T) col;
}
if (clazz == List.class) {
return (T) asList((Iterable) col);
}
if (clazz == Set.class) {
if (col instanceof Set) return (T) col;
return (T) new LinkedHashSet(col);
}
if (clazz == SortedSet.class) {
if (col instanceof SortedSet) return (T) col;
return (T) new TreeSet(col);
}
if (clazz == Queue.class) {
if (col instanceof Queue) return (T) col;
return (T) new LinkedList(col);
}
if (clazz == Stack.class) {
if (col instanceof Stack) return (T) col;
final Stack stack = new Stack();
stack.addAll(col);
return (T) stack;
}
if (clazz!=String[].class && ReflectionCache.isArray(clazz)) {
try {
return (T) asArrayType(col, clazz);
} catch (GroovyCastException e) {
/* ignore */
}
}
Object[] args = {col};
try {
return (T) InvokerHelper.invokeConstructorOf(clazz, args);
} catch (Exception e) {
// ignore, the constructor that takes a Collection as an argument may not exist
}
if (Collection.class.isAssignableFrom(clazz)) {
try {
Collection result = (Collection) InvokerHelper.invokeConstructorOf(clazz, null);
result.addAll(col);
return (T)result;
} catch (Exception e) {
// ignore, the no arg constructor might not exist.
}
}
return asType((Object) col, clazz);
}
/**
* Converts the given array to either a List, Set, or
* SortedSet. If the given class is something else, the
* call is deferred to {@link #asType(Object,Class)}.
*
* @param ary an array
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(java.lang.Object, java.lang.Class)
* @since 1.5.1
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Object[] ary, Class<T> clazz) {
if (clazz == List.class) {
return (T) new ArrayList(Arrays.asList(ary));
}
if (clazz == Set.class) {
return (T) new HashSet(Arrays.asList(ary));
}
if (clazz == SortedSet.class) {
return (T) new TreeSet(Arrays.asList(ary));
}
return asType((Object) ary, clazz);
}
/**
* Coerces the closure to an implementation of the given class. The class
* is assumed to be an interface or class with a single method definition.
* The closure is used as the implementation of that single method.
*
* @param cl the implementation of the single method
* @param clazz the target type
* @return a Proxy of the given type which wraps this closure.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Closure cl, Class<T> clazz) {
if (clazz.isInterface() && !(clazz.isInstance(cl))) {
if (Traits.isTrait(clazz)) {
Method samMethod = CachedSAMClass.getSAMMethod(clazz);
if (samMethod!=null) {
Map impl = Collections.singletonMap(samMethod.getName(),cl);
return (T) ProxyGenerator.INSTANCE.instantiateAggregate(impl, Collections.singletonList(clazz));
}
}
return (T) Proxy.newProxyInstance(
clazz.getClassLoader(),
new Class[]{clazz},
new ConvertedClosure(cl));
}
try {
return asType((Object) cl, clazz);
} catch (GroovyCastException ce) {
try {
return (T) ProxyGenerator.INSTANCE.instantiateAggregateFromBaseClass(cl, clazz);
} catch (GroovyRuntimeException cause) {
throw new GroovyCastException("Error casting closure to " + clazz.getName() +
", Reason: " + cause.getMessage());
}
}
}
/**
* Coerces this map to the given type, using the map's keys as the public
* method names, and values as the implementation. Typically the value
* would be a closure which behaves like the method implementation.
*
* @param map this map
* @param clazz the target type
* @return a Proxy of the given type, which defers calls to this map's elements.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Map map, Class<T> clazz) {
if (!(clazz.isInstance(map)) && clazz.isInterface() && !Traits.isTrait(clazz)) {
return (T) Proxy.newProxyInstance(
clazz.getClassLoader(),
new Class[]{clazz},
new ConvertedMap(map));
}
try {
return asType((Object) map, clazz);
} catch (GroovyCastException ce) {
try {
return (T) ProxyGenerator.INSTANCE.instantiateAggregateFromBaseClass(map, clazz);
} catch (GroovyRuntimeException cause) {
throw new GroovyCastException("Error casting map to " + clazz.getName() +
", Reason: " + cause.getMessage());
}
}
}
/**
* Randomly reorders the elements of the specified list.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* def origSize = list.size()
* def origCopy = new ArrayList(list)
* list.shuffle()
* assert list.size() == origSize
* assert origCopy.every{ list.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static void shuffle(List<?> self) {
Collections.shuffle(self);
}
/**
* Randomly reorders the elements of the specified list using the
* specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* def list = ["a", 4, false]
* def origSize = list.size()
* def origCopy = new ArrayList(list)
* list.shuffle(r)
* assert list.size() == origSize
* assert origCopy.every{ list.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static void shuffle(List<?> self, Random rnd) {
Collections.shuffle(self, rnd);
}
/**
* Creates a new list containing the elements of the specified list
* but in a random order.
* <pre class="groovyTestCase">
* def orig = ["a", 4, false]
* def shuffled = orig.shuffled()
* assert orig.size() == shuffled.size()
* assert orig.every{ shuffled.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static <T> List<T> shuffled(List<T> self) {
List<T> copy = new ArrayList(self);
Collections.shuffle(copy);
return copy;
}
/**
* Creates a new list containing the elements of the specified list but in a random
* order using the specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* def orig = ["a", 4, false]
* def shuffled = orig.shuffled(r)
* assert orig.size() == shuffled.size()
* assert orig.every{ shuffled.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static <T> List<T> shuffled(List<T> self, Random rnd) {
List<T> copy = new ArrayList(self);
Collections.shuffle(copy, rnd);
return copy;
}
/**
* Randomly reorders the elements of the specified array.
* <pre class="groovyTestCase">
* Integer[] array = [10, 5, 20]
* def origSize = array.size()
* def items = array.toList()
* array.shuffle()
* assert array.size() == origSize
* assert items.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @since 3.0.0
*/
public static <T> void shuffle(T[] self) {
Random rnd = r;
if (rnd == null)
r = rnd = new Random(); // harmless race.
shuffle(self, rnd);
}
private static Random r;
/**
* Randomly reorders the elements of the specified array using the
* specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* Integer[] array = [10, 5, 20]
* def origSize = array.size()
* def items = array.toList()
* array.shuffle(r)
* assert array.size() == origSize
* assert items.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @since 3.0.0
*/
public static <T> void shuffle(T[] self, Random rnd) {
for (int i = 0; i < self.length-1; i++) {
int nextIndex = rnd.nextInt(self.length);
T tmp = self[i];
self[i] = self[nextIndex];
self[nextIndex] = tmp;
}
}
/**
* Creates a new array containing the elements of the specified array but in a random order.
* <pre class="groovyTestCase">
* Integer[] orig = [10, 5, 20]
* def array = orig.shuffled()
* assert orig.size() == array.size()
* assert orig.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @return the shuffled array
* @since 3.0.0
*/
public static <T> T[] shuffled(T[] self) {
Random rnd = r;
if (rnd == null)
r = rnd = new Random(); // harmless race.
return shuffled(self, rnd);
}
/**
* Creates a new array containing the elements of the specified array but in a random
* order using the specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* Integer[] orig = [10, 5, 20]
* def array = orig.shuffled(r)
* assert orig.size() == array.size()
* assert orig.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @return the shuffled array
* @since 3.0.0
*/
public static <T> T[] shuffled(T[] self, Random rnd) {
T[] result = self.clone();
List<T> items = Arrays.asList(self);
Collections.shuffle(items, rnd);
System.arraycopy(items.toArray(), 0, result, 0, items.size());
return result;
}
/**
* Creates a new List with the identical contents to this list
* but in reverse order.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* assert list.reverse() == [false, 4, "a"]
* assert list == ["a", 4, false]
* </pre>
*
* @param self a List
* @return a reversed List
* @see #reverse(List, boolean)
* @since 1.0
*/
public static <T> List<T> reverse(List<T> self) {
return reverse(self, false);
}
/**
* Reverses the elements in a list. If mutate is true, the original list is modified in place and returned.
* Otherwise, a new list containing the reversed items is produced.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* assert list.reverse(false) == [false, 4, "a"]
* assert list == ["a", 4, false]
* assert list.reverse(true) == [false, 4, "a"]
* assert list == [false, 4, "a"]
* </pre>
*
* @param self a List
* @param mutate true if the list itself should be reversed in place and returned, false if a new list should be created
* @return a reversed List
* @since 1.8.1
*/
public static <T> List<T> reverse(List<T> self, boolean mutate) {
if (mutate) {
Collections.reverse(self);
return self;
}
int size = self.size();
List<T> answer = new ArrayList<>(size);
ListIterator<T> iter = self.listIterator(size);
while (iter.hasPrevious()) {
answer.add(iter.previous());
}
return answer;
}
/**
* Creates a new array containing items which are the same as this array but in reverse order.
*
* @param self an array
* @return an array containing the reversed items
* @see #reverse(Object[], boolean)
* @since 1.5.5
*/
public static <T> T[] reverse(T[] self) {
return reverse(self, false);
}
/**
* Reverse the items in an array. If mutate is true, the original array is modified in place and returned.
* Otherwise, a new array containing the reversed items is produced.
*
* @param self an array
* @param mutate true if the array itself should be reversed in place and returned, false if a new array should be created
* @return an array containing the reversed items
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T> T[] reverse(T[] self, boolean mutate) {
if (!mutate) {
return (T[]) toList(new ReverseListIterator<>(Arrays.asList(self))).toArray();
}
List<T> items = Arrays.asList(self);
Collections.reverse(items);
System.arraycopy(items.toArray(), 0, self, 0, items.size());
return self;
}
/**
* Reverses the iterator. The original iterator will become
* exhausted of elements after determining the reversed values.
* A new iterator for iterating through the reversed values is returned.
*
* @param self an Iterator
* @return a reversed Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> reverse(Iterator<T> self) {
return new ReverseListIterator<>(toList(self));
}
/**
* Create an array as a union of two arrays.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* Integer[] b = [4, 5, 6]
* assert a + b == [1, 2, 3, 4, 5, 6] as Integer[]
* </pre>
*
* @param left the left Array
* @param right the right Array
* @return A new array containing right appended to left.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, T[] right) {
return (T[]) plus((List<T>) toList(left), toList(right)).toArray();
}
/**
* Create an array containing elements from an original array plus an additional appended element.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* Integer[] result = a + 4
* assert result == [1, 2, 3, 4] as Integer[]
* </pre>
*
* @param left the array
* @param right the value to append
* @return A new array containing left with right appended to it.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, T right) {
return (T[]) plus(toList(left), right).toArray();
}
/**
* Create an array containing elements from an original array plus those from a Collection.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* def additions = [7, 8]
* assert a + additions == [1, 2, 3, 7, 8] as Integer[]
* </pre>
*
* @param left the array
* @param right a Collection to be appended
* @return A new array containing left with right appended to it.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, Collection<T> right) {
return (T[]) plus((List<T>) toList(left), right).toArray();
}
/**
* Create an array containing elements from an original array plus those from an Iterable.
* <pre class="groovyTestCase">
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* String[] letters = ['x', 'y', 'z']
* def result = letters + new AbcIterable()
* assert result == ['x', 'y', 'z', 'a', 'b', 'c'] as String[]
* assert result.class.array
* </pre>
*
* @param left the array
* @param right an Iterable to be appended
* @return A new array containing elements from left with those from right appended.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, Iterable<T> right) {
return (T[]) plus((List<T>) toList(left), toList(right)).toArray();
}
/**
* Create a Collection as a union of two collections. If the left collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3,4] == [1,2] + [3,4]</pre>
*
* @param left the left Collection
* @param right the right Collection
* @return the merged Collection
* @since 1.5.0
*/
public static <T> Collection<T> plus(Collection<T> left, Collection<T> right) {
final Collection<T> answer = cloneSimilarCollection(left, left.size() + right.size());
answer.addAll(right);
return answer;
}
/**
* Create a Collection as a union of two iterables. If the left iterable
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3,4] == [1,2] + [3,4]</pre>
*
* @param left the left Iterable
* @param right the right Iterable
* @return the merged Collection
* @since 2.4.0
*/
public static <T> Collection<T> plus(Iterable<T> left, Iterable<T> right) {
return plus(asCollection(left), asCollection(right));
}
/**
* Create a Collection as a union of a Collection and an Iterable. If the left collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Collection
* @param right the right Iterable
* @return the merged Collection
* @since 1.8.7
* @see #plus(Collection, Collection)
*/
public static <T> Collection<T> plus(Collection<T> left, Iterable<T> right) {
return plus(left, asCollection(right));
}
/**
* Create a List as a union of a List and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left List
* @param right the right Iterable
* @return the merged List
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> List<T> plus(List<T> left, Iterable<T> right) {
return (List<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a List as a union of a List and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left List
* @param right the right Collection
* @return the merged List
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> List<T> plus(List<T> left, Collection<T> right) {
return (List<T>) plus((Collection<T>) left, right);
}
/**
* Create a Set as a union of a Set and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Set
* @param right the right Iterable
* @return the merged Set
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> Set<T> plus(Set<T> left, Iterable<T> right) {
return (Set<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a Set as a union of a Set and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Set
* @param right the right Collection
* @return the merged Set
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> Set<T> plus(Set<T> left, Collection<T> right) {
return (Set<T>) plus((Collection<T>) left, right);
}
/**
* Create a SortedSet as a union of a SortedSet and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left SortedSet
* @param right the right Iterable
* @return the merged SortedSet
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, Iterable<T> right) {
return (SortedSet<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a SortedSet as a union of a SortedSet and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left SortedSet
* @param right the right Collection
* @return the merged SortedSet
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, Collection<T> right) {
return (SortedSet<T>) plus((Collection<T>) left, right);
}
/**
* Creates a new List by inserting all of the elements in the specified array
* to the elements from the original List at the specified index.
* Shifts the element currently at that index (if any) and any subsequent
* elements to the right (increasing their indices).
* The new elements will appear in the resulting List in the order that
* they occur in the original array.
* The behavior of this operation is undefined if the list or
* array operands are modified while the operation is in progress.
* The original list and array operands remain unchanged.
*
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def newItems = items.plus(2, 'a'..'c' as String[])
* assert newItems == [1, 2, 'a', 'b', 'c', 3]
* assert items == [1, 2, 3]
* </pre>
*
* See also <code>addAll</code> for similar functionality with modify semantics, i.e. which performs
* the changes on the original list itself.
*
* @param self an original list
* @param items array containing elements to be merged with elements from the original list
* @param index index at which to insert the first element from the specified array
* @return the new list
* @see #plus(List, int, List)
* @since 1.8.1
*/
public static <T> List<T> plus(List<T> self, int index, T[] items) {
return plus(self, index, Arrays.asList(items));
}
/**
* Creates a new List by inserting all of the elements in the given additions List
* to the elements from the original List at the specified index.
* Shifts the element currently at that index (if any) and any subsequent
* elements to the right (increasing their indices). The new elements
* will appear in the resulting List in the order that they occur in the original lists.
* The behavior of this operation is undefined if the original lists
* are modified while the operation is in progress. The original lists remain unchanged.
*
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def newItems = items.plus(2, 'a'..'c')
* assert newItems == [1, 2, 'a', 'b', 'c', 3]
* assert items == [1, 2, 3]
* </pre>
*
* See also <code>addAll</code> for similar functionality with modify semantics, i.e. which performs
* the changes on the original list itself.
*
* @param self an original List
* @param additions a List containing elements to be merged with elements from the original List
* @param index index at which to insert the first element from the given additions List
* @return the new list
* @since 1.8.1
*/
public static <T> List<T> plus(List<T> self, int index, List<T> additions) {
final List<T> answer = new ArrayList<>(self);
answer.addAll(index, additions);
return answer;
}
/**
* Creates a new List by inserting all of the elements in the given Iterable
* to the elements from this List at the specified index.
*
* @param self an original list
* @param additions an Iterable containing elements to be merged with the elements from the original List
* @param index index at which to insert the first element from the given additions Iterable
* @return the new list
* @since 1.8.7
* @see #plus(List, int, List)
*/
public static <T> List<T> plus(List<T> self, int index, Iterable<T> additions) {
return plus(self, index, toList(additions));
}
/**
* Create a collection as a union of a Collection and an Object. If the collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a Collection
* @param right an object to add/append
* @return the resulting Collection
* @since 1.5.0
*/
public static <T> Collection<T> plus(Collection<T> left, T right) {
final Collection<T> answer = cloneSimilarCollection(left, left.size() + 1);
answer.add(right);
return answer;
}
/**
* Create a collection as a union of an Iterable and an Object. If the iterable
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left an Iterable
* @param right an object to add/append
* @return the resulting Collection
* @since 2.4.0
*/
public static <T> Collection<T> plus(Iterable<T> left, T right) {
return plus(asCollection(left), right);
}
/**
* Create a List as a union of a List and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a List
* @param right an object to add/append
* @return the resulting List
* @since 2.4.0
*/
public static <T> List<T> plus(List<T> left, T right) {
return (List<T>) plus((Collection<T>) left, right);
}
/**
* Create a Set as a union of a Set and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a Set
* @param right an object to add/append
* @return the resulting Set
* @since 2.4.0
*/
public static <T> Set<T> plus(Set<T> left, T right) {
return (Set<T>) plus((Collection<T>) left, right);
}
/**
* Create a SortedSet as a union of a SortedSet and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a SortedSet
* @param right an object to add/append
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, T right) {
return (SortedSet<T>) plus((Collection<T>) left, right);
}
/**
* @deprecated use the Iterable variant instead
* @see #multiply(Iterable, Number)
* @since 1.0
*/
@Deprecated
public static <T> Collection<T> multiply(Collection<T> self, Number factor) {
return multiply((Iterable<T>) self, factor);
}
/**
* Create a Collection composed of the elements of this Iterable, repeated
* a certain number of times. Note that for non-primitive
* elements, multiple references to the same instance will be added.
* <pre class="groovyTestCase">assert [1,2,3,1,2,3] == [1,2,3] * 2</pre>
*
* Note: if the Iterable happens to not support duplicates, e.g. a Set, then the
* method will effectively return a Collection with a single copy of the Iterable's items.
*
* @param self an Iterable
* @param factor the number of times to append
* @return the multiplied Collection
* @since 2.4.0
*/
public static <T> Collection<T> multiply(Iterable<T> self, Number factor) {
Collection<T> selfCol = asCollection(self);
int size = factor.intValue();
Collection<T> answer = createSimilarCollection(selfCol, selfCol.size() * size);
for (int i = 0; i < size; i++) {
answer.addAll(selfCol);
}
return answer;
}
/**
* Create a List composed of the elements of this Iterable, repeated
* a certain number of times. Note that for non-primitive
* elements, multiple references to the same instance will be added.
* <pre class="groovyTestCase">assert [1,2,3,1,2,3] == [1,2,3] * 2</pre>
*
* Note: if the Iterable happens to not support duplicates, e.g. a Set, then the
* method will effectively return a Collection with a single copy of the Iterable's items.
*
* @param self a List
* @param factor the number of times to append
* @return the multiplied List
* @since 2.4.0
*/
public static <T> List<T> multiply(List<T> self, Number factor) {
return (List<T>) multiply((Iterable<T>) self, factor);
}
/**
* Create a Collection composed of the intersection of both collections. Any
* elements that exist in both collections are added to the resultant collection.
* For collections of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a Collection
* @param right a Collection
* @return a Collection as an intersection of both collections
* @see #intersect(Collection, Collection, Comparator)
* @since 1.5.6
*/
public static <T> Collection<T> intersect(Collection<T> left, Collection<T> right) {
return intersect(left, right, new NumberAwareComparator<>());
}
/**
* Create a Collection composed of the intersection of both collections. Any
* elements that exist in both collections are added to the resultant collection.
* For collections of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">
* assert [3,4] == [1,2,3,4].intersect([3,4,5,6], Comparator.naturalOrder())
* </pre>
* <pre class="groovyTestCase">
* def one = ['a', 'B', 'c', 'd']
* def two = ['b', 'C', 'd', 'e']
* def compareIgnoreCase = { a, b {@code ->} a.toLowerCase() {@code <=>} b.toLowerCase() }
* assert one.intersect(two) == ['d']
* assert two.intersect(one) == ['d']
* assert one.intersect(two, compareIgnoreCase) == ['b', 'C', 'd']
* assert two.intersect(one, compareIgnoreCase) == ['B', 'c', 'd']
* </pre>
*
* @param left a Collection
* @param right a Collection
* @param comparator a Comparator
* @return a Collection as an intersection of both collections
* @since 2.5.0
*/
public static <T> Collection<T> intersect(Collection<T> left, Collection<T> right, Comparator<T> comparator) {
if (left.isEmpty() || right.isEmpty())
return createSimilarCollection(left, 0);
Collection<T> result = createSimilarCollection(left, Math.min(left.size(), right.size()));
//creates the collection to look for values.
Collection<T> pickFrom = new TreeSet<>(comparator);
pickFrom.addAll(left);
for (final T t : right) {
if (pickFrom.contains(t))
result.add(t);
}
return result;
}
/**
* Create a Collection composed of the intersection of both iterables. Any
* elements that exist in both iterables are added to the resultant collection.
* For iterables of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left an Iterable
* @param right an Iterable
* @return a Collection as an intersection of both iterables
* @see #intersect(Iterable, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Collection<T> intersect(Iterable<T> left, Iterable<T> right) {
return intersect(asCollection(left), asCollection(right));
}
/**
* Create a Collection composed of the intersection of both iterables. Any
* elements that exist in both iterables are added to the resultant collection.
* For iterables of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [3,4] == [1,2,3,4].intersect([3,4,5,6], Comparator.naturalOrder())</pre>
*
* @param left an Iterable
* @param right an Iterable
* @param comparator a Comparator
* @return a Collection as an intersection of both iterables
* @since 2.5.0
*/
public static <T> Collection<T> intersect(Iterable<T> left, Iterable<T> right, Comparator<T> comparator) {
return intersect(asCollection(left), asCollection(right), comparator);
}
/**
* Create a List composed of the intersection of a List and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a List
* @param right an Iterable
* @return a List as an intersection of a List and an Iterable
* @see #intersect(List, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> intersect(List<T> left, Iterable<T> right) {
return (List<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a List composed of the intersection of a List and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [3,4] == [1,2,3,4].intersect([3,4,5,6])</pre>
*
* @param left a List
* @param right an Iterable
* @param comparator a Comparator
* @return a List as an intersection of a List and an Iterable
* @since 2.5.0
*/
public static <T> List<T> intersect(List<T> left, Iterable<T> right, Comparator<T> comparator) {
return (List<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a Set composed of the intersection of a Set and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as Set == ([1,2,3,4,5] as Set).intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a Set
* @param right an Iterable
* @return a Set as an intersection of a Set and an Iterable
* @see #intersect(Set, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Set<T> intersect(Set<T> left, Iterable<T> right) {
return (Set<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a Set composed of the intersection of a Set and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [3,4] as Set == ([1,2,3,4] as Set).intersect([3,4,5,6], Comparator.naturalOrder())</pre>
*
* @param left a Set
* @param right an Iterable
* @param comparator a Comparator
* @return a Set as an intersection of a Set and an Iterable
* @since 2.5.0
*/
public static <T> Set<T> intersect(Set<T> left, Iterable<T> right, Comparator<T> comparator) {
return (Set<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a SortedSet composed of the intersection of a SortedSet and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as SortedSet == ([1,2,3,4,5] as SortedSet).intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a SortedSet
* @param right an Iterable
* @return a Set as an intersection of a SortedSet and an Iterable
* @see #intersect(SortedSet, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> SortedSet<T> intersect(SortedSet<T> left, Iterable<T> right) {
return (SortedSet<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a SortedSet composed of the intersection of a SortedSet and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as SortedSet == ([1,2,3,4,5] as SortedSet).intersect([4,5,6,7,8])</pre>
*
* @param left a SortedSet
* @param right an Iterable
* @param comparator a Comparator
* @return a Set as an intersection of a SortedSet and an Iterable
* @since 2.5.0
*/
public static <T> SortedSet<T> intersect(SortedSet<T> left, Iterable<T> right, Comparator<T> comparator) {
return (SortedSet<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a Map composed of the intersection of both maps.
* Any entries that exist in both maps are added to the resultant map.
* <pre class="groovyTestCase">assert [4:4,5:5] == [1:1,2:2,3:3,4:4,5:5].intersect([4:4,5:5,6:6,7:7,8:8])</pre>
* <pre class="groovyTestCase">assert [1: 1, 2: 2, 3: 3, 4: 4].intersect( [1: 1.0, 2: 2, 5: 5] ) == [1:1, 2:2]</pre>
*
* @param left a map
* @param right a map
* @return a Map as an intersection of both maps
* @since 1.7.4
*/
public static <K,V> Map<K,V> intersect(Map<K,V> left, Map<K,V> right) {
final Map<K,V> ansMap = createSimilarMap(left);
if (right != null && !right.isEmpty()) {
for (Map.Entry<K, V> e1 : left.entrySet()) {
for (Map.Entry<K, V> e2 : right.entrySet()) {
if (DefaultTypeTransformation.compareEqual(e1, e2)) {
ansMap.put(e1.getKey(), e1.getValue());
}
}
}
}
return ansMap;
}
/**
* Returns <code>true</code> if the intersection of two iterables is empty.
* <pre class="groovyTestCase">assert [1,2,3].disjoint([3,4,5]) == false</pre>
* <pre class="groovyTestCase">assert [1,2].disjoint([3,4]) == true</pre>
*
* @param left an Iterable
* @param right an Iterable
* @return boolean <code>true</code> if the intersection of two iterables
* is empty, <code>false</code> otherwise.
* @since 2.4.0
*/
public static boolean disjoint(Iterable left, Iterable right) {
Collection leftCol = asCollection(left);
Collection rightCol = asCollection(right);
if (leftCol.isEmpty() || rightCol.isEmpty())
return true;
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(rightCol);
for (final Object o : leftCol) {
if (pickFrom.contains(o))
return false;
}
return true;
}
/**
* @deprecated use the Iterable variant instead
* @see #disjoint(Iterable, Iterable)
* @since 1.0
*/
@Deprecated
public static boolean disjoint(Collection left, Collection right) {
return disjoint(left, right);
}
/**
* Chops the array into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the array isn't large enough, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the array.
*
* @param self an Array to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original array elements into pieces determined by chopSizes
* @see #collate(Object[], int) to chop a list into pieces of a fixed size
* @since 2.5.2
*/
public static <T> List<List<T>> chop(T[] self, int... chopSizes) {
return chop(Arrays.asList(self), chopSizes);
}
/**
* Chops the Iterable into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the Iterable isn't large enough, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the Iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].chop(1) == [[1]]
* assert [1, 2, 3, 4].chop(1,-1) == [[1], [2, 3, 4]]
* assert ('a'..'h').chop(2, 4) == [['a', 'b'], ['c', 'd', 'e', 'f']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(3) == [['a', 'b', 'c']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(1, 2, 3) == [['a'], ['b', 'c'], ['d', 'e']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(1, 2, 3, 3, 3) == [['a'], ['b', 'c'], ['d', 'e'], [], []]
* </pre>
*
* @param self an Iterable to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original iterable into pieces determined by chopSizes
* @see #collate(Iterable, int) to chop an Iterable into pieces of a fixed size
* @since 2.5.2
*/
public static <T> List<List<T>> chop(Iterable<T> self, int... chopSizes) {
return chop(self.iterator(), chopSizes);
}
/**
* Chops the iterator items into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the iterator is exhausted early, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the iterator.
*
* @param self an Iterator to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original iterator elements into pieces determined by chopSizes
* @since 2.5.2
*/
public static <T> List<List<T>> chop(Iterator<T> self, int... chopSizes) {
List<List<T>> result = new ArrayList<>();
for (int nextSize : chopSizes) {
int size = nextSize;
List<T> next = new ArrayList<>();
while (size-- != 0 && self.hasNext()) {
next.add(self.next());
}
result.add(next);
}
return result;
}
/**
* Compare the contents of this array to the contents of the given array.
*
* @param left an int array
* @param right the array being compared
* @return true if the contents of both arrays are equal.
* @since 1.5.0
*/
public static boolean equals(int[] left, int[] right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left == right) {
return true;
}
if (left.length != right.length) {
return false;
}
for (int i = 0; i < left.length; i++) {
if (left[i] != right[i]) return false;
}
return true;
}
/**
* Determines if the contents of this array are equal to the
* contents of the given list, in the same order. This returns
* <code>false</code> if either collection is <code>null</code>.
*
* @param left an array
* @param right the List being compared
* @return true if the contents of both collections are equal
* @since 1.5.0
*/
public static boolean equals(Object[] left, List right) {
return coercedEquals(left, right);
}
/**
* Determines if the contents of this list are equal to the
* contents of the given array in the same order. This returns
* <code>false</code> if either collection is <code>null</code>.
* <pre class="groovyTestCase">assert [1, "a"].equals( [ 1, "a" ] as Object[] )</pre>
*
* @param left a List
* @param right the Object[] being compared to
* @return true if the contents of both collections are equal
* @since 1.5.0
*/
public static boolean equals(List left, Object[] right) {
return coercedEquals(right, left);
}
private static boolean coercedEquals(Object[] left, List right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left.length != right.size()) {
return false;
}
for (int i = left.length - 1; i >= 0; i--) {
final Object o1 = left[i];
final Object o2 = right.get(i);
if (o1 == null) {
if (o2 != null) return false;
} else if (!coercedEquals(o1, o2)) {
return false;
}
}
return true;
}
private static boolean coercedEquals(Object o1, Object o2) {
if (o1 instanceof Comparable) {
if (!(o2 instanceof Comparable && numberAwareCompareTo((Comparable) o1, (Comparable) o2) == 0)) {
return false;
}
}
return DefaultTypeTransformation.compareEqual(o1, o2);
}
/**
* Compare the contents of two Lists. Order matters.
* If numbers exist in the Lists, then they are compared as numbers,
* for example 2 == 2L. If both lists are <code>null</code>, the result
* is true; otherwise if either list is <code>null</code>, the result
* is <code>false</code>.
* <pre class="groovyTestCase">assert ["a", 2].equals(["a", 2])
* assert ![2, "a"].equals("a", 2)
* assert [2.0, "a"].equals(2L, "a") // number comparison at work</pre>
*
* @param left a List
* @param right the List being compared to
* @return boolean <code>true</code> if the contents of both lists are identical,
* <code>false</code> otherwise.
* @since 1.0
*/
public static boolean equals(List left, List right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left == right) {
return true;
}
if (left.size() != right.size()) {
return false;
}
final Iterator it1 = left.iterator(), it2 = right.iterator();
while (it1.hasNext()) {
final Object o1 = it1.next();
final Object o2 = it2.next();
if (o1 == null) {
if (o2 != null) return false;
} else if (!coercedEquals(o1, o2)) {
return false;
}
}
return true;
}
/**
* Compare the contents of two Sets for equality using Groovy's coercion rules.
* <p>
* Returns <tt>true</tt> if the two sets have the same size, and every member
* of the specified set is contained in this set (or equivalently, every member
* of this set is contained in the specified set).
* If numbers exist in the sets, then they are compared as numbers,
* for example 2 == 2L. If both sets are <code>null</code>, the result
* is true; otherwise if either set is <code>null</code>, the result
* is <code>false</code>. Example usage:
* <pre class="groovyTestCase">
* Set s1 = ["a", 2]
* def s2 = [2, 'a'] as Set
* Set s3 = [3, 'a']
* def s4 = [2.0, 'a'] as Set
* def s5 = [2L, 'a'] as Set
* assert s1.equals(s2)
* assert !s1.equals(s3)
* assert s1.equals(s4)
* assert s1.equals(s5)</pre>
*
* @param self a Set
* @param other the Set being compared to
* @return <tt>true</tt> if the contents of both sets are identical
* @since 1.8.0
*/
public static <T> boolean equals(Set<T> self, Set<T> other) {
if (self == null) {
return other == null;
}
if (other == null) {
return false;
}
if (self == other) {
return true;
}
if (self.size() != other.size()) {
return false;
}
final Iterator<T> it1 = self.iterator();
Collection<T> otherItems = new HashSet<>(other);
while (it1.hasNext()) {
final Object o1 = it1.next();
final Iterator<T> it2 = otherItems.iterator();
T foundItem = null;
boolean found = false;
while (it2.hasNext() && foundItem == null) {
final T o2 = it2.next();
if (coercedEquals(o1, o2)) {
foundItem = o2;
found = true;
}
}
if (!found) return false;
otherItems.remove(foundItem);
}
return otherItems.isEmpty();
}
/**
* Compares two Maps treating coerced numerical values as identical.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [a:2, b:3] == [a:2L, b:3.0]</pre>
*
* @param self this Map
* @param other the Map being compared to
* @return <tt>true</tt> if the contents of both maps are identical
* @since 1.8.0
*/
public static boolean equals(Map self, Map other) {
if (self == null) {
return other == null;
}
if (other == null) {
return false;
}
if (self == other) {
return true;
}
if (self.size() != other.size()) {
return false;
}
if (!self.keySet().equals(other.keySet())) {
return false;
}
for (Object o : self.entrySet()) {
Map.Entry entry = (Map.Entry) o;
Object key = entry.getKey();
Object value = entry.getValue();
if (!coercedEquals(value, other.get(key))) {
return false;
}
}
return true;
}
/**
* Create a Set composed of the elements of the first Set minus the
* elements of the given Collection.
*
* @param self a Set object
* @param removeMe the items to remove from the Set
* @return the resulting Set
* @since 1.5.0
*/
public static <T> Set<T> minus(Set<T> self, Collection<?> removeMe) {
Comparator comparator = (self instanceof SortedSet) ? ((SortedSet) self).comparator() : null;
final Set<T> ansSet = createSimilarSet(self);
ansSet.addAll(self);
if (removeMe != null) {
for (T o1 : self) {
for (Object o2 : removeMe) {
boolean areEqual = (comparator != null) ? (comparator.compare(o1, o2) == 0) : coercedEquals(o1, o2);
if (areEqual) {
ansSet.remove(o1);
}
}
}
}
return ansSet;
}
/**
* Create a Set composed of the elements of the first Set minus the
* elements from the given Iterable.
*
* @param self a Set object
* @param removeMe the items to remove from the Set
* @return the resulting Set
* @since 1.8.7
*/
public static <T> Set<T> minus(Set<T> self, Iterable<?> removeMe) {
return minus(self, asCollection(removeMe));
}
/**
* Create a Set composed of the elements of the first Set minus the given element.
*
* @param self a Set object
* @param removeMe the element to remove from the Set
* @return the resulting Set
* @since 1.5.0
*/
public static <T> Set<T> minus(Set<T> self, Object removeMe) {
Comparator comparator = (self instanceof SortedSet) ? ((SortedSet) self).comparator() : null;
final Set<T> ansSet = createSimilarSet(self);
for (T t : self) {
boolean areEqual = (comparator != null)? (comparator.compare(t, removeMe) == 0) : coercedEquals(t, removeMe);
if (!areEqual) ansSet.add(t);
}
return ansSet;
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the
* elements of the given Collection.
*
* @param self a SortedSet object
* @param removeMe the items to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Collection<?> removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the
* elements of the given Iterable.
*
* @param self a SortedSet object
* @param removeMe the items to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Iterable<?> removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the given element.
*
* @param self a SortedSet object
* @param removeMe the element to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Object removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create an array composed of the elements of the first array minus the
* elements of the given Iterable.
*
* @param self an array
* @param removeMe a Collection of elements to remove
* @return an array with the supplied elements removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Iterable removeMe) {
return (T[]) minus(toList(self), removeMe).toArray();
}
/**
* Create an array composed of the elements of the first array minus the
* elements of the given array.
*
* @param self an array
* @param removeMe an array of elements to remove
* @return an array with the supplied elements removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Object[] removeMe) {
return (T[]) minus(toList(self), toList(removeMe)).toArray();
}
/**
* Create a List composed of the elements of the first list minus
* every occurrence of elements of the given Collection.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a List
* @param removeMe a Collection of elements to remove
* @return a List with the given elements removed
* @since 1.0
*/
public static <T> List<T> minus(List<T> self, Collection<?> removeMe) {
return (List<T>) minus((Collection<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Collection minus
* every occurrence of elements of the given Collection.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a Collection
* @param removeMe a Collection of elements to remove
* @return a Collection with the given elements removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Collection<T> self, Collection<?> removeMe) {
Collection<T> ansCollection = createSimilarCollection(self);
if (self.isEmpty())
return ansCollection;
T head = self.iterator().next();
boolean nlgnSort = sameType(new Collection[]{self, removeMe});
// We can't use the same tactic as for intersection
// since AbstractCollection only does a remove on the first
// element it encounters.
Comparator<T> numberComparator = new NumberAwareComparator<>();
if (nlgnSort && (head instanceof Comparable)) {
//n*LOG(n) version
Set<T> answer;
if (head instanceof Number) {
answer = new TreeSet<>(numberComparator);
answer.addAll(self);
for (T t : self) {
if (t instanceof Number) {
for (Object t2 : removeMe) {
if (t2 instanceof Number) {
if (numberComparator.compare(t, (T) t2) == 0)
answer.remove(t);
}
}
} else {
if (removeMe.contains(t))
answer.remove(t);
}
}
} else {
answer = new TreeSet<>(numberComparator);
answer.addAll(self);
answer.removeAll(removeMe);
}
for (T o : self) {
if (answer.contains(o))
ansCollection.add(o);
}
} else {
//n*n version
List<T> tmpAnswer = new LinkedList<>(self);
for (Iterator<T> iter = tmpAnswer.iterator(); iter.hasNext();) {
T element = iter.next();
boolean elementRemoved = false;
for (Iterator<?> iterator = removeMe.iterator(); iterator.hasNext() && !elementRemoved;) {
Object elt = iterator.next();
if (DefaultTypeTransformation.compareEqual(element, elt)) {
iter.remove();
elementRemoved = true;
}
}
}
//remove duplicates
//can't use treeset since the base classes are different
ansCollection.addAll(tmpAnswer);
}
return ansCollection;
}
/**
* Create a new List composed of the elements of the first List minus
* every occurrence of elements of the given Iterable.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a List
* @param removeMe an Iterable of elements to remove
* @return a new List with the given elements removed
* @since 1.8.7
*/
public static <T> List<T> minus(List<T> self, Iterable<?> removeMe) {
return (List<T>) minus((Iterable<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Iterable minus
* every occurrence of elements of the given Iterable.
* <pre class="groovyTestCase">
* assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
* </pre>
*
* @param self an Iterable
* @param removeMe an Iterable of elements to remove
* @return a new Collection with the given elements removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Iterable<T> self, Iterable<?> removeMe) {
return minus(asCollection(self), asCollection(removeMe));
}
/**
* Create a new List composed of the elements of the first List minus every occurrence of the
* given element to remove.
* <pre class="groovyTestCase">assert ["a", 5, 5, true] - 5 == ["a", true]</pre>
*
* @param self a List object
* @param removeMe an element to remove from the List
* @return the resulting List with the given element removed
* @since 1.0
*/
public static <T> List<T> minus(List<T> self, Object removeMe) {
return (List<T>) minus((Iterable<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Iterable minus every occurrence of the
* given element to remove.
* <pre class="groovyTestCase">assert ["a", 5, 5, true] - 5 == ["a", true]</pre>
*
* @param self an Iterable object
* @param removeMe an element to remove from the Iterable
* @return the resulting Collection with the given element removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Iterable<T> self, Object removeMe) {
Collection<T> ansList = createSimilarCollection(self);
for (T t : self) {
if (!coercedEquals(t, removeMe)) ansList.add(t);
}
return ansList;
}
/**
* Create a new object array composed of the elements of the first array
* minus the element to remove.
*
* @param self an array
* @param removeMe an element to remove from the array
* @return a new array with the operand removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Object removeMe) {
return (T[]) minus((Iterable<T>) toList(self), removeMe).toArray();
}
/**
* Create a Map composed of the entries of the first map minus the
* entries of the given map.
*
* @param self a map object
* @param removeMe the entries to remove from the map
* @return the resulting map
* @since 1.7.4
*/
public static <K,V> Map<K,V> minus(Map<K,V> self, Map removeMe) {
final Map<K,V> ansMap = createSimilarMap(self);
ansMap.putAll(self);
if (removeMe != null && !removeMe.isEmpty()) {
for (Map.Entry<K, V> e1 : self.entrySet()) {
for (Object e2 : removeMe.entrySet()) {
if (DefaultTypeTransformation.compareEqual(e1, e2)) {
ansMap.remove(e1.getKey());
}
}
}
}
return ansMap;
}
/**
* Flatten a Collection. This Collection and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self a Collection to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection<?> flatten(Collection<?> self) {
return flatten(self, createSimilarCollection(self));
}
/**
* Flatten an Iterable. This Iterable and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self an Iterable to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection<?> flatten(Iterable<?> self) {
return flatten(self, createSimilarCollection(self));
}
/**
* Flatten a List. This List and any nested arrays or
* collections have their contents (recursively) added to the new List.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self a List to flatten
* @return a flattened List
* @since 2.4.0
*/
public static List<?> flatten(List<?> self) {
return (List<?>) flatten((Collection<?>) self);
}
/**
* Flatten a Set. This Set and any nested arrays or
* collections have their contents (recursively) added to the new Set.
* <pre class="groovyTestCase">assert [1,2,3,4,5] as Set == ([1,[2,3],[[4]],[],5] as Set).flatten()</pre>
*
* @param self a Set to flatten
* @return a flattened Set
* @since 2.4.0
*/
public static Set<?> flatten(Set<?> self) {
return (Set<?>) flatten((Collection<?>) self);
}
/**
* Flatten a SortedSet. This SortedSet and any nested arrays or
* collections have their contents (recursively) added to the new SortedSet.
* <pre class="groovyTestCase">
* Set nested = [[0,1],[2],3,[4],5]
* SortedSet sorted = new TreeSet({ a, b {@code ->} (a instanceof List ? a[0] : a) {@code <=>} (b instanceof List ? b[0] : b) } as Comparator)
* sorted.addAll(nested)
* assert [0,1,2,3,4,5] as SortedSet == sorted.flatten()
* </pre>
*
* @param self a SortedSet to flatten
* @return a flattened SortedSet
* @since 2.4.0
*/
public static SortedSet<?> flatten(SortedSet<?> self) {
return (SortedSet<?>) flatten((Collection<?>) self);
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self an Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(Object[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a boolean Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(boolean[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a byte Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(byte[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a char Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(char[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a short Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(short[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self an int Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(int[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a long Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(long[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a float Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(float[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a double Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(double[] self) {
return flatten(toList(self), new ArrayList());
}
private static Collection flatten(Iterable elements, Collection addTo) {
for (Object element : elements) {
if (element instanceof Collection) {
flatten((Collection) element, addTo);
} else if (element != null && element.getClass().isArray()) {
flatten(DefaultTypeTransformation.arrayAsCollection(element), addTo);
} else {
// found a leaf
addTo.add(element);
}
}
return addTo;
}
/**
* @deprecated Use the Iterable version of flatten instead
* @see #flatten(Iterable, Closure)
* @since 1.6.0
*/
@Deprecated
public static <T> Collection<T> flatten(Collection<T> self, Closure<? extends T> flattenUsing) {
return flatten(self, createSimilarCollection(self), flattenUsing);
}
/**
* Flatten an Iterable. This Iterable and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* For any non-Array, non-Collection object which represents some sort
* of collective type, the supplied closure should yield the contained items;
* otherwise, the closure should just return any element which corresponds to a leaf.
*
* @param self an Iterable
* @param flattenUsing a closure to determine how to flatten non-Array, non-Collection elements
* @return a flattened Collection
* @since 1.6.0
*/
public static <T> Collection<T> flatten(Iterable<T> self, Closure<? extends T> flattenUsing) {
return flatten(self, createSimilarCollection(self), flattenUsing);
}
private static <T> Collection<T> flatten(Iterable elements, Collection<T> addTo, Closure<? extends T> flattenUsing) {
for (Object element : elements) {
if (element instanceof Collection) {
flatten((Collection) element, addTo, flattenUsing);
} else if (element != null && element.getClass().isArray()) {
flatten(DefaultTypeTransformation.arrayAsCollection(element), addTo, flattenUsing);
} else {
T flattened = flattenUsing.call(new Object[]{element});
boolean returnedSelf = flattened == element;
if (!returnedSelf && flattened instanceof Collection) {
List<?> list = toList((Iterable<?>) flattened);
if (list.size() == 1 && list.get(0) == element) {
returnedSelf = true;
}
}
if (flattened instanceof Collection && !returnedSelf) {
flatten((Collection) flattened, addTo, flattenUsing);
} else {
addTo.add(flattened);
}
}
}
return addTo;
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a Collection.
* <pre class="groovyTestCase">def list = [1,2]
* list << 3
* assert list == [1,2,3]</pre>
*
* @param self a Collection
* @param value an Object to be added to the collection.
* @return same collection, after the value was added to it.
* @since 1.0
*/
public static <T> Collection<T> leftShift(Collection<T> self, T value) {
self.add(value);
return self;
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a List.
* <pre class="groovyTestCase">def list = [1,2]
* list << 3
* assert list == [1,2,3]</pre>
*
* @param self a List
* @param value an Object to be added to the List.
* @return same List, after the value was added to it.
* @since 2.4.0
*/
public static <T> List<T> leftShift(List<T> self, T value) {
return (List<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a Set.
* <pre class="groovyTestCase">def set = [1,2] as Set
* set << 3
* assert set == [1,2,3] as Set</pre>
*
* @param self a Set
* @param value an Object to be added to the Set.
* @return same Set, after the value was added to it.
* @since 2.4.0
*/
public static <T> Set<T> leftShift(Set<T> self, T value) {
return (Set<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a SortedSet.
* <pre class="groovyTestCase">def set = [1,2] as SortedSet
* set << 3
* assert set == [1,2,3] as SortedSet</pre>
*
* @param self a SortedSet
* @param value an Object to be added to the SortedSet.
* @return same SortedSet, after the value was added to it.
* @since 2.4.0
*/
public static <T> SortedSet<T> leftShift(SortedSet<T> self, T value) {
return (SortedSet<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a BlockingQueue.
* In case of bounded queue the method will block till space in the queue become available
* <pre class="groovyTestCase">def list = new java.util.concurrent.LinkedBlockingQueue ()
* list << 3 << 2 << 1
* assert list.iterator().collect{it} == [3,2,1]</pre>
*
* @param self a Collection
* @param value an Object to be added to the collection.
* @return same collection, after the value was added to it.
* @since 1.7.1
*/
public static <T> BlockingQueue<T> leftShift(BlockingQueue<T> self, T value) throws InterruptedException {
self.put(value);
return self;
}
/**
* Overloads the left shift operator to provide an easy way to append
* Map.Entry values to a Map.
*
* @param self a Map
* @param entry a Map.Entry to be added to the Map.
* @return same map, after the value has been added to it.
* @since 1.6.0
*/
public static <K, V> Map<K, V> leftShift(Map<K, V> self, Map.Entry<K, V> entry) {
self.put(entry.getKey(), entry.getValue());
return self;
}
/**
* Overloads the left shift operator to provide an easy way to put
* one maps entries into another map. This allows the compact syntax
* <code>map1 << map2</code>; otherwise it's just a synonym for
* <code>putAll</code> though it returns the original map rather than
* being a <code>void</code> method. Example usage:
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map << [c:3, d:4]
* assert map == [a:1, b:2, c:3, d:4]</pre>
*
* @param self a Map
* @param other another Map whose entries should be added to the original Map.
* @return same map, after the values have been added to it.
* @since 1.7.2
*/
public static <K, V> Map<K, V> leftShift(Map<K, V> self, Map<K, V> other) {
self.putAll(other);
return self;
}
/**
* Implementation of the left shift operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to left shift the number
* @return the resulting number
* @since 1.5.0
*/
public static Number leftShift(Number self, Number operand) {
return NumberMath.leftShift(self, operand);
}
/**
* Implementation of the right shift operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to right shift the number
* @return the resulting number
* @since 1.5.0
*/
public static Number rightShift(Number self, Number operand) {
return NumberMath.rightShift(self, operand);
}
/**
* Implementation of the right shift (unsigned) operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to right shift (unsigned) the number
* @return the resulting number
* @since 1.5.0
*/
public static Number rightShiftUnsigned(Number self, Number operand) {
return NumberMath.rightShiftUnsigned(self, operand);
}
// Primitive type array methods
//-------------------------------------------------------------------------
/**
* Support the subscript operator with a range for a byte array
*
* @param array a byte array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a char array
*
* @param array a char array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.5.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a short array
*
* @param array a short array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for an int array
*
* @param array an int array
* @param range a range indicating the indices for the items to retrieve
* @return list of the ints at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a long array
*
* @param array a long array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a float array
*
* @param array a float array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a double array
*
* @param array a double array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a boolean array
*
* @param array a boolean array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved booleans
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an IntRange for a byte array
*
* @param array a byte array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Byte> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a char array
*
* @param array a char array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Character> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a short array
*
* @param array a short array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Short> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for an int array
*
* @param array an int array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved ints
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Integer> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a long array
*
* @param array a long array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Long> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a float array
*
* @param array a float array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Float> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a double array
*
* @param array a double array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Double> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a boolean array
*
* @param array a boolean array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved booleans
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Boolean> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an ObjectRange for a byte array
*
* @param array a byte array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a char array
*
* @param array a char array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a short array
*
* @param array a short array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for an int array
*
* @param array an int array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved ints
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a long array
*
* @param array a long array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a float array
*
* @param array a float array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a double array
*
* @param array a double array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a byte array
*
* @param array a byte array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a collection for a byte array
*
* @param array a byte array
* @param indices a collection of indices for the items to retrieve
* @return list of the bytes at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a char array
*
* @param array a char array
* @param indices a collection of indices for the items to retrieve
* @return list of the chars at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a short array
*
* @param array a short array
* @param indices a collection of indices for the items to retrieve
* @return list of the shorts at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for an int array
*
* @param array an int array
* @param indices a collection of indices for the items to retrieve
* @return list of the ints at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a long array
*
* @param array a long array
* @param indices a collection of indices for the items to retrieve
* @return list of the longs at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a float array
*
* @param array a float array
* @param indices a collection of indices for the items to retrieve
* @return list of the floats at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a double array
*
* @param array a double array
* @param indices a collection of indices for the items to retrieve
* @return list of the doubles at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a boolean array
*
* @param array a boolean array
* @param indices a collection of indices for the items to retrieve
* @return list of the booleans at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator for a Bitset
*
* @param self a BitSet
* @param index index to retrieve
* @return value of the bit at the given index
* @see java.util.BitSet
* @since 1.5.0
*/
public static boolean getAt(BitSet self, int index) {
int i = normaliseIndex(index, self.length());
return self.get(i);
}
/**
* Support retrieving a subset of a BitSet using a Range
*
* @param self a BitSet
* @param range a Range defining the desired subset
* @return a new BitSet that represents the requested subset
* @see java.util.BitSet
* @see groovy.lang.IntRange
* @since 1.5.0
*/
public static BitSet getAt(BitSet self, IntRange range) {
RangeInfo info = subListBorders(self.length(), range);
BitSet result = new BitSet();
int numberOfBits = info.to - info.from;
int adjuster = 1;
int offset = info.from;
if (info.reverse) {
adjuster = -1;
offset = info.to - 1;
}
for (int i = 0; i < numberOfBits; i++) {
result.set(i, self.get(offset + (adjuster * i)));
}
return result;
}
// public static Boolean putAt(boolean[] array, int idx, Boolean newValue) {
// return (Boolean) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Byte putAt(byte[] array, int idx, Object newValue) {
// if (!(newValue instanceof Byte)) {
// Number n = (Number) newValue;
// newValue = new Byte(n.byteValue());
// }
// return (Byte) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Character putAt(char[] array, int idx, Object newValue) {
// if (newValue instanceof String) {
// String s = (String) newValue;
// if (s.length() != 1) throw new IllegalArgumentException("String of length 1 expected but got a bigger one");
// char c = s.charAt(0);
// newValue = new Character(c);
// }
// return (Character) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Short putAt(short[] array, int idx, Object newValue) {
// if (!(newValue instanceof Short)) {
// Number n = (Number) newValue;
// newValue = new Short(n.shortValue());
// }
// return (Short) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Integer putAt(int[] array, int idx, Object newValue) {
// if (!(newValue instanceof Integer)) {
// Number n = (Number) newValue;
// newValue = Integer.valueOf(n.intValue());
// }
// array [normaliseIndex(idx,array.length)] = ((Integer)newValue).intValue();
// return (Integer) newValue;
// }
//
// public static Long putAt(long[] array, int idx, Object newValue) {
// if (!(newValue instanceof Long)) {
// Number n = (Number) newValue;
// newValue = new Long(n.longValue());
// }
// return (Long) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Float putAt(float[] array, int idx, Object newValue) {
// if (!(newValue instanceof Float)) {
// Number n = (Number) newValue;
// newValue = new Float(n.floatValue());
// }
// return (Float) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Double putAt(double[] array, int idx, Object newValue) {
// if (!(newValue instanceof Double)) {
// Number n = (Number) newValue;
// newValue = new Double(n.doubleValue());
// }
// return (Double) primitiveArrayPut(array, idx, newValue);
// }
/**
* Support assigning a range of values with a single assignment statement.
*
* @param self a BitSet
* @param range the range of values to set
* @param value value
* @see java.util.BitSet
* @see groovy.lang.Range
* @since 1.5.0
*/
public static void putAt(BitSet self, IntRange range, boolean value) {
RangeInfo info = subListBorders(self.length(), range);
self.set(info.from, info.to, value);
}
/**
* Support subscript-style assignment for a BitSet.
*
* @param self a BitSet
* @param index index of the entry to set
* @param value value
* @see java.util.BitSet
* @since 1.5.0
*/
public static void putAt(BitSet self, int index, boolean value) {
self.set(index, value);
}
/**
* Allows arrays to behave similar to collections.
* @param array a boolean array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.5.0
*/
public static int size(boolean[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a byte array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(byte[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a char array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(char[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a short array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(short[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array an int array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(int[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a long array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(long[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a float array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(float[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a double array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(double[] array) {
return Array.getLength(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a byte array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> toList(byte[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a boolean array
* @return a list containing the contents of this array.
* @since 1.6.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> toList(boolean[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a char array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> toList(char[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a short array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> toList(short[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array an int array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> toList(int[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a long array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> toList(long[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a float array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> toList(float[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a double array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> toList(double[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a byte array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Byte> toSet(byte[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a boolean array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Boolean> toSet(boolean[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a char array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Character> toSet(char[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a short array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Short> toSet(short[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array an int array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Integer> toSet(int[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a long array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Long> toSet(long[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a float array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Float> toSet(float[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a double array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Double> toSet(double[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Convert a Collection to a Set. Always returns a new Set
* even if the Collection is already a Set.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [1, 2, 2, 2, 3].toSet()
* assert result instanceof Set
* assert result == [1, 2, 3] as Set
* </pre>
*
* @param self a collection
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Collection<T> self) {
Set<T> answer = new HashSet<>(self.size());
answer.addAll(self);
return answer;
}
/**
* Convert an Iterable to a Set. Always returns a new Set
* even if the Iterable is already a Set.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [1, 2, 2, 2, 3].toSet()
* assert result instanceof Set
* assert result == [1, 2, 3] as Set
* </pre>
*
* @param self an Iterable
* @return a Set
* @since 2.4.0
*/
public static <T> Set<T> toSet(Iterable<T> self) {
return toSet(self.iterator());
}
/**
* Convert an iterator to a Set. The iterator will become
* exhausted of elements after making this conversion.
*
* @param self an iterator
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Iterator<T> self) {
Set<T> answer = new HashSet<>();
while (self.hasNext()) {
answer.add(self.next());
}
return answer;
}
/**
* Convert an enumeration to a Set.
*
* @param self an enumeration
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Enumeration<T> self) {
Set<T> answer = new HashSet<>();
while (self.hasMoreElements()) {
answer.add(self.nextElement());
}
return answer;
}
/**
* Implements the getAt(int) method for primitive type arrays.
*
* @param self an array object
* @param idx the index of interest
* @return the returned value from the array
* @since 1.5.0
*/
protected static Object primitiveArrayGet(Object self, int idx) {
return Array.get(self, normaliseIndex(idx, Array.getLength(self)));
}
/**
* Implements the getAt(Range) method for primitive type arrays.
*
* @param self an array object
* @param range the range of indices of interest
* @return the returned values from the array corresponding to the range
* @since 1.5.0
*/
protected static List primitiveArrayGet(Object self, Range range) {
List answer = new ArrayList();
for (Object next : range) {
int idx = DefaultTypeTransformation.intUnbox(next);
answer.add(primitiveArrayGet(self, idx));
}
return answer;
}
/**
* Implements the getAt(Collection) method for primitive type arrays. Each
* value in the collection argument is assumed to be a valid array index.
* The value at each index is then added to a list which is returned.
*
* @param self an array object
* @param indices the indices of interest
* @return the returned values from the array
* @since 1.0
*/
protected static List primitiveArrayGet(Object self, Collection indices) {
List answer = new ArrayList();
for (Object value : indices) {
if (value instanceof Range) {
answer.addAll(primitiveArrayGet(self, (Range) value));
} else if (value instanceof List) {
answer.addAll(primitiveArrayGet(self, (List) value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(primitiveArrayGet(self, idx));
}
}
return answer;
}
/**
* Implements the setAt(int idx) method for primitive type arrays.
*
* @param self an object
* @param idx the index of interest
* @param newValue the new value to be put into the index of interest
* @return the added value
* @since 1.5.0
*/
protected static Object primitiveArrayPut(Object self, int idx, Object newValue) {
Array.set(self, normaliseIndex(idx, Array.getLength(self)), newValue);
return newValue;
}
/**
* Identity conversion which returns Boolean.TRUE for a true Boolean and Boolean.FALSE for a false Boolean.
*
* @param self a Boolean
* @return the original Boolean
* @since 1.7.6
*/
public static Boolean toBoolean(Boolean self) {
return self;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(int[] self, Object value) {
for (int next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(long[] self, Object value) {
for (long next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(short[] self, Object value) {
for (short next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(char[] self, Object value) {
for (char next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.8.6
*/
public static boolean contains(boolean[] self, Object value) {
for (boolean next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(double[] self, Object value) {
for (double next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(float[] self, Object value) {
for (float next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(byte[] self, Object value) {
for (byte next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(Object[] self, Object value) {
for (Object next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(boolean[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(byte[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(char[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(short[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(int[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(long[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(float[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(double[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given map.
*
* @param self a Map
* @return the string representation
* @see #toMapString(java.util.Map)
* @since 1.0
*/
public static String toString(AbstractMap self) {
return toMapString(self);
}
/**
* Returns the string representation of this map. The string displays the
* contents of the map, i.e. <code>[one:1, two:2, three:3]</code>.
*
* @param self a Map
* @return the string representation
* @since 1.0
*/
public static String toMapString(Map self) {
return toMapString(self, -1);
}
/**
* Returns the string representation of this map. The string displays the
* contents of the map, i.e. <code>[one:1, two:2, three:3]</code>.
*
* @param self a Map
* @param maxSize stop after approximately this many characters and append '...'
* @return the string representation
* @since 1.0
*/
public static String toMapString(Map self, int maxSize) {
return (self == null) ? "null" : InvokerHelper.toMapString(self, maxSize);
}
/**
* Returns the string representation of the given collection. The string
* displays the contents of the collection, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @return the string representation
* @see #toListString(java.util.Collection)
* @since 1.0
*/
public static String toString(AbstractCollection self) {
return toListString(self);
}
/**
* Returns the string representation of the given list. The string
* displays the contents of the list, similar to a list literal, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @return the string representation
* @since 1.0
*/
public static String toListString(Collection self) {
return toListString(self, -1);
}
/**
* Returns the string representation of the given list. The string
* displays the contents of the list, similar to a list literal, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @param maxSize stop after approximately this many characters and append '...'
* @return the string representation
* @since 1.7.3
*/
public static String toListString(Collection self, int maxSize) {
return (self == null) ? "null" : InvokerHelper.toListString(self, maxSize);
}
/**
* Returns the string representation of this array's contents.
*
* @param self an Object[]
* @return the string representation
* @see #toArrayString(java.lang.Object[])
* @since 1.0
*/
public static String toString(Object[] self) {
return toArrayString(self);
}
/**
* Returns the string representation of the given array. The string
* displays the contents of the array, similar to an array literal, i.e.
* <code>{1, 2, "a"}</code>.
*
* @param self an Object[]
* @return the string representation
* @since 1.0
*/
public static String toArrayString(Object[] self) {
return (self == null) ? "null" : InvokerHelper.toArrayString(self);
}
/**
* Create a String representation of this object.
* @param value an object
* @return a string.
* @since 1.0
*/
public static String toString(Object value) {
return InvokerHelper.toString(value);
}
// Number based methods
//-------------------------------------------------------------------------
/**
* Increment a Character by one.
*
* @param self a Character
* @return an incremented Character
* @since 1.5.7
*/
public static Character next(Character self) {
return (char) (self + 1);
}
/**
* Increment a Number by one.
*
* @param self a Number
* @return an incremented Number
* @since 1.0
*/
public static Number next(Number self) {
return NumberNumberPlus.plus(self, ONE);
}
/**
* Decrement a Character by one.
*
* @param self a Character
* @return a decremented Character
* @since 1.5.7
*/
public static Character previous(Character self) {
return (char) (self - 1);
}
/**
* Decrement a Number by one.
*
* @param self a Number
* @return a decremented Number
* @since 1.0
*/
public static Number previous(Number self) {
return NumberNumberMinus.minus(self, ONE);
}
/**
* Add a Character and a Number. The ordinal value of the Character
* is used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @see java.lang.Integer#valueOf(int)
* @param left a Character
* @param right a Number
* @return the Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Character left, Number right) {
return NumberNumberPlus.plus(Integer.valueOf(left), right);
}
/**
* Add a Number and a Character. The ordinal value of the Character
* is used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @see java.lang.Integer#valueOf(int)
* @param left a Number
* @param right a Character
* @return The Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Number left, Character right) {
return NumberNumberPlus.plus(left, Integer.valueOf(right));
}
/**
* Add one Character to another. The ordinal values of the Characters
* are used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @see #plus(java.lang.Number, java.lang.Character)
* @param left a Character
* @param right a Character
* @return the Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Character left, Character right) {
return plus(Integer.valueOf(left), right);
}
/**
* Compare a Character and a Number. The ordinal value of the Character
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Character left, Number right) {
return compareTo(Integer.valueOf(left), right);
}
/**
* Compare a Number and a Character. The ordinal value of the Character
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Number left, Character right) {
return compareTo(left, Integer.valueOf(right));
}
/**
* Compare two Characters. The ordinal values of the Characters
* are compared (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Character
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Character left, Character right) {
return compareTo(Integer.valueOf(left), right);
}
/**
* Compare two Numbers. Equality (==) for numbers dispatches to this.
*
* @param left a Number
* @param right another Number to compare to
* @return the comparison of both numbers
* @since 1.0
*/
public static int compareTo(Number left, Number right) {
/** @todo maybe a double dispatch thing to handle new large numbers? */
return NumberMath.compareTo(left, right);
}
/**
* Subtract a Number from a Character. The ordinal value of the Character
* is used in the subtraction (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Character left, Number right) {
return NumberNumberMinus.minus(Integer.valueOf(left), right);
}
/**
* Subtract a Character from a Number. The ordinal value of the Character
* is used in the subtraction (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Number left, Character right) {
return NumberNumberMinus.minus(left, Integer.valueOf(right));
}
/**
* Subtract one Character from another. The ordinal values of the Characters
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Character
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Character left, Character right) {
return minus(Integer.valueOf(left), right);
}
/**
* Multiply a Character by a Number. The ordinal value of the Character
* is used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Character left, Number right) {
return NumberNumberMultiply.multiply(Integer.valueOf(left), right);
}
/**
* Multiply a Number by a Character. The ordinal value of the Character
* is used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Number left, Character right) {
return NumberNumberMultiply.multiply(Integer.valueOf(right), left);
}
/**
* Multiply two Characters. The ordinal values of the Characters
* are used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return the Number corresponding to the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Character left, Character right) {
return multiply(Integer.valueOf(left), right);
}
/**
* Multiply a BigDecimal and a Double.
* Note: This method was added to enforce the Groovy rule of
* BigDecimal*Double == Double. Without this method, the
* multiply(BigDecimal) method in BigDecimal would respond
* and return a BigDecimal instead. Since BigDecimal is preferred
* over Number, the Number*Number method is not chosen as in older
* versions of Groovy.
*
* @param left a BigDecimal
* @param right a Double
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(BigDecimal left, Double right) {
return NumberMath.multiply(left, right);
}
/**
* Multiply a BigDecimal and a BigInteger.
* Note: This method was added to enforce the Groovy rule of
* BigDecimal*long == long. Without this method, the
* multiply(BigDecimal) method in BigDecimal would respond
* and return a BigDecimal instead. Since BigDecimal is preferred
* over Number, the Number*Number method is not chosen as in older
* versions of Groovy. BigInteger is the fallback for all integer
* types in Groovy
*
* @param left a BigDecimal
* @param right a BigInteger
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(BigDecimal left, BigInteger right) {
return NumberMath.multiply(left, right);
}
/**
* Compare a BigDecimal to another.
* A fluent api style alias for {@code compareTo}.
*
* @param left a BigDecimal
* @param right a BigDecimal
* @return true if left is equal to or bigger than right
* @since 3.0.1
*/
public static Boolean isAtLeast(BigDecimal left, BigDecimal right) {
return left.compareTo(right) >= 0;
}
/**
* Compare a BigDecimal to a String representing a number.
* A fluent api style alias for {@code compareTo}.
*
* @param left a BigDecimal
* @param right a String representing a number
* @return true if left is equal to or bigger than the value represented by right
* @since 3.0.1
*/
public static Boolean isAtLeast(BigDecimal left, String right) {
return isAtLeast(left, new BigDecimal(right));
}
/**
* Power of a Number to a certain exponent. Called by the '**' operator.
*
* @param self a Number
* @param exponent a Number exponent
* @return a Number to the power of a certain exponent
* @since 1.0
*/
public static Number power(Number self, Number exponent) {
double base, exp, answer;
base = self.doubleValue();
exp = exponent.doubleValue();
answer = Math.pow(base, exp);
if ((double) ((int) answer) == answer) {
return (int) answer;
} else if ((double) ((long) answer) == answer) {
return (long) answer;
} else {
return answer;
}
}
/**
* Power of a BigDecimal to an integer certain exponent. If the
* exponent is positive, call the BigDecimal.pow(int) method to
* maintain precision. Called by the '**' operator.
*
* @param self a BigDecimal
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(BigDecimal self, Integer exponent) {
if (exponent >= 0) {
return self.pow(exponent);
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a BigInteger to an integer certain exponent. If the
* exponent is positive, call the BigInteger.pow(int) method to
* maintain precision. Called by the '**' operator.
*
* @param self a BigInteger
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(BigInteger self, Integer exponent) {
if (exponent >= 0) {
return self.pow(exponent);
} else {
return power(self, (double) exponent);
}
}
/**
* Power of an integer to an integer certain exponent. If the
* exponent is positive, convert to a BigInteger and call
* BigInteger.pow(int) method to maintain precision. Called by the
* '**' operator.
*
* @param self an Integer
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(Integer self, Integer exponent) {
if (exponent >= 0) {
BigInteger answer = BigInteger.valueOf(self).pow(exponent);
if (answer.compareTo(BI_INT_MIN) >= 0 && answer.compareTo(BI_INT_MAX) <= 0) {
return answer.intValue();
} else {
return answer;
}
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a long to an integer certain exponent. If the
* exponent is positive, convert to a BigInteger and call
* BigInteger.pow(int) method to maintain precision. Called by the
* '**' operator.
*
* @param self a Long
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(Long self, Integer exponent) {
if (exponent >= 0) {
BigInteger answer = BigInteger.valueOf(self).pow(exponent);
if (answer.compareTo(BI_LONG_MIN) >= 0 && answer.compareTo(BI_LONG_MAX) <= 0) {
return answer.longValue();
} else {
return answer;
}
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a BigInteger to a BigInteger certain exponent. Called by the '**' operator.
*
* @param self a BigInteger
* @param exponent a BigInteger exponent
* @return a BigInteger to the power of a the exponent
* @since 2.3.8
*/
public static BigInteger power(BigInteger self, BigInteger exponent) {
if ((exponent.signum() >= 0) && (exponent.compareTo(BI_INT_MAX) <= 0)) {
return self.pow(exponent.intValue());
} else {
return BigDecimal.valueOf(Math.pow(self.doubleValue(), exponent.doubleValue())).toBigInteger();
}
}
/**
* Divide a Character by a Number. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Character left, Number right) {
return NumberNumberDiv.div(Integer.valueOf(left), right);
}
/**
* Divide a Number by a Character. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Number left, Character right) {
return NumberNumberDiv.div(left, Integer.valueOf(right));
}
/**
* Divide one Character by another. The ordinal values of the Characters
* are used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Character left, Character right) {
return div(Integer.valueOf(left), right);
}
/**
* Integer Divide a Character by a Number. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Character left, Number right) {
return intdiv(Integer.valueOf(left), right);
}
/**
* Integer Divide a Number by a Character. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Number left, Character right) {
return intdiv(left, Integer.valueOf(right));
}
/**
* Integer Divide two Characters. The ordinal values of the Characters
* are used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Character left, Character right) {
return intdiv(Integer.valueOf(left), right);
}
/**
* Integer Divide two Numbers.
*
* @param left a Number
* @param right another Number
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Number left, Number right) {
return NumberMath.intdiv(left, right);
}
/**
* Bitwise OR together two numbers.
*
* @param left a Number
* @param right another Number to bitwise OR
* @return the bitwise OR of both Numbers
* @since 1.0
*/
public static Number or(Number left, Number right) {
return NumberMath.or(left, right);
}
/**
* Bitwise AND together two Numbers.
*
* @param left a Number
* @param right another Number to bitwise AND
* @return the bitwise AND of both Numbers
* @since 1.0
*/
public static Number and(Number left, Number right) {
return NumberMath.and(left, right);
}
/**
* Bitwise AND together two BitSets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise AND of both BitSets
* @since 1.5.0
*/
public static BitSet and(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.and(right);
return result;
}
/**
* Bitwise XOR together two BitSets. Called when the '^' operator is used
* between two bit sets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise XOR of both BitSets
* @since 1.5.0
*/
public static BitSet xor(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.xor(right);
return result;
}
/**
* Bitwise NEGATE a BitSet.
*
* @param self a BitSet
* @return the bitwise NEGATE of the BitSet
* @since 1.5.0
*/
public static BitSet bitwiseNegate(BitSet self) {
BitSet result = (BitSet) self.clone();
result.flip(0, result.size() - 1);
return result;
}
/**
* Bitwise NEGATE a Number.
*
* @param left a Number
* @return the bitwise NEGATE of the Number
* @since 2.2.0
*/
public static Number bitwiseNegate(Number left) {
return NumberMath.bitwiseNegate(left);
}
/**
* Bitwise OR together two BitSets. Called when the '|' operator is used
* between two bit sets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise OR of both BitSets
* @since 1.5.0
*/
public static BitSet or(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.or(right);
return result;
}
/**
* Bitwise XOR together two Numbers. Called when the '^' operator is used.
*
* @param left a Number
* @param right another Number to bitwse XOR
* @return the bitwise XOR of both Numbers
* @since 1.0
*/
public static Number xor(Number left, Number right) {
return NumberMath.xor(left, right);
}
/**
* Performs a division modulus operation. Called by the '%' operator.
*
* @param left a Number
* @param right another Number to mod
* @return the modulus result
* @since 1.0
*/
public static Number mod(Number left, Number right) {
return NumberMath.mod(left, right);
}
/**
* Negates the number. Equivalent to the '-' operator when it preceeds
* a single operand, i.e. <code>-10</code>
*
* @param left a Number
* @return the negation of the number
* @since 1.5.0
*/
public static Number unaryMinus(Number left) {
return NumberMath.unaryMinus(left);
}
/**
* Returns the number, effectively being a noop for numbers.
* Operator overloaded form of the '+' operator when it preceeds
* a single operand, i.e. <code>+10</code>
*
* @param left a Number
* @return the number
* @since 2.2.0
*/
public static Number unaryPlus(Number left) {
return NumberMath.unaryPlus(left);
}
/**
* Executes the closure this many times, starting from zero. The current
* index is passed to the closure each time.
* Example:
* <pre>10.times {
* println it
* }</pre>
* Prints the numbers 0 through 9.
*
* @param self a Number
* @param closure the closure to call a number of times
* @since 1.0
*/
public static void times(Number self, @ClosureParams(value=SimpleType.class,options="int") Closure closure) {
for (int i = 0, size = self.intValue(); i < size; i++) {
closure.call(i);
if (closure.getDirective() == Closure.DONE) {
break;
}
}
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Number
* @param to another Number to go up to
* @param closure the closure to call
* @since 1.0
*/
public static void upto(Number self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
int self1 = self.intValue();
int to1 = to.intValue();
if (self1 <= to1) {
for (int i = self1; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self <= to1) {
for (long i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self <= to1) {
for (long i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self <= to1) {
for (float i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self <= to1) {
for (float i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self <= to1) {
for (double i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self <= to1) {
for (double i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time. Example:
* <pre>0.upto( 10 ) {
* println it
* }</pre>
* Prints numbers 0 to 10
*
* @param self a BigInteger
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(BigInteger self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
if (to instanceof BigDecimal) {
final BigDecimal one = BigDecimal.valueOf(10, 1);
BigDecimal self1 = new BigDecimal(self);
BigDecimal to1 = (BigDecimal) to;
if (self1.compareTo(to1) <= 0) {
for (BigDecimal i = self1; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
} else if (to instanceof BigInteger) {
final BigInteger one = BigInteger.valueOf(1);
BigInteger to1 = (BigInteger) to;
if (self.compareTo(to1) <= 0) {
for (BigInteger i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format("The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
} else {
final BigInteger one = BigInteger.valueOf(1);
BigInteger to1 = new BigInteger(to.toString());
if (self.compareTo(to1) <= 0) {
for (BigInteger i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(MessageFormat.format(
"The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
}
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
* <pre>0.1.upto( 10 ) {
* println it
* }</pre>
* Prints numbers 0.1, 1.1, 2.1... to 9.1
*
* @param self a BigDecimal
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(BigDecimal self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // That's what you get for "1.0".
if (to instanceof BigDecimal) {
BigDecimal to1 = (BigDecimal) to;
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
} else if (to instanceof BigInteger) {
BigDecimal to1 = new BigDecimal((BigInteger) to);
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
} else {
BigDecimal to1 = new BigDecimal(to.toString());
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Number
* @param to another Number to go down to
* @param closure the closure to call
* @since 1.0
*/
public static void downto(Number self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
int self1 = self.intValue();
int to1 = to.intValue();
if (self1 >= to1) {
for (int i = self1; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self >= to1) {
for (long i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self >= to1) {
for (long i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self >= to1) {
for (float i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self >= to1) {
for (float i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self >= to1) {
for (double i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self >= to1) {
for (double i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a BigInteger
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(BigInteger self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
if (to instanceof BigDecimal) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // That's what you get for "1.0".
final BigDecimal to1 = (BigDecimal) to;
final BigDecimal selfD = new BigDecimal(self);
if (selfD.compareTo(to1) >= 0) {
for (BigDecimal i = selfD; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i.toBigInteger());
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
} else if (to instanceof BigInteger) {
final BigInteger one = BigInteger.valueOf(1);
final BigInteger to1 = (BigInteger) to;
if (self.compareTo(to1) >= 0) {
for (BigInteger i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
} else {
final BigInteger one = BigInteger.valueOf(1);
final BigInteger to1 = new BigInteger(to.toString());
if (self.compareTo(to1) >= 0) {
for (BigInteger i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format("The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
}
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time. Each number is passed to the closure.
* Example:
* <pre>
* 10.5.downto(0) {
* println it
* }
* </pre>
* Prints numbers 10.5, 9.5 ... to 0.5.
*
* @param self a BigDecimal
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(BigDecimal self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // Quick way to get "1.0".
if (to instanceof BigDecimal) {
BigDecimal to1 = (BigDecimal) to;
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); } else if (to instanceof BigInteger) {
BigDecimal to1 = new BigDecimal((BigInteger) to);
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); } else {
BigDecimal to1 = new BigDecimal(to.toString());
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
}
/**
* Iterates from this number up to the given number using a step increment.
* Each intermediate number is passed to the given closure. Example:
* <pre>
* 0.step( 10, 2 ) {
* println it
* }
* </pre>
* Prints even numbers 0 through 8.
*
* @param self a Number to start with
* @param to a Number to go up to, exclusive
* @param stepNumber a Number representing the step increment
* @param closure the closure to call
* @since 1.0
*/
public static void step(Number self, Number to, Number stepNumber, Closure closure) {
if (self instanceof BigDecimal || to instanceof BigDecimal || stepNumber instanceof BigDecimal) {
final BigDecimal zero = BigDecimal.valueOf(0, 1); // Same as "0.0".
BigDecimal self1 = (self instanceof BigDecimal) ? (BigDecimal) self : new BigDecimal(self.toString());
BigDecimal to1 = (to instanceof BigDecimal) ? (BigDecimal) to : new BigDecimal(to.toString());
BigDecimal stepNumber1 = (stepNumber instanceof BigDecimal) ? (BigDecimal) stepNumber : new BigDecimal(stepNumber.toString());
if (stepNumber1.compareTo(zero) > 0 && to1.compareTo(self1) > 0) {
for (BigDecimal i = self1; i.compareTo(to1) < 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if (stepNumber1.compareTo(zero) < 0 && to1.compareTo(self1) < 0) {
for (BigDecimal i = self1; i.compareTo(to1) > 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if(self1.compareTo(to1) != 0)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
} else if (self instanceof BigInteger || to instanceof BigInteger || stepNumber instanceof BigInteger) {
final BigInteger zero = BigInteger.valueOf(0);
BigInteger self1 = (self instanceof BigInteger) ? (BigInteger) self : new BigInteger(self.toString());
BigInteger to1 = (to instanceof BigInteger) ? (BigInteger) to : new BigInteger(to.toString());
BigInteger stepNumber1 = (stepNumber instanceof BigInteger) ? (BigInteger) stepNumber : new BigInteger(stepNumber.toString());
if (stepNumber1.compareTo(zero) > 0 && to1.compareTo(self1) > 0) {
for (BigInteger i = self1; i.compareTo(to1) < 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if (stepNumber1.compareTo(zero) < 0 && to1.compareTo(self1) < 0) {
for (BigInteger i = self1; i.compareTo(to1) > 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if(self1.compareTo(to1) != 0)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
} else {
int self1 = self.intValue();
int to1 = to.intValue();
int stepNumber1 = stepNumber.intValue();
if (stepNumber1 > 0 && to1 > self1) {
for (int i = self1; i < to1; i += stepNumber1) {
closure.call(i);
}
} else if (stepNumber1 < 0 && to1 < self1) {
for (int i = self1; i > to1; i += stepNumber1) {
closure.call(i);
}
} else if(self1 != to1)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
}
}
/**
* Get the absolute value
*
* @param number a Number
* @return the absolute value of that Number
* @since 1.0
*/
//Note: This method is NOT called if number is a BigInteger or BigDecimal because
//those classes implement a method with a better exact match.
public static int abs(Number number) {
return Math.abs(number.intValue());
}
/**
* Get the absolute value
*
* @param number a Long
* @return the absolute value of that Long
* @since 1.0
*/
public static long abs(Long number) {
return Math.abs(number);
}
/**
* Get the absolute value
*
* @param number a Float
* @return the absolute value of that Float
* @since 1.0
*/
public static float abs(Float number) {
return Math.abs(number);
}
/**
* Get the absolute value
*
* @param number a Double
* @return the absolute value of that Double
* @since 1.0
*/
public static double abs(Double number) {
return Math.abs(number);
}
/**
* Round the value
*
* @param number a Float
* @return the rounded value of that Float
* @since 1.0
*/
public static int round(Float number) {
return Math.round(number);
}
/**
* Round the value
*
* @param number a Float
* @param precision the number of decimal places to keep
* @return the Float rounded to the number of decimal places specified by precision
* @since 1.6.0
*/
public static float round(Float number, int precision) {
return (float)(Math.floor(number.doubleValue()*Math.pow(10,precision)+0.5)/Math.pow(10,precision));
}
/**
* Truncate the value
*
* @param number a Float
* @param precision the number of decimal places to keep
* @return the Float truncated to the number of decimal places specified by precision
* @since 1.6.0
*/
public static float trunc(Float number, int precision) {
final double p = Math.pow(10, precision);
final double n = number.doubleValue() * p;
if (number < 0f) {
return (float) (Math.ceil(n) / p);
}
return (float) (Math.floor(n) / p);
}
/**
* Truncate the value
*
* @param number a Float
* @return the Float truncated to 0 decimal places
* @since 1.6.0
*/
public static float trunc(Float number) {
if (number < 0f) {
return (float)Math.ceil(number.doubleValue());
}
return (float)Math.floor(number.doubleValue());
}
/**
* Round the value
*
* @param number a Double
* @return the rounded value of that Double
* @since 1.0
*/
public static long round(Double number) {
return Math.round(number);
}
/**
* Round the value
*
* @param number a Double
* @param precision the number of decimal places to keep
* @return the Double rounded to the number of decimal places specified by precision
* @since 1.6.4
*/
public static double round(Double number, int precision) {
return Math.floor(number *Math.pow(10,precision)+0.5)/Math.pow(10,precision);
}
/**
* Truncate the value
*
* @param number a Double
* @return the Double truncated to 0 decimal places
* @since 1.6.4
*/
public static double trunc(Double number) {
if (number < 0d) {
return Math.ceil(number);
}
return Math.floor(number);
}
/**
* Truncate the value
*
* @param number a Double
* @param precision the number of decimal places to keep
* @return the Double truncated to the number of decimal places specified by precision
* @since 1.6.4
*/
public static double trunc(Double number, int precision) {
if (number < 0d) {
return Math.ceil(number *Math.pow(10,precision))/Math.pow(10,precision);
}
return Math.floor(number *Math.pow(10,precision))/Math.pow(10,precision);
}
/**
* Round the value
* <p>
* Note that this method differs from {@link java.math.BigDecimal#round(java.math.MathContext)}
* which specifies the digits to retain starting from the leftmost nonzero
* digit. This methods rounds the integral part to the nearest whole number.
*
* @param number a BigDecimal
* @return the rounded value of that BigDecimal
* @see #round(java.math.BigDecimal, int)
* @see java.math.BigDecimal#round(java.math.MathContext)
* @since 2.5.0
*/
public static BigDecimal round(BigDecimal number) {
return round(number, 0);
}
/**
* Round the value
* <p>
* Note that this method differs from {@link java.math.BigDecimal#round(java.math.MathContext)}
* which specifies the digits to retain starting from the leftmost nonzero
* digit. This method operates on the fractional part of the number and
* the precision argument specifies the number of digits to the right of
* the decimal point to retain.
*
* @param number a BigDecimal
* @param precision the number of decimal places to keep
* @return a BigDecimal rounded to the number of decimal places specified by precision
* @see #round(java.math.BigDecimal)
* @see java.math.BigDecimal#round(java.math.MathContext)
* @since 2.5.0
*/
public static BigDecimal round(BigDecimal number, int precision) {
return number.setScale(precision, RoundingMode.HALF_UP);
}
/**
* Truncate the value
*
* @param number a BigDecimal
* @return a BigDecimal truncated to 0 decimal places
* @see #trunc(java.math.BigDecimal, int)
* @since 2.5.0
*/
public static BigDecimal trunc(BigDecimal number) {
return trunc(number, 0);
}
/**
* Truncate the value
*
* @param number a BigDecimal
* @param precision the number of decimal places to keep
* @return a BigDecimal truncated to the number of decimal places specified by precision
* @see #trunc(java.math.BigDecimal)
* @since 2.5.0
*/
public static BigDecimal trunc(BigDecimal number, int precision) {
return number.setScale(precision, RoundingMode.DOWN);
}
/**
* Determine if a Character is uppercase.
* Synonym for 'Character.isUpperCase(this)'.
*
* @param self a Character
* @return true if the character is uppercase
* @see java.lang.Character#isUpperCase(char)
* @since 1.5.7
*/
public static boolean isUpperCase(Character self) {
return Character.isUpperCase(self);
}
/**
* Determine if a Character is lowercase.
* Synonym for 'Character.isLowerCase(this)'.
*
* @param self a Character
* @return true if the character is lowercase
* @see java.lang.Character#isLowerCase(char)
* @since 1.5.7
*/
public static boolean isLowerCase(Character self) {
return Character.isLowerCase(self);
}
/**
* Determines if a character is a letter.
* Synonym for 'Character.isLetter(this)'.
*
* @param self a Character
* @return true if the character is a letter
* @see java.lang.Character#isLetter(char)
* @since 1.5.7
*/
public static boolean isLetter(Character self) {
return Character.isLetter(self);
}
/**
* Determines if a character is a digit.
* Synonym for 'Character.isDigit(this)'.
*
* @param self a Character
* @return true if the character is a digit
* @see java.lang.Character#isDigit(char)
* @since 1.5.7
*/
public static boolean isDigit(Character self) {
return Character.isDigit(self);
}
/**
* Determines if a character is a letter or digit.
* Synonym for 'Character.isLetterOrDigit(this)'.
*
* @param self a Character
* @return true if the character is a letter or digit
* @see java.lang.Character#isLetterOrDigit(char)
* @since 1.5.7
*/
public static boolean isLetterOrDigit(Character self) {
return Character.isLetterOrDigit(self);
}
/**
* Determines if a character is a whitespace character.
* Synonym for 'Character.isWhitespace(this)'.
*
* @param self a Character
* @return true if the character is a whitespace character
* @see java.lang.Character#isWhitespace(char)
* @since 1.5.7
*/
public static boolean isWhitespace(Character self) {
return Character.isWhitespace(self);
}
/**
* Converts the character to uppercase.
* Synonym for 'Character.toUpperCase(this)'.
*
* @param self a Character to convert
* @return the uppercase equivalent of the character, if any;
* otherwise, the character itself.
* @see java.lang.Character#isUpperCase(char)
* @see java.lang.String#toUpperCase()
* @since 1.5.7
*/
public static char toUpperCase(Character self) {
return Character.toUpperCase(self);
}
/**
* Converts the character to lowercase.
* Synonym for 'Character.toLowerCase(this)'.
*
* @param self a Character to convert
* @return the lowercase equivalent of the character, if any;
* otherwise, the character itself.
* @see java.lang.Character#isLowerCase(char)
* @see java.lang.String#toLowerCase()
* @since 1.5.7
*/
public static char toLowerCase(Character self) {
return Character.toLowerCase(self);
}
/**
* Transform a Number into an Integer
*
* @param self a Number
* @return an Integer
* @since 1.0
*/
public static Integer toInteger(Number self) {
return self.intValue();
}
/**
* Transform a Number into a Long
*
* @param self a Number
* @return a Long
* @since 1.0
*/
public static Long toLong(Number self) {
return self.longValue();
}
/**
* Transform a Number into a Float
*
* @param self a Number
* @return a Float
* @since 1.0
*/
public static Float toFloat(Number self) {
return self.floatValue();
}
/**
* Transform a Number into a Double
*
* @param self a Number
* @return a Double
* @since 1.0
*/
public static Double toDouble(Number self) {
// Conversions in which all decimal digits are known to be good.
if ((self instanceof Double)
|| (self instanceof Long)
|| (self instanceof Integer)
|| (self instanceof Short)
|| (self instanceof Byte))
{
return self.doubleValue();
}
// Chances are this is a Float or a Big.
// With Float we're extending binary precision and that gets ugly in decimal.
// If we used Float.doubleValue() on 0.1f we get 0.10000000149011612.
// Note that this is different than casting '(double) 0.1f' which will do the
// binary extension just like in Java.
// With Bigs and other unknowns, this is likely to be the same.
return Double.valueOf(self.toString());
}
/**
* Transform a Number into a BigDecimal
*
* @param self a Number
* @return a BigDecimal
* @since 1.0
*/
public static BigDecimal toBigDecimal(Number self) {
// Quick method for scalars.
if ((self instanceof Long)
|| (self instanceof Integer)
|| (self instanceof Short)
|| (self instanceof Byte))
{
return BigDecimal.valueOf(self.longValue());
}
return new BigDecimal(self.toString());
}
/**
* Transform this number to a the given type, using the 'as' operator. The
* following types are supported in addition to the default
* {@link #asType(java.lang.Object, java.lang.Class)}:
* <ul>
* <li>BigDecimal</li>
* <li>BigInteger</li>
* <li>Double</li>
* <li>Float</li>
* </ul>
* @param self this number
* @param c the desired type of the transformed result
* @return an instance of the given type
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Number self, Class<T> c) {
if (c == BigDecimal.class) {
return (T) toBigDecimal(self);
} else if (c == BigInteger.class) {
return (T) toBigInteger(self);
} else if (c == Double.class) {
return (T) toDouble(self);
} else if (c == Float.class) {
return (T) toFloat(self);
}
return asType((Object) self, c);
}
/**
* Transform this Number into a BigInteger.
*
* @param self a Number
* @return a BigInteger
* @since 1.0
*/
public static BigInteger toBigInteger(Number self) {
if (self instanceof BigInteger) {
return (BigInteger) self;
} else if (self instanceof BigDecimal) {
return ((BigDecimal) self).toBigInteger();
} else if (self instanceof Double) {
return new BigDecimal((Double)self).toBigInteger();
} else if (self instanceof Float) {
return new BigDecimal((Float)self).toBigInteger();
} else {
return new BigInteger(Long.toString(self.longValue()));
}
}
// Boolean based methods
//-------------------------------------------------------------------------
/**
* Logical conjunction of two boolean operators.
*
* @param left left operator
* @param right right operator
* @return result of logical conjunction
* @since 1.0
*/
public static Boolean and(Boolean left, Boolean right) {
return left && Boolean.TRUE.equals(right);
}
/**
* Logical disjunction of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of logical disjunction
* @since 1.0
*/
public static Boolean or(Boolean left, Boolean right) {
return left || Boolean.TRUE.equals(right);
}
/**
* Logical implication of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of logical implication
* @since 1.8.3
*/
public static Boolean implies(Boolean left, Boolean right) {
return !left || Boolean.TRUE.equals(right);
}
/**
* Exclusive disjunction of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of exclusive disjunction
* @since 1.0
*/
public static Boolean xor(Boolean left, Boolean right) {
return left ^ Boolean.TRUE.equals(right);
}
// public static Boolean negate(Boolean left) {
// return Boolean.valueOf(!left.booleanValue());
// }
/**
* Allows a simple syntax for using timers. This timer will execute the
* given closure after the given delay.
*
* @param timer a timer object
* @param delay the delay in milliseconds before running the closure code
* @param closure the closure to invoke
* @return The timer task which has been scheduled.
* @since 1.5.0
*/
public static TimerTask runAfter(Timer timer, int delay, final Closure closure) {
TimerTask timerTask = new TimerTask() {
public void run() {
closure.call();
}
};
timer.schedule(timerTask, delay);
return timerTask;
}
/**
* Traverse through each byte of this Byte array. Alias for each.
*
* @param self a Byte array
* @param closure a closure
* @see #each(java.lang.Object, groovy.lang.Closure)
* @since 1.5.5
*/
public static void eachByte(Byte[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(self, closure);
}
/**
* Traverse through each byte of this byte array. Alias for each.
*
* @param self a byte array
* @param closure a closure
* @see #each(java.lang.Object, groovy.lang.Closure)
* @since 1.5.5
*/
public static void eachByte(byte[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(self, closure);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index of the first item that matches the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 1.0
*/
public static int findIndexOf(Object self, Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting from a
* specified startIndex, and returns the index of the first item that matches the
* condition specified in the closure.
* Example (aggregate is {@code ChronoUnit} enum values):
* <pre class="groovyTestCase">
* import java.time.temporal.ChronoUnit
* def nameStartsWithM = { it.name().startsWith('M') }
* def first = ChronoUnit.findIndexOf(nameStartsWithM)
* def second = ChronoUnit.findIndexOf(first + 1, nameStartsWithM)
* def third = ChronoUnit.findIndexOf(second + 1, nameStartsWithM)
* Set units = [first, second, third]
* assert !units.contains(-1) // should have found 3 of MICROS, MILLIS, MINUTES, MONTHS, ...
* assert units.size() == 3 // just check size so as not to rely on order
* </pre>
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 1.5.0
*/
public static int findIndexOf(Object self, int startIndex, Closure condition) {
return findIndexOf(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterator<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int result = -1;
int i = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (i++ < startIndex) {
continue;
}
if (bcw.call(value)) {
result = i - 1;
break;
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterable<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Array
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Array, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexOf(new ArrayIterator<>(self), startIndex, condition);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index of the last item that matches the condition specified in the closure.
* Example (aggregate is {@code ChronoUnit} enum values):
* <pre class="groovyTestCase">
* import java.time.temporal.ChronoUnit
* def nameStartsWithM = { it.name().startsWith('M') }
* def first = ChronoUnit.findIndexOf(nameStartsWithM)
* def last = ChronoUnit.findLastIndexOf(nameStartsWithM)
* // should have found 2 unique index values for MICROS, MILLIS, MINUTES, MONTHS, ...
* assert first != -1 && last != -1 && first != last
* </pre>
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 1.5.2
*/
public static int findLastIndexOf(Object self, Closure condition) {
return findLastIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 1.5.2
*/
public static int findLastIndexOf(Object self, int startIndex, Closure condition) {
return findLastIndexOf(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterator<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int result = -1;
int i = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (i++ < startIndex) {
continue;
}
if (bcw.call(value)) {
result = i - 1;
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self.iterator(), 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterable<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Array
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findLastIndexOf(new ArrayIterator<>(self), 0, condition);
}
/**
* Iterates over the elements of an Array, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
// TODO could be made more efficient by using a reverse index
return findLastIndexOf(new ArrayIterator<>(self), startIndex, condition);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 1.5.2
*/
public static List<Number> findIndexValues(Object self, Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 1.5.2
*/
public static List<Number> findIndexValues(Object self, Number startIndex, Closure condition) {
return findIndexValues(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterator<T> self, Number startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
List<Number> result = new ArrayList<>();
long count = 0;
long startCount = startIndex.longValue();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (count++ < startCount) {
continue;
}
if (bcw.call(value)) {
result.add(count - 1);
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterable<T> self, Number startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Array
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Array, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(T[] self, Number startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexValues(new ArrayIterator<>(self), startIndex, condition);
}
/**
* Iterates through the classloader parents until it finds a loader with a class
* named "org.codehaus.groovy.tools.RootLoader". If there is no such class
* <code>null</code> will be returned. The name is used for comparison because
* a direct comparison using == may fail as the class may be loaded through
* different classloaders.
*
* @param self a ClassLoader
* @return the rootLoader for the ClassLoader
* @see org.codehaus.groovy.tools.RootLoader
* @since 1.5.0
*/
public static ClassLoader getRootLoader(ClassLoader self) {
while (true) {
if (self == null) return null;
if (isRootLoaderClassOrSubClass(self)) return self;
self = self.getParent();
}
}
private static boolean isRootLoaderClassOrSubClass(ClassLoader self) {
Class current = self.getClass();
while(!current.getName().equals(Object.class.getName())) {
if(current.getName().equals(RootLoader.class.getName())) return true;
current = current.getSuperclass();
}
return false;
}
/**
* Converts a given object to a type. This method is used through
* the "as" operator and is overloadable as any other operator.
*
* @param obj the object to convert
* @param type the goal type
* @return the resulting object
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Object obj, Class<T> type) {
if (String.class == type) {
return (T) InvokerHelper.toString(obj);
}
// fall back to cast
try {
return (T) DefaultTypeTransformation.castToType(obj, type);
}
catch (GroovyCastException e) {
MetaClass mc = InvokerHelper.getMetaClass(obj);
if (mc instanceof ExpandoMetaClass) {
ExpandoMetaClass emc = (ExpandoMetaClass) mc;
Object mixedIn = emc.castToMixedType(obj, type);
if (mixedIn != null)
return (T) mixedIn;
}
if (type.isInterface()) {
try {
List<Class> interfaces = new ArrayList<>();
interfaces.add(type);
return (T) ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, obj);
} catch (GroovyRuntimeException cause) {
// ignore
}
}
throw e;
}
}
private static Object asArrayType(Object object, Class type) {
if (type.isAssignableFrom(object.getClass())) {
return object;
}
Collection list = DefaultTypeTransformation.asCollection(object);
int size = list.size();
Class elementType = type.getComponentType();
Object array = Array.newInstance(elementType, size);
int idx = 0;
if (boolean.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setBoolean(array, idx, (Boolean) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, boolean.class}));
}
} else if (byte.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setByte(array, idx, (Byte) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, byte.class}));
}
} else if (char.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setChar(array, idx, (Character) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, char.class}));
}
} else if (double.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setDouble(array, idx, (Double) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, double.class}));
}
} else if (float.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setFloat(array, idx, (Float) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, float.class}));
}
} else if (int.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setInt(array, idx, (Integer) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, int.class}));
}
} else if (long.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setLong(array, idx, (Long) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, long.class}));
}
} else if (short.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setShort(array, idx, (Short) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, short.class}));
}
} else for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.set(array, idx, InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, elementType}));
}
return array;
}
/**
* Convenience method to dynamically create a new instance of this
* class. Calls the default constructor.
*
* @param c a class
* @return a new instance of this class
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> c) {
return (T) InvokerHelper.invokeConstructorOf(c, null);
}
/**
* Helper to construct a new instance from the given arguments.
* The constructor is called based on the number and types in the
* args array. Use <code>newInstance(null)</code> or simply
* <code>newInstance()</code> for the default (no-arg) constructor.
*
* @param c a class
* @param args the constructor arguments
* @return a new instance of this class.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> c, Object[] args) {
if (args == null) args = new Object[]{null};
return (T) InvokerHelper.invokeConstructorOf(c, args);
}
/**
* Adds a "metaClass" property to all class objects so you can use the syntax
* <code>String.metaClass.myMethod = { println "foo" }</code>
*
* @param c The java.lang.Class instance
* @return An MetaClass instance
* @since 1.5.0
*/
public static MetaClass getMetaClass(Class c) {
MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
MetaClass mc = metaClassRegistry.getMetaClass(c);
if (mc instanceof ExpandoMetaClass
|| mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee() instanceof ExpandoMetaClass)
return mc;
else {
return new HandleMetaClass(mc);
}
}
/**
* Obtains a MetaClass for an object either from the registry or in the case of
* a GroovyObject from the object itself.
*
* @param obj The object in question
* @return The MetaClass
* @since 1.5.0
*/
public static MetaClass getMetaClass(Object obj) {
MetaClass mc = InvokerHelper.getMetaClass(obj);
return new HandleMetaClass(mc, obj);
}
/**
* Obtains a MetaClass for an object either from the registry or in the case of
* a GroovyObject from the object itself.
*
* @param obj The object in question
* @return The MetaClass
* @since 1.6.0
*/
public static MetaClass getMetaClass(GroovyObject obj) {
// we need this method as trick to guarantee correct method selection
return getMetaClass((Object)obj);
}
/**
* Sets the metaclass for a given class.
*
* @param self the class whose metaclass we wish to set
* @param metaClass the new MetaClass
* @since 1.6.0
*/
public static void setMetaClass(Class self, MetaClass metaClass) {
final MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
if (metaClass == null)
metaClassRegistry.removeMetaClass(self);
else {
if (metaClass instanceof HandleMetaClass) {
metaClassRegistry.setMetaClass(self, ((HandleMetaClass)metaClass).getAdaptee());
} else {
metaClassRegistry.setMetaClass(self, metaClass);
}
if (self==NullObject.class) {
NullObject.getNullObject().setMetaClass(metaClass);
}
}
}
/**
* Set the metaclass for an object.
* @param self the object whose metaclass we want to set
* @param metaClass the new metaclass value
* @since 1.6.0
*/
public static void setMetaClass(Object self, MetaClass metaClass) {
if (metaClass instanceof HandleMetaClass)
metaClass = ((HandleMetaClass)metaClass).getAdaptee();
if (self instanceof Class) {
GroovySystem.getMetaClassRegistry().setMetaClass((Class) self, metaClass);
} else {
((MetaClassRegistryImpl)GroovySystem.getMetaClassRegistry()).setMetaClass(self, metaClass);
}
}
/**
* Set the metaclass for a GroovyObject.
* @param self the object whose metaclass we want to set
* @param metaClass the new metaclass value
* @since 2.0.0
*/
public static void setMetaClass(GroovyObject self, MetaClass metaClass) {
// this method was introduced as to prevent from a stack overflow, described in GROOVY-5285
if (metaClass instanceof HandleMetaClass)
metaClass = ((HandleMetaClass)metaClass).getAdaptee();
self.setMetaClass(metaClass);
disablePrimitiveOptimization(self);
}
private static void disablePrimitiveOptimization(Object self) {
Field sdyn;
Class c = self.getClass();
try {
sdyn = c.getDeclaredField(Verifier.STATIC_METACLASS_BOOL);
sdyn.setBoolean(null, true);
} catch (Throwable e) {
//DO NOTHING
}
}
/**
* Sets/updates the metaclass for a given class to a closure.
*
* @param self the class whose metaclass we wish to update
* @param closure the closure representing the new metaclass
* @return the new metaclass value
* @throws GroovyRuntimeException if the metaclass can't be set for this class
* @since 1.6.0
*/
public static MetaClass metaClass(Class self, @ClosureParams(value=SimpleType.class, options="java.lang.Object")
@DelegatesTo(type="groovy.lang.ExpandoMetaClass.DefiningClosure", strategy=Closure.DELEGATE_ONLY) Closure closure) {
MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
MetaClass mc = metaClassRegistry.getMetaClass(self);
if (mc instanceof ExpandoMetaClass) {
((ExpandoMetaClass) mc).define(closure);
return mc;
}
else {
if (mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee() instanceof ExpandoMetaClass) {
((ExpandoMetaClass)((DelegatingMetaClass) mc).getAdaptee()).define(closure);
return mc;
}
else {
if (mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee().getClass() == MetaClassImpl.class) {
ExpandoMetaClass emc = new ExpandoMetaClass(self, false, true);
emc.initialize();
emc.define(closure);
((DelegatingMetaClass) mc).setAdaptee(emc);
return mc;
}
else {
if (mc.getClass() == MetaClassImpl.class) {
// default case
mc = new ExpandoMetaClass(self, false, true);
mc.initialize();
((ExpandoMetaClass)mc).define(closure);
metaClassRegistry.setMetaClass(self, mc);
return mc;
}
else {
throw new GroovyRuntimeException("Can't add methods to custom meta class " + mc);
}
}
}
}
}
/**
* Sets/updates the metaclass for a given object to a closure.
*
* @param self the object whose metaclass we wish to update
* @param closure the closure representing the new metaclass
* @return the new metaclass value
* @throws GroovyRuntimeException if the metaclass can't be set for this object
* @since 1.6.0
*/
public static MetaClass metaClass(Object self, @ClosureParams(value=SimpleType.class, options="java.lang.Object")
@DelegatesTo(type="groovy.lang.ExpandoMetaClass.DefiningClosure", strategy=Closure.DELEGATE_ONLY) Closure closure) {
MetaClass emc = hasPerInstanceMetaClass(self);
if (emc == null) {
final ExpandoMetaClass metaClass = new ExpandoMetaClass(self.getClass(), false, true);
metaClass.initialize();
metaClass.define(closure);
if (self instanceof GroovyObject) {
setMetaClass((GroovyObject)self, metaClass);
} else {
setMetaClass(self, metaClass);
}
return metaClass;
}
else {
if (emc instanceof ExpandoMetaClass) {
((ExpandoMetaClass)emc).define(closure);
return emc;
}
else {
if (emc instanceof DelegatingMetaClass && ((DelegatingMetaClass)emc).getAdaptee() instanceof ExpandoMetaClass) {
((ExpandoMetaClass)((DelegatingMetaClass)emc).getAdaptee()).define(closure);
return emc;
}
else {
throw new RuntimeException("Can't add methods to non-ExpandoMetaClass " + emc);
}
}
}
}
private static MetaClass hasPerInstanceMetaClass(Object object) {
if (object instanceof GroovyObject) {
MetaClass mc = ((GroovyObject)object).getMetaClass();
if (mc == GroovySystem.getMetaClassRegistry().getMetaClass(object.getClass()) || mc.getClass() == MetaClassImpl.class)
return null;
else
return mc;
}
else {
ClassInfo info = ClassInfo.getClassInfo(object.getClass());
info.lock();
try {
return info.getPerInstanceMetaClass(object);
}
finally {
info.unlock();
}
}
}
/**
* Attempts to create an Iterator for the given object by first
* converting it to a Collection.
*
* @param a an array
* @return an Iterator for the given Array.
* @see org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation#asCollection(java.lang.Object[])
* @since 1.6.4
*/
public static <T> Iterator<T> iterator(T[] a) {
return DefaultTypeTransformation.asCollection(a).iterator();
}
/**
* Attempts to create an Iterator for the given object by first
* converting it to a Collection.
*
* @param o an object
* @return an Iterator for the given Object.
* @see org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation#asCollection(java.lang.Object)
* @since 1.0
*/
public static Iterator iterator(Object o) {
return DefaultTypeTransformation.asCollection(o).iterator();
}
/**
* Allows an Enumeration to behave like an Iterator. Note that the
* {@link java.util.Iterator#remove() remove()} method is unsupported since the
* underlying Enumeration does not provide a mechanism for removing items.
*
* @param enumeration an Enumeration object
* @return an Iterator for the given Enumeration
* @since 1.0
*/
public static <T> Iterator<T> iterator(final Enumeration<T> enumeration) {
return new Iterator<T>() {
public boolean hasNext() {
return enumeration.hasMoreElements();
}
public T next() {
return enumeration.nextElement();
}
public void remove() {
throw new UnsupportedOperationException("Cannot remove() from an Enumeration");
}
};
}
/**
* An identity function for iterators, supporting 'duck-typing' when trying to get an
* iterator for each object within a collection, some of which may already be iterators.
*
* @param self an iterator object
* @return itself
* @since 1.5.0
*/
public static <T> Iterator<T> iterator(Iterator<T> self) {
return self;
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].iterator().buffered().with { [head(), toList()] } == [1, [1, 2, 3, 4]]
* </pre>
*
* @param self an iterator object
* @return a BufferedIterator wrapping self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> buffered(Iterator<T> self) {
if (self instanceof BufferedIterator) {
return (BufferedIterator<T>) self;
} else {
return new IteratorBufferedIterator<>(self);
}
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert new LinkedHashSet([1,2,3,4]).bufferedIterator().with { [head(), toList()] } == [1, [1,2,3,4]]
* </pre>
*
* @param self an iterable object
* @return a BufferedIterator for traversing self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> bufferedIterator(Iterable<T> self) {
return new IteratorBufferedIterator<>(self.iterator());
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].bufferedIterator().with { [head(), toList()] } == [1, [1, 2, 3, 4]]
* </pre>
*
* @param self a list
* @return a BufferedIterator for traversing self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> bufferedIterator(List<T> self) {
return new ListBufferedIterator<>(self);
}
/**
* <p>Returns an object satisfying Groovy truth if the implementing MetaClass responds to
* a method with the given name and arguments types.
*
* <p>Note that this method's return value is based on realised methods and does not take into account
* objects or classes that implement invokeMethod or methodMissing
*
* <p>This method is "safe" in that it will always return a value and never throw an exception
*
* @param self The object to inspect
* @param name The name of the method of interest
* @param argTypes The argument types to match against
* @return A List of MetaMethods matching the argument types which will be empty if no matching methods exist
* @see groovy.lang.MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String, java.lang.Object[])
* @since 1.6.0
*/
public static List<MetaMethod> respondsTo(Object self, String name, Object[] argTypes) {
return InvokerHelper.getMetaClass(self).respondsTo(self, name, argTypes);
}
/**
* <p>Returns an object satisfying Groovy truth if the implementing MetaClass responds to
* a method with the given name regardless of the arguments.
*
* <p>Note that this method's return value is based on realised methods and does not take into account
* objects or classes that implement invokeMethod or methodMissing
*
* <p>This method is "safe" in that it will always return a value and never throw an exception
*
* @param self The object to inspect
* @param name The name of the method of interest
* @return A List of MetaMethods matching the given name or an empty list if no matching methods exist
* @see groovy.lang.MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String)
* @since 1.6.1
*/
public static List<MetaMethod> respondsTo(Object self, String name) {
return InvokerHelper.getMetaClass(self).respondsTo(self, name);
}
/**
* <p>Returns true of the implementing MetaClass has a property of the given name
*
* <p>Note that this method will only return true for realised properties and does not take into
* account implementation of getProperty or propertyMissing
*
* @param self The object to inspect
* @param name The name of the property of interest
* @return The found MetaProperty or null if it doesn't exist
* @see groovy.lang.MetaObjectProtocol#hasProperty(java.lang.Object, java.lang.String)
* @since 1.6.1
*/
public static MetaProperty hasProperty(Object self, String name) {
return InvokerHelper.getMetaClass(self).hasProperty(self, name);
}
/**
* Dynamically wraps an instance into something which implements the
* supplied trait classes. It is guaranteed that the returned object
* will implement the trait interfaces, but the original type of the
* object is lost (replaced with a proxy).
* @param self object to be wrapped
* @param traits a list of trait classes
* @return a proxy implementing the trait interfaces
*/
public static Object withTraits(Object self, Class<?>... traits) {
List<Class> interfaces = new ArrayList<>();
Collections.addAll(interfaces, traits);
return ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, self);
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert [1, 3, 2, 4] == [1, 2, 3, 4].swap(1, 2)
* </pre>
*
* @param self a List
* @param i a position
* @param j a position
* @return self
* @see Collections#swap(List, int, int)
* @since 2.4.0
*/
public static <T> List<T> swap(List<T> self, int i, int j) {
Collections.swap(self, i, j);
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert (["a", "c", "b", "d"] as String[]) == (["a", "b", "c", "d"] as String[]).swap(1, 2)
* </pre>
*
* @param self an array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static <T> T[] swap(T[] self, int i, int j) {
T tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([false, true, false, true] as boolean[]) == ([false, false, true, true] as boolean[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static boolean[] swap(boolean[] self, int i, int j) {
boolean tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as byte[]) == ([1, 2, 3, 4] as byte[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static byte[] swap(byte[] self, int i, int j) {
byte tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as char[]) == ([1, 2, 3, 4] as char[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static char[] swap(char[] self, int i, int j) {
char tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as double[]) == ([1, 2, 3, 4] as double[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static double[] swap(double[] self, int i, int j) {
double tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as float[]) == ([1, 2, 3, 4] as float[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static float[] swap(float[] self, int i, int j) {
float tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as int[]) == ([1, 2, 3, 4] as int[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static int[] swap(int[] self, int i, int j) {
int tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as long[]) == ([1, 2, 3, 4] as long[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static long[] swap(long[] self, int i, int j) {
long tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as short[]) == ([1, 2, 3, 4] as short[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static short[] swap(short[] self, int i, int j) {
short tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Modifies this list by removing the element at the specified position
* in this list. Returns the removed element. Essentially an alias for
* {@link List#remove(int)} but with no ambiguity for List<Integer>.
* <p/>
* Example:
* <pre class="groovyTestCase">
* def list = [1, 2, 3]
* list.removeAt(1)
* assert [1, 3] == list
* </pre>
*
* @param self a List
* @param index the index of the element to be removed
* @return the element previously at the specified position
* @since 2.4.0
*/
public static <E> E removeAt(List<E> self, int index) {
return self.remove(index);
}
/**
* Modifies this collection by removing a single instance of the specified
* element from this collection, if it is present. Essentially an alias for
* {@link Collection#remove(Object)} but with no ambiguity for Collection<Integer>.
* <p/>
* Example:
* <pre class="groovyTestCase">
* def list = [1, 2, 3, 2]
* list.removeElement(2)
* assert [1, 3, 2] == list
* </pre>
*
* @param self a Collection
* @param o element to be removed from this collection, if present
* @return true if an element was removed as a result of this call
* @since 2.4.0
*/
public static <E> boolean removeElement(Collection<E> self, Object o) {
return self.remove(o);
}
/**
* Get runtime groovydoc
* @param holder the groovydoc hold
* @return runtime groovydoc
* @since 2.6.0
*/
public static groovy.lang.groovydoc.Groovydoc getGroovydoc(AnnotatedElement holder) {
Groovydoc groovydocAnnotation = holder.getAnnotation(Groovydoc.class);
return null == groovydocAnnotation
? EMPTY_GROOVYDOC
: new groovy.lang.groovydoc.Groovydoc(groovydocAnnotation.value(), holder);
}
@Deprecated
public static <T> T asType(CharSequence self, Class<T> c) {
return StringGroovyMethods.asType(self, c);
}
/**
* Get the detail information of {@link Throwable} instance's stack trace
*
* @param self a Throwable instance
* @return the detail information of stack trace
* @since 2.5.3
*/
public static String asString(Throwable self) {
StringBuilderWriter sw = new StringBuilderWriter();
try (PrintWriter pw = new PrintWriter(sw)) {
self.printStackTrace(pw);
}
return sw.toString();
}
}
| src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.codehaus.groovy.runtime;
import groovy.io.GroovyPrintWriter;
import groovy.lang.Closure;
import groovy.lang.DelegatesTo;
import groovy.lang.DelegatingMetaClass;
import groovy.lang.EmptyRange;
import groovy.lang.ExpandoMetaClass;
import groovy.lang.GroovyObject;
import groovy.lang.GroovyRuntimeException;
import groovy.lang.GroovySystem;
import groovy.lang.Groovydoc;
import groovy.lang.IntRange;
import groovy.lang.ListWithDefault;
import groovy.lang.MapWithDefault;
import groovy.lang.MetaClass;
import groovy.lang.MetaClassImpl;
import groovy.lang.MetaClassRegistry;
import groovy.lang.MetaMethod;
import groovy.lang.MetaProperty;
import groovy.lang.MissingPropertyException;
import groovy.lang.ObjectRange;
import groovy.lang.PropertyValue;
import groovy.lang.Range;
import groovy.lang.SpreadMap;
import groovy.lang.Tuple2;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FirstParam;
import groovy.transform.stc.FromString;
import groovy.transform.stc.MapEntryOrKeyValue;
import groovy.transform.stc.SimpleType;
import groovy.util.BufferedIterator;
import groovy.util.ClosureComparator;
import groovy.util.GroovyCollections;
import groovy.util.MapEntry;
import groovy.util.OrderBy;
import groovy.util.PermutationGenerator;
import groovy.util.ProxyGenerator;
import org.apache.groovy.io.StringBuilderWriter;
import org.codehaus.groovy.classgen.Verifier;
import org.codehaus.groovy.reflection.ClassInfo;
import org.codehaus.groovy.reflection.MixinInMetaClass;
import org.codehaus.groovy.reflection.ReflectionCache;
import org.codehaus.groovy.reflection.ReflectionUtils;
import org.codehaus.groovy.reflection.stdclasses.CachedSAMClass;
import org.codehaus.groovy.runtime.callsite.BooleanClosureWrapper;
import org.codehaus.groovy.runtime.callsite.BooleanReturningMethodInvoker;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberDiv;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMinus;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberMultiply;
import org.codehaus.groovy.runtime.dgmimpl.NumberNumberPlus;
import org.codehaus.groovy.runtime.dgmimpl.arrays.BooleanArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.BooleanArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ByteArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ByteArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.CharacterArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.CharacterArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.DoubleArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.DoubleArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.FloatArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.FloatArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.IntegerArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.IntegerArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.LongArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.LongArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ObjectArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ObjectArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ShortArrayGetAtMetaMethod;
import org.codehaus.groovy.runtime.dgmimpl.arrays.ShortArrayPutAtMetaMethod;
import org.codehaus.groovy.runtime.metaclass.MetaClassRegistryImpl;
import org.codehaus.groovy.runtime.metaclass.MissingPropertyExceptionNoStack;
import org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation;
import org.codehaus.groovy.runtime.typehandling.GroovyCastException;
import org.codehaus.groovy.runtime.typehandling.NumberMath;
import org.codehaus.groovy.tools.RootLoader;
import org.codehaus.groovy.transform.trait.Traits;
import org.codehaus.groovy.util.ArrayIterator;
import org.codehaus.groovy.util.IteratorBufferedIterator;
import org.codehaus.groovy.util.ListBufferedIterator;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.Writer;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Array;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.lang.reflect.Proxy;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.math.RoundingMode;
import java.net.URL;
import java.security.AccessController;
import java.security.CodeSource;
import java.security.PrivilegedAction;
import java.text.MessageFormat;
import java.util.AbstractCollection;
import java.util.AbstractMap;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.BitSet;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Queue;
import java.util.Random;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.Stack;
import java.util.Timer;
import java.util.TimerTask;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.concurrent.BlockingQueue;
import java.util.logging.Logger;
import static groovy.lang.groovydoc.Groovydoc.EMPTY_GROOVYDOC;
/**
* This class defines new groovy methods which appear on normal JDK
* classes inside the Groovy environment. Static methods are used with the
* first parameter being the destination class,
* i.e. <code>public static String reverse(String self)</code>
* provides a <code>reverse()</code> method for <code>String</code>.
* <p>
* NOTE: While this class contains many 'public' static methods, it is
* primarily regarded as an internal class (its internal package name
* suggests this also). We value backwards compatibility of these
* methods when used within Groovy but value less backwards compatibility
* at the Java method call level. I.e. future versions of Groovy may
* remove or move a method call in this file but would normally
* aim to keep the method available from within Groovy.
*/
public class DefaultGroovyMethods extends DefaultGroovyMethodsSupport {
private static final Logger LOG = Logger.getLogger(DefaultGroovyMethods.class.getName());
private static final Integer ONE = 1;
private static final BigInteger BI_INT_MAX = BigInteger.valueOf(Integer.MAX_VALUE);
private static final BigInteger BI_INT_MIN = BigInteger.valueOf(Integer.MIN_VALUE);
private static final BigInteger BI_LONG_MAX = BigInteger.valueOf(Long.MAX_VALUE);
private static final BigInteger BI_LONG_MIN = BigInteger.valueOf(Long.MIN_VALUE);
public static final Class[] ADDITIONAL_CLASSES = {
NumberNumberPlus.class,
NumberNumberMultiply.class,
NumberNumberMinus.class,
NumberNumberDiv.class,
ObjectArrayGetAtMetaMethod.class,
ObjectArrayPutAtMetaMethod.class,
BooleanArrayGetAtMetaMethod.class,
BooleanArrayPutAtMetaMethod.class,
ByteArrayGetAtMetaMethod.class,
ByteArrayPutAtMetaMethod.class,
CharacterArrayGetAtMetaMethod.class,
CharacterArrayPutAtMetaMethod.class,
ShortArrayGetAtMetaMethod.class,
ShortArrayPutAtMetaMethod.class,
IntegerArrayGetAtMetaMethod.class,
IntegerArrayPutAtMetaMethod.class,
LongArrayGetAtMetaMethod.class,
LongArrayPutAtMetaMethod.class,
FloatArrayGetAtMetaMethod.class,
FloatArrayPutAtMetaMethod.class,
DoubleArrayGetAtMetaMethod.class,
DoubleArrayPutAtMetaMethod.class,
};
public static final Class[] DGM_LIKE_CLASSES = new Class[]{
DefaultGroovyMethods.class,
EncodingGroovyMethods.class,
IOGroovyMethods.class,
ProcessGroovyMethods.class,
ResourceGroovyMethods.class,
SocketGroovyMethods.class,
StringGroovyMethods.class//,
// Below are registered as module extension classes
// DateUtilExtensions.class,
// DateTimeStaticExtensions.class,
// DateTimeExtensions.class,
// SqlExtensions.class,
// SwingGroovyMethods.class,
// XmlExtensions.class,
// NioExtensions.class
};
private static final Object[] EMPTY_OBJECT_ARRAY = new Object[0];
private static final NumberAwareComparator<Comparable> COMPARABLE_NUMBER_AWARE_COMPARATOR = new NumberAwareComparator<Comparable>();
/**
* Identity check. Since == is overridden in Groovy with the meaning of equality
* we need some fallback to check for object identity. Invoke using the
* 'is' method, like so: <code>def same = this.is(that)</code>
*
* @param self an object
* @param other an object to compare identity with
* @return true if self and other are both references to the same
* instance, false otherwise
* @since 1.0
*/
public static boolean is(Object self, Object other) {
return self == other;
}
/**
* Allows the closure to be called for the object reference self.
* Synonym for 'with()'.
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return result of calling the closure
* @see #with(Object, Closure)
* @since 1.0
*/
public static <T,U> T identity(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return DefaultGroovyMethods.with(self, closure);
}
/**
* Allows the closure to be called for the object reference self.
* <p>
* Any method invoked inside the closure will first be invoked on the
* self reference. For instance, the following method calls to the append()
* method are invoked on the StringBuilder instance:
* <pre class="groovyTestCase">
* def b = new StringBuilder().with {
* append('foo')
* append('bar')
* return it
* }
* assert b.toString() == 'foobar'
* </pre>
* This is commonly used to simplify object creation, such as this example:
* <pre>
* def p = new Person().with {
* firstName = 'John'
* lastName = 'Doe'
* return it
* }
* </pre>
* The other typical usage, uses the self object while creating some value:
* <pre>
* def fullName = person.with{ "$firstName $lastName" }
* </pre>
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return result of calling the closure
* @see #with(Object, boolean, Closure)
* @see #tap(Object, Closure)
* @since 1.5.0
*/
@SuppressWarnings("unchecked")
public static <T,U> T with(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return (T) with(self, false, (Closure<Object>)closure);
}
/**
* Allows the closure to be called for the object reference self.
* <p/>
* Any method invoked inside the closure will first be invoked on the
* self reference. For example, the following method calls to the append()
* method are invoked on the StringBuilder instance and then, because
* 'returning' is true, the self instance is returned:
* <pre class="groovyTestCase">
* def b = new StringBuilder().with(true) {
* append('foo')
* append('bar')
* }
* assert b.toString() == 'foobar'
* </pre>
* The returning parameter is commonly set to true when using with to simplify object
* creation, such as this example:
* <pre>
* def p = new Person().with(true) {
* firstName = 'John'
* lastName = 'Doe'
* }
* </pre>
* Alternatively, 'tap' is an alias for 'with(true)', so that method can be used instead.
*
* The other main use case for with is when returning a value calculated using self as shown here:
* <pre>
* def fullName = person.with(false){ "$firstName $lastName" }
* </pre>
* Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be ommitted instead.
*
* @param self the object to have a closure act upon
* @param returning if true, return the self object; otherwise, the result of calling the closure
* @param closure the closure to call on the object
* @return the self object or the result of calling the closure depending on 'returning'
* @see #with(Object, Closure)
* @see #tap(Object, Closure)
* @since 2.5.0
*/
public static <T,U extends T, V extends T> T with(
@DelegatesTo.Target("self") U self,
boolean returning,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
@SuppressWarnings("unchecked")
final Closure<V> clonedClosure = (Closure<V>) closure.clone();
clonedClosure.setResolveStrategy(Closure.DELEGATE_FIRST);
clonedClosure.setDelegate(self);
V result = clonedClosure.call(self);
return returning ? self : result;
}
/**
* Allows the closure to be called for the object reference self (similar
* to <code>with</code> and always returns self.
* <p>
* Any method invoked inside the closure will first be invoked on the
* self reference. For instance, the following method calls to the append()
* method are invoked on the StringBuilder instance:
* <pre>
* def b = new StringBuilder().tap {
* append('foo')
* append('bar')
* }
* assert b.toString() == 'foobar'
* </pre>
* This is commonly used to simplify object creation, such as this example:
* <pre>
* def p = new Person().tap {
* firstName = 'John'
* lastName = 'Doe'
* }
* </pre>
*
* @param self the object to have a closure act upon
* @param closure the closure to call on the object
* @return self
* @see #with(Object, boolean, Closure)
* @see #with(Object, Closure)
* @since 2.5.0
*/
@SuppressWarnings("unchecked")
public static <T,U> U tap(
@DelegatesTo.Target("self") U self,
@DelegatesTo(value=DelegatesTo.Target.class,
target="self",
strategy=Closure.DELEGATE_FIRST)
@ClosureParams(FirstParam.class)
Closure<T> closure) {
return (U) with(self, true, (Closure<Object>)closure);
}
/**
* Allows the subscript operator to be used to lookup dynamic property values.
* <code>bean[somePropertyNameExpression]</code>. The normal property notation
* of groovy is neater and more concise but only works with compile-time known
* property names.
*
* @param self the object to act upon
* @param property the property name of interest
* @return the property value
* @since 1.0
*/
public static Object getAt(Object self, String property) {
return InvokerHelper.getProperty(self, property);
}
/**
* Allows the subscript operator to be used to set dynamically named property values.
* <code>bean[somePropertyNameExpression] = foo</code>. The normal property notation
* of groovy is neater and more concise but only works with property names which
* are known at compile time.
*
* @param self the object to act upon
* @param property the name of the property to set
* @param newValue the value to set
* @since 1.0
*/
public static void putAt(Object self, String property, Object newValue) {
InvokerHelper.setProperty(self, property, newValue);
}
/**
* Generates a detailed dump string of an object showing its class,
* hashCode and fields.
*
* @param self an object
* @return the dump representation
* @since 1.0
*/
public static String dump(Object self) {
if (self == null) {
return "null";
}
StringBuilder buffer = new StringBuilder("<");
Class klass = self.getClass();
buffer.append(klass.getName());
buffer.append("@");
buffer.append(Integer.toHexString(self.hashCode()));
boolean groovyObject = self instanceof GroovyObject;
/*jes this may be rewritten to use the new getProperties() stuff
* but the original pulls out private variables, whereas getProperties()
* does not. What's the real use of dump() here?
*/
while (klass != null) {
for (final Field field : klass.getDeclaredFields()) {
if ((field.getModifiers() & Modifier.STATIC) == 0) {
if (groovyObject && field.getName().equals("metaClass")) {
continue;
}
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
ReflectionUtils.trySetAccessible(field);
return null;
});
buffer.append(" ");
buffer.append(field.getName());
buffer.append("=");
try {
buffer.append(InvokerHelper.toString(field.get(self)));
} catch (Exception e) {
buffer.append(e);
}
}
}
klass = klass.getSuperclass();
}
/* here is a different implementation that uses getProperties(). I have left
* it commented out because it returns a slightly different list of properties;
* i.e. it does not return privates. I don't know what dump() really should be doing,
* although IMO showing private fields is a no-no
*/
/*
List props = getProperties(self);
for(Iterator itr = props.keySet().iterator(); itr.hasNext(); ) {
String propName = itr.next().toString();
// the original skipped this, so I will too
if(pv.getName().equals("class")) continue;
if(pv.getName().equals("metaClass")) continue;
buffer.append(" ");
buffer.append(propName);
buffer.append("=");
try {
buffer.append(InvokerHelper.toString(props.get(propName)));
}
catch (Exception e) {
buffer.append(e);
}
}
*/
buffer.append(">");
return buffer.toString();
}
/**
* Retrieves the list of {@link groovy.lang.MetaProperty} objects for 'self' and wraps it
* in a list of {@link groovy.lang.PropertyValue} objects that additionally provide
* the value for each property of 'self'.
*
* @param self the receiver object
* @return list of {@link groovy.lang.PropertyValue} objects
* @see groovy.util.Expando#getMetaPropertyValues()
* @since 1.0
*/
public static List<PropertyValue> getMetaPropertyValues(Object self) {
MetaClass metaClass = InvokerHelper.getMetaClass(self);
List<MetaProperty> mps = metaClass.getProperties();
List<PropertyValue> props = new ArrayList<PropertyValue>(mps.size());
for (MetaProperty mp : mps) {
props.add(new PropertyValue(self, mp));
}
return props;
}
/**
* Convenience method that calls {@link #getMetaPropertyValues(java.lang.Object)}(self)
* and provides the data in form of simple key/value pairs, i.e. without
* type() information.
*
* @param self the receiver object
* @return meta properties as Map of key/value pairs
* @since 1.0
*/
public static Map getProperties(Object self) {
List<PropertyValue> metaProps = getMetaPropertyValues(self);
Map<String, Object> props = new LinkedHashMap<String, Object>(metaProps.size());
for (PropertyValue mp : metaProps) {
try {
props.put(mp.getName(), mp.getValue());
} catch (Exception e) {
LOG.throwing(self.getClass().getName(), "getProperty(" + mp.getName() + ")", e);
}
}
return props;
}
/**
* Scoped use method
*
* @param self any Object
* @param categoryClass a category class to use
* @param closure the closure to invoke with the category in place
* @return the value returned from the closure
* @since 1.0
*/
public static <T> T use(Object self, Class categoryClass, Closure<T> closure) {
return GroovyCategorySupport.use(categoryClass, closure);
}
/**
* Extend object with category methods.
* All methods for given class and all super classes will be added to the object.
*
* @param self any Class
* @param categoryClasses a category classes to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, List<Class> categoryClasses) {
MixinInMetaClass.mixinClassesToMetaClass(self, categoryClasses);
}
/**
* Extend class globally with category methods.
* All methods for given class and all super classes will be added to the class.
*
* @param self any Class
* @param categoryClasses a category classes to use
* @since 1.6.0
*/
public static void mixin(Class self, List<Class> categoryClasses) {
mixin(getMetaClass(self), categoryClasses);
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(Class self, Class categoryClass) {
mixin(getMetaClass(self), Collections.singletonList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(Class self, Class[] categoryClass) {
mixin(getMetaClass(self), Arrays.asList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, Class categoryClass) {
mixin(self, Collections.singletonList(categoryClass));
}
/**
* Extend class globally with category methods.
*
* @param self any Class
* @param categoryClass a category class to use
* @since 1.6.0
*/
public static void mixin(MetaClass self, Class[] categoryClass) {
mixin(self, Arrays.asList(categoryClass));
}
/**
* Gets the url of the jar file/source file containing the specified class
*
* @param self the class
* @return the url of the jar, {@code null} if the specified class is from JDK
* @since 2.5.0
*/
public static URL getLocation(Class self) {
CodeSource codeSource = self.getProtectionDomain().getCodeSource();
return null == codeSource ? null : codeSource.getLocation();
}
/**
* Scoped use method with list of categories.
*
* @param self any Object
* @param categoryClassList a list of category classes
* @param closure the closure to invoke with the categories in place
* @return the value returned from the closure
* @since 1.0
*/
public static <T> T use(Object self, List<Class> categoryClassList, Closure<T> closure) {
return GroovyCategorySupport.use(categoryClassList, closure);
}
/**
* Allows the usage of addShutdownHook without getting the runtime first.
*
* @param self the object the method is called on (ignored)
* @param closure the shutdown hook action
* @since 1.5.0
*/
public static void addShutdownHook(Object self, Closure closure) {
Runtime.getRuntime().addShutdownHook(new Thread(closure));
}
/**
* Allows you to use a list of categories, specifying the list as varargs.
* <code>use(CategoryClass1, CategoryClass2) { ... }</code>
* This method saves having to wrap the category
* classes in a list.
*
* @param self any Object
* @param array a list of category classes and a Closure
* @return the value returned from the closure
* @since 1.0
*/
public static Object use(Object self, Object[] array) {
if (array.length < 2)
throw new IllegalArgumentException(
"Expecting at least 2 arguments, a category class and a Closure");
Closure closure;
try {
closure = (Closure) array[array.length - 1];
} catch (ClassCastException e) {
throw new IllegalArgumentException("Expecting a Closure to be the last argument");
}
List<Class> list = new ArrayList<Class>(array.length - 1);
for (int i = 0; i < array.length - 1; ++i) {
Class categoryClass;
try {
categoryClass = (Class) array[i];
} catch (ClassCastException e) {
throw new IllegalArgumentException("Expecting a Category Class for argument " + i);
}
list.add(categoryClass);
}
return GroovyCategorySupport.use(list, closure);
}
/**
* Print a value formatted Groovy style to self if it
* is a Writer, otherwise to the standard output stream.
*
* @param self any Object
* @param value the value to print
* @since 1.0
*/
public static void print(Object self, Object value) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
try {
((Writer) self).write(InvokerHelper.toString(value));
} catch (IOException e) {
// TODO: Should we have some unified function like PrintWriter.checkError()?
}
} else {
System.out.print(InvokerHelper.toString(value));
}
}
/**
* Print a value formatted Groovy style to the print writer.
*
* @param self a PrintWriter
* @param value the value to print
* @since 1.0
*/
public static void print(PrintWriter self, Object value) {
self.print(InvokerHelper.toString(value));
}
/**
* Print a value formatted Groovy style to the print stream.
*
* @param self a PrintStream
* @param value the value to print
* @since 1.6.0
*/
public static void print(PrintStream self, Object value) {
self.print(InvokerHelper.toString(value));
}
/**
* Print a value to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param value the value to print
* @since 1.0
*/
public static void print(Closure self, Object value) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "print", new Object[]{value});
}
/**
* Print a linebreak to the standard output stream.
*
* @param self any Object
* @since 1.0
*/
public static void println(Object self) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
PrintWriter pw = new GroovyPrintWriter((Writer) self);
pw.println();
} else {
System.out.println();
}
}
/**
* Print a linebreak to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a closure
* @since 1.0
*/
public static void println(Closure self) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "println", EMPTY_OBJECT_ARRAY);
}
private static Object getClosureOwner(Closure cls) {
Object owner = cls.getOwner();
while (owner instanceof GeneratedClosure) {
owner = ((Closure) owner).getOwner();
}
return owner;
}
/**
* Print a value formatted Groovy style (followed by a newline) to self
* if it is a Writer, otherwise to the standard output stream.
*
* @param self any Object
* @param value the value to print
* @since 1.0
*/
public static void println(Object self, Object value) {
// we won't get here if we are a PrintWriter
if (self instanceof Writer) {
final PrintWriter pw = new GroovyPrintWriter((Writer) self);
pw.println(value);
} else {
System.out.println(InvokerHelper.toString(value));
}
}
/**
* Print a value formatted Groovy style (followed by a newline) to the print writer.
*
* @param self a PrintWriter
* @param value the value to print
* @since 1.0
*/
public static void println(PrintWriter self, Object value) {
self.println(InvokerHelper.toString(value));
}
/**
* Print a value formatted Groovy style (followed by a newline) to the print stream.
*
* @param self any Object
* @param value the value to print
* @since 1.6.0
*/
public static void println(PrintStream self, Object value) {
self.println(InvokerHelper.toString(value));
}
/**
* Print a value (followed by a newline) to the standard output stream.
* This method delegates to the owner to execute the method.
*
* @param self a closure
* @param value the value to print
* @since 1.0
*/
public static void println(Closure self, Object value) {
Object owner = getClosureOwner(self);
InvokerHelper.invokeMethod(owner, "println", new Object[]{value});
}
/**
* Printf to the standard output stream.
*
* @param self any Object
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @since 1.0
*/
public static void printf(Object self, String format, Object[] values) {
if (self instanceof PrintStream)
((PrintStream)self).printf(format, values);
else
System.out.printf(format, values);
}
/**
* Printf 0 or more values to the standard output stream using a format string.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @since 3.0.0
*/
public static void printf(Closure self, String format, Object[] values) {
Object owner = getClosureOwner(self);
Object[] newValues = new Object[values.length + 1];
newValues[0] = format;
System.arraycopy(values, 0, newValues, 1, values.length);
InvokerHelper.invokeMethod(owner, "printf", newValues);
}
/**
* Printf a value to the standard output stream using a format string.
* This method delegates to the owner to execute the method.
*
* @param self a generated closure
* @param format a format string
* @param value value referenced by the format specifier in the format string
* @since 3.0.0
*/
public static void printf(Closure self, String format, Object value) {
Object owner = getClosureOwner(self);
Object[] newValues = new Object[2];
newValues[0] = format;
newValues[1] = value;
InvokerHelper.invokeMethod(owner, "printf", newValues);
}
/**
* Sprintf to a string.
*
* @param self any Object
* @param format a format string
* @param values values referenced by the format specifiers in the format string
* @return the resulting formatted string
* @since 1.5.0
*/
public static String sprintf(Object self, String format, Object[] values) {
ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
PrintStream out = new PrintStream(outputStream);
out.printf(format, values);
return outputStream.toString();
}
/**
* Prints a formatted string using the specified format string and arguments.
* <p>
* Examples:
* <pre>
* printf ( "Hello, %s!\n" , [ "world" ] as String[] )
* printf ( "Hello, %s!\n" , [ "Groovy" ])
* printf ( "%d + %d = %d\n" , [ 1 , 2 , 1+2 ] as Integer[] )
* printf ( "%d + %d = %d\n" , [ 3 , 3 , 3+3 ])
*
* ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as Integer[] ) }
* ( 1..5 ).each { printf ( "-- %d\n" , [ it ] as int[] ) }
* ( 0x41..0x45 ).each { printf ( "-- %c\n" , [ it ] as char[] ) }
* ( 07..011 ).each { printf ( "-- %d\n" , [ it ] as byte[] ) }
* ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as short[] ) }
* ( 7..11 ).each { printf ( "-- %d\n" , [ it ] as long[] ) }
* ( 7..11 ).each { printf ( "-- %5.2f\n" , [ it ] as float[] ) }
* ( 7..11 ).each { printf ( "-- %5.2g\n" , [ it ] as double[] ) }
* </pre>
*
* @param self any Object
* @param format A format string
* @param arg Argument which is referenced by the format specifiers in the format
* string. The type of <code>arg</code> should be one of Object[], List,
* int[], short[], byte[], char[], boolean[], long[], float[], or double[].
* @since 1.0
*/
public static void printf(Object self, String format, Object arg) {
if (self instanceof PrintStream)
printf((PrintStream) self, format, arg);
else if (self instanceof Writer)
printf((Writer) self, format, arg);
else
printf(System.out, format, arg);
}
private static void printf(PrintStream self, String format, Object arg) {
self.print(sprintf(self, format, arg));
}
private static void printf(Writer self, String format, Object arg) {
try {
self.write(sprintf(self, format, arg));
} catch (IOException e) {
printf(System.out, format, arg);
}
}
/**
* Returns a formatted string using the specified format string and
* arguments.
*
* @param self any Object
* @param format A format string
* @param arg Argument which is referenced by the format specifiers in the format
* string. The type of <code>arg</code> should be one of Object[], List,
* int[], short[], byte[], char[], boolean[], long[], float[], or double[].
* @return the resulting printf'd string
* @since 1.5.0
*/
public static String sprintf(Object self, String format, Object arg) {
if (arg instanceof Object[]) {
return sprintf(self, format, (Object[]) arg);
}
if (arg instanceof List) {
return sprintf(self, format, ((List) arg).toArray());
}
if (!arg.getClass().isArray()) {
Object[] o = (Object[]) java.lang.reflect.Array.newInstance(arg.getClass(), 1);
o[0] = arg;
return sprintf(self, format, o);
}
Object[] ans;
String elemType = arg.getClass().getName();
switch (elemType) {
case "[I":
int[] ia = (int[]) arg;
ans = new Integer[ia.length];
for (int i = 0; i < ia.length; i++) {
ans[i] = ia[i];
}
break;
case "[C":
char[] ca = (char[]) arg;
ans = new Character[ca.length];
for (int i = 0; i < ca.length; i++) {
ans[i] = ca[i];
}
break;
case "[Z": {
boolean[] ba = (boolean[]) arg;
ans = new Boolean[ba.length];
for (int i = 0; i < ba.length; i++) {
ans[i] = ba[i];
}
break;
}
case "[B": {
byte[] ba = (byte[]) arg;
ans = new Byte[ba.length];
for (int i = 0; i < ba.length; i++) {
ans[i] = ba[i];
}
break;
}
case "[S":
short[] sa = (short[]) arg;
ans = new Short[sa.length];
for (int i = 0; i < sa.length; i++) {
ans[i] = sa[i];
}
break;
case "[F":
float[] fa = (float[]) arg;
ans = new Float[fa.length];
for (int i = 0; i < fa.length; i++) {
ans[i] = fa[i];
}
break;
case "[J":
long[] la = (long[]) arg;
ans = new Long[la.length];
for (int i = 0; i < la.length; i++) {
ans[i] = la[i];
}
break;
case "[D":
double[] da = (double[]) arg;
ans = new Double[da.length];
for (int i = 0; i < da.length; i++) {
ans[i] = da[i];
}
break;
default:
throw new RuntimeException("sprintf(String," + arg + ")");
}
return sprintf(self, format, ans);
}
/**
* Inspects returns the String that matches what would be typed into a
* terminal to create this object.
*
* @param self any Object
* @return a String that matches what would be typed into a terminal to
* create this object. e.g. [1, 'hello'].inspect() {@code ->} [1, "hello"]
* @since 1.0
*/
public static String inspect(Object self) {
return InvokerHelper.inspect(self);
}
/**
* Print to a console in interactive format.
*
* @param self any Object
* @param out the PrintWriter used for printing
* @since 1.0
*/
public static void print(Object self, PrintWriter out) {
if (out == null) {
out = new PrintWriter(System.out);
}
out.print(InvokerHelper.toString(self));
}
/**
* Print to a console in interactive format.
*
* @param self any Object
* @param out the PrintWriter used for printing
* @since 1.0
*/
public static void println(Object self, PrintWriter out) {
if (out == null) {
out = new PrintWriter(System.out);
}
out.println(InvokerHelper.toString(self));
}
/**
* Provide a dynamic method invocation method which can be overloaded in
* classes to implement dynamic proxies easily.
*
* @param object any Object
* @param method the name of the method to call
* @param arguments the arguments to use
* @return the result of the method call
* @since 1.0
*/
public static Object invokeMethod(Object object, String method, Object arguments) {
return InvokerHelper.invokeMethod(object, method, arguments);
}
// isCase methods
//-------------------------------------------------------------------------
/**
* Method for overloading the behavior of the 'case' method in switch statements.
* The default implementation handles arrays types but otherwise simply delegates
* to Object#equals, but this may be overridden for other types. In this example:
* <pre> switch( a ) {
* case b: //some code
* }</pre>
* "some code" is called when <code>b.isCase( a )</code> returns
* <code>true</code>.
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the switchValue is deemed to be equal to the caseValue
* @since 1.0
*/
public static boolean isCase(Object caseValue, Object switchValue) {
if (caseValue.getClass().isArray()) {
return isCase(DefaultTypeTransformation.asCollection(caseValue), switchValue);
}
return caseValue.equals(switchValue);
}
/**
* Special 'Case' implementation for Class, which allows testing
* for a certain class in a switch statement.
* For example:
* <pre>switch( obj ) {
* case List :
* // obj is a list
* break;
* case Set :
* // etc
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the switchValue is deemed to be assignable from the given class
* @since 1.0
*/
public static boolean isCase(Class caseValue, Object switchValue) {
if (switchValue instanceof Class) {
Class val = (Class) switchValue;
return caseValue.isAssignableFrom(val);
}
return caseValue.isInstance(switchValue);
}
/**
* 'Case' implementation for collections which tests if the 'switch'
* operand is contained in any of the 'case' values.
* For example:
* <pre class="groovyTestCase">switch( 3 ) {
* case [1,3,5]:
* assert true
* break
* default:
* assert false
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the caseValue is deemed to contain the switchValue
* @see java.util.Collection#contains(java.lang.Object)
* @since 1.0
*/
public static boolean isCase(Collection caseValue, Object switchValue) {
return caseValue.contains(switchValue);
}
/**
* 'Case' implementation for maps which tests the groovy truth
* value obtained using the 'switch' operand as key.
* For example:
* <pre class="groovyTestCase">switch( 'foo' ) {
* case [foo:true, bar:false]:
* assert true
* break
* default:
* assert false
* }</pre>
*
* @param caseValue the case value
* @param switchValue the switch value
* @return the groovy truth value from caseValue corresponding to the switchValue key
* @since 1.7.6
*/
public static boolean isCase(Map caseValue, Object switchValue) {
return DefaultTypeTransformation.castToBoolean(caseValue.get(switchValue));
}
/**
* Special 'case' implementation for all numbers, which delegates to the
* <code>compareTo()</code> method for comparing numbers of different
* types.
*
* @param caseValue the case value
* @param switchValue the switch value
* @return true if the numbers are deemed equal
* @since 1.5.0
*/
public static boolean isCase(Number caseValue, Number switchValue) {
return NumberMath.compareTo(caseValue, switchValue) == 0;
}
/**
* Returns an iterator equivalent to this iterator with all duplicated items removed
* by using Groovy's default number-aware comparator. The original iterator will become
* exhausted of elements after determining the unique values. A new iterator
* for the unique values will be returned.
*
* @param self an Iterator
* @return a new Iterator of the unique items from the original iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self) {
return uniqueItems(new IteratorIterableAdapter<T>(self)).listIterator();
}
/**
* Modifies this collection to remove all duplicated items, using Groovy's
* default number-aware comparator.
* <pre class="groovyTestCase">assert [1,3] == [1,3,3].unique()</pre>
*
* @param self a collection
* @return the now modified collection
* @see #unique(Collection, boolean)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self) {
return unique(self, true);
}
/**
* Modifies this List to remove all duplicated items, using Groovy's
* default number-aware comparator.
* <pre class="groovyTestCase">assert [1,3] == [1,3,3].unique()</pre>
*
* @param self a List
* @return the now modified List
* @see #unique(Collection, boolean)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self) {
return (List<T>) unique((Collection<T>) self, true);
}
/**
* Remove all duplicates from a given Collection using Groovy's default number-aware comparator.
* If mutate is true, it works by modifying the original object (and also returning it).
* If mutate is false, a new collection is returned leaving the original unchanged.
* <pre class="groovyTestCase">
* assert [1,3] == [1,3,3].unique()
* </pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2, 3]
* def uniq = orig.unique(false)
* assert orig == [1, 3, 2, 3]
* assert uniq == [1, 3, 2]
* </pre>
*
* @param self a collection
* @param mutate false will cause a new list containing unique items from the collection to be created, true will mutate collections in place
* @return the now modified collection
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate) {
List<T> answer = uniqueItems(self);
if (mutate) {
self.clear();
self.addAll(answer);
}
return mutate ? self : answer ;
}
private static <T> List<T> uniqueItems(Iterable<T> self) {
List<T> answer = new ArrayList<T>();
for (T t : self) {
boolean duplicated = false;
for (T t2 : answer) {
if (coercedEquals(t, t2)) {
duplicated = true;
break;
}
}
if (!duplicated)
answer.add(t);
}
return answer;
}
/**
* Remove all duplicates from a given List using Groovy's default number-aware comparator.
* If mutate is true, it works by modifying the original object (and also returning it).
* If mutate is false, a new collection is returned leaving the original unchanged.
* <pre class="groovyTestCase">
* assert [1,3] == [1,3,3].unique()
* </pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2, 3]
* def uniq = orig.unique(false)
* assert orig == [1, 3, 2, 3]
* assert uniq == [1, 3, 2]
* </pre>
*
* @param self a List
* @param mutate false will cause a new List containing unique items from the List to be created, true will mutate List in place
* @return the now modified List
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate) {
return (List<T>) unique((Collection<T>) self, mutate);
}
/**
* Provides a method that compares two comparables using Groovy's
* default number aware comparator.
*
* @param self a Comparable
* @param other another Comparable
* @return a -ve number, 0 or a +ve number according to Groovy's compareTo contract
* @since 1.6.0
*/
public static int numberAwareCompareTo(Comparable self, Comparable other) {
return COMPARABLE_NUMBER_AWARE_COMPARATOR.compare(self, other);
}
/**
* Returns an iterator equivalent to this iterator but with all duplicated items
* removed by using a Closure to determine duplicate (equal) items.
* The original iterator will be fully processed after the call.
* <p>
* If the closure takes a single parameter, the argument passed will be each element,
* and the closure should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the Iterator
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
*
* @param self an Iterator
* @param condition a Closure used to determine unique items
* @return the modified Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<T>(condition, true)
: new ClosureComparator<T>(condition);
return unique(self, comparator);
}
/**
* A convenience method for making a collection unique using a Closure
* to determine duplicate (equal) items.
* <p>
* If the closure takes a single parameter, the
* argument passed will be each element, and the closure
* should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].unique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].unique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self a Collection
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @see #unique(Collection, boolean, Closure)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return unique(self, true, closure);
}
/**
* A convenience method for making a List unique using a Closure
* to determine duplicate (equal) items.
* <p>
* If the closure takes a single parameter, the
* argument passed will be each element, and the closure
* should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the List
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].unique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].unique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self a List
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @see #unique(Collection, boolean, Closure)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return (List<T>) unique((Collection<T>) self, true, closure);
}
/**
* A convenience method for making a collection unique using a Closure to determine duplicate (equal) items.
* If mutate is true, it works on the receiver object and returns it. If mutate is false, a new collection is returned.
* <p>
* If the closure takes a single parameter, each element from the Collection will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def orig = [1, 3, 4, 5]
* def uniq = orig.unique(false) { it % 2 }
* assert orig == [1, 3, 4, 5]
* assert uniq == [1, 4]
* </pre>
* <pre class="groovyTestCase">
* def orig = [2, 3, 3, 4]
* def uniq = orig.unique(false) { a, b {@code ->} a {@code <=>} b }
* assert orig == [2, 3, 3, 4]
* assert uniq == [2, 3, 4]
* </pre>
*
* @param self a Collection
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
// use a comparator of one item or two
int params = closure.getMaximumNumberOfParameters();
if (params == 1) {
self = unique(self, mutate, new OrderBy<T>(closure, true));
} else {
self = unique(self, mutate, new ClosureComparator<T>(closure));
}
return self;
}
/**
* A convenience method for making a List unique using a Closure to determine duplicate (equal) items.
* If mutate is true, it works on the receiver object and returns it. If mutate is false, a new collection is returned.
* <p>
* If the closure takes a single parameter, each element from the List will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the collection
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def orig = [1, 3, 4, 5]
* def uniq = orig.unique(false) { it % 2 }
* assert orig == [1, 3, 4, 5]
* assert uniq == [1, 4]
* </pre>
* <pre class="groovyTestCase">
* def orig = [2, 3, 3, 4]
* def uniq = orig.unique(false) { a, b {@code ->} a {@code <=>} b }
* assert orig == [2, 3, 3, 4]
* assert uniq == [2, 3, 4]
* </pre>
*
* @param self a List
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine unique items
* @return self without any duplicates
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return (List<T>) unique((Collection<T>) self, mutate, closure);
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the supplied comparator. The original iterator
* will be exhausted upon returning.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the modified Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> unique(Iterator<T> self, Comparator<T> comparator) {
return uniqueItems(new IteratorIterableAdapter<T>(self), comparator).listIterator();
}
private static final class IteratorIterableAdapter<T> implements Iterable<T> {
private final Iterator<T> self;
private IteratorIterableAdapter(Iterator<T> self) {
this.self = self;
}
@Override
public Iterator<T> iterator() {
return self;
}
}
/**
* Remove all duplicates from a given Collection.
* Works on the original object (and also returns it).
* The order of members in the Collection are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given Collection's iterator is retained, but all other ones are removed.
* The given Collection's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(new PersonComparator())
* assert( list2 == list {@code &&} list == [a, b, c] )
* </pre>
*
* @param self a Collection
* @param comparator a Comparator
* @return self the now modified collection without duplicates
* @see #unique(java.util.Collection, boolean, java.util.Comparator)
* @since 1.0
*/
public static <T> Collection<T> unique(Collection<T> self, Comparator<T> comparator) {
return unique(self, true, comparator) ;
}
/**
* Remove all duplicates from a given List.
* Works on the original object (and also returns it).
* The order of members in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given List's iterator is retained, but all other ones are removed.
* The given List's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(new PersonComparator())
* assert( list2 == list {@code &&} list == [a, b, c] )
* </pre>
*
* @param self a List
* @param comparator a Comparator
* @return self the now modified List without duplicates
* @see #unique(java.util.Collection, boolean, java.util.Comparator)
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, Comparator<T> comparator) {
return (List<T>) unique((Collection<T>) self, true, comparator);
}
/**
* Remove all duplicates from a given Collection.
* If mutate is true, it works on the original object (and also returns it). If mutate is false, a new collection is returned.
* The order of members in the Collection are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given Collection's iterator is retained, but all other ones are removed.
* The given Collection's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(false, new PersonComparator())
* assert( list2 != list {@code &&} list2 == [a, b, c] )
* </pre>
*
* @param self a Collection
* @param mutate false will always cause a new collection to be created, true will mutate collections in place
* @param comparator a Comparator
* @return self the collection without duplicates
* @since 1.8.1
*/
public static <T> Collection<T> unique(Collection<T> self, boolean mutate, Comparator<T> comparator) {
List<T> answer = uniqueItems(self, comparator);
if (mutate) {
self.clear();
self.addAll(answer);
}
return mutate ? self : answer;
}
private static <T> List<T> uniqueItems(Iterable<T> self, Comparator<T> comparator) {
List<T> answer = new ArrayList<T>();
for (T t : self) {
boolean duplicated = false;
for (T t2 : answer) {
if (comparator.compare(t, t2) == 0) {
duplicated = true;
break;
}
}
if (!duplicated)
answer.add(t);
}
return answer;
}
/**
* Remove all duplicates from a given List.
* If mutate is true, it works on the original object (and also returns it). If mutate is false, a new List is returned.
* The order of members in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned
* by the given List's iterator is retained, but all other ones are removed.
* The given List's original order is preserved.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.unique(false, new PersonComparator())
* assert( list2 != list {@code &&} list2 == [a, b, c] )
* </pre>
*
* @param self a List
* @param mutate false will always cause a new List to be created, true will mutate List in place
* @param comparator a Comparator
* @return self the List without duplicates
* @since 2.4.0
*/
public static <T> List<T> unique(List<T> self, boolean mutate, Comparator<T> comparator) {
return (List<T>) unique((Collection<T>) self, mutate, comparator);
}
/**
* Returns an iterator equivalent to this iterator but with all duplicated items
* removed where duplicate (equal) items are deduced by calling the supplied Closure condition.
* <p>
* If the supplied Closure takes a single parameter, the argument passed will be each element,
* and the closure should return a value used for comparison (either using
* {@link java.lang.Comparable#compareTo(java.lang.Object)} or {@link java.lang.Object#equals(java.lang.Object)}).
* If the closure takes two parameters, two items from the Iterator
* will be passed as arguments, and the closure should return an
* int value (with 0 indicating the items are not unique).
* <pre class="groovyTestCase">
* def items = "Hello".toList() + [null, null] + "there".toList()
* def toLower = { it == null ? null : it.toLowerCase() }
* def noDups = items.iterator().toUnique(toLower).toList()
* assert noDups == ['H', 'e', 'l', 'o', null, 't', 'r']
* </pre>
* <pre class="groovyTestCase">assert [1,4] == [1,3,4,5].toUnique { it % 2 }</pre>
* <pre class="groovyTestCase">assert [2,3,4] == [2,3,3,4].toUnique { a, b {@code ->} a {@code <=>} b }</pre>
*
* @param self an Iterator
* @param condition a Closure used to determine unique items
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
return toUnique(self, condition.getMaximumNumberOfParameters() == 1
? new OrderBy<T>(condition, true)
: new ClosureComparator<T>(condition));
}
private static final class ToUniqueIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final Set<E> seen;
private boolean exhausted;
private E next;
private ToUniqueIterator(Iterator<E> delegate, Comparator<E> comparator) {
this.delegate = delegate;
seen = new TreeSet<E>(comparator);
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
boolean foundNext = false;
while (!foundNext && !exhausted) {
exhausted = !delegate.hasNext();
if (!exhausted) {
next = delegate.next();
foundNext = seen.add(next);
}
}
}
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the supplied comparator.
*
* @param self an Iterator
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self, Comparator<T> comparator) {
return new ToUniqueIterator<T>(self, comparator);
}
/**
* Returns an iterator equivalent to this iterator with all duplicated
* items removed by using the natural ordering of the items.
*
* @param self an Iterator
* @return an Iterator with no duplicate items
* @since 2.4.0
*/
public static <T> Iterator<T> toUnique(Iterator<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed.
* The items in the Iterable are compared by the given Comparator.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.toUnique(new PersonComparator())
* assert list2 == [a, b, c] {@code &&} list == [a, b, c, d]
* </pre>
*
* @param self an Iterable
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the Collection of non-duplicate items
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self, Comparator<T> comparator) {
Collection<T> result = createSimilarCollection((Collection<T>) self);
addAll(result, toUnique(self.iterator(), comparator));
return result;
}
/**
* Returns a List containing the items from the List but with duplicates removed.
* The items in the List are compared by the given Comparator.
* For each duplicate, the first member which is returned from the
* List is retained, but all other ones are removed.
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* class PersonComparator implements Comparator {
* int compare(Object o1, Object o2) {
* Person p1 = (Person) o1
* Person p2 = (Person) o2
* if (p1.lname != p2.lname)
* return p1.lname.compareTo(p2.lname)
* else
* return p1.fname.compareTo(p2.fname)
* }
*
* boolean equals(Object obj) {
* return this.equals(obj)
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* List list2 = list.toUnique(new PersonComparator())
* assert list2 == [a, b, c] {@code &&} list == [a, b, c, d]
* </pre>
*
* @param self a List
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the List of non-duplicate items
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self, Comparator<T> comparator) {
return (List<T>) toUnique((Iterable<T>) self, comparator);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed
* using the natural ordering of the items to determine uniqueness.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* String[] expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique() == expected
* </pre>
*
* @param self an Iterable
* @return the Collection of non-duplicate items
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a List containing the items from the List but with duplicates removed
* using the natural ordering of the items to determine uniqueness.
* <p>
* <pre class="groovyTestCase">
* def letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* def expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique() == expected
* </pre>
*
* @param self a List
* @return the List of non-duplicate items
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self) {
return toUnique(self, (Comparator<T>) null);
}
/**
* Returns a Collection containing the items from the Iterable but with duplicates removed.
* The items in the Iterable are compared by the given Closure condition.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* If the closure takes a single parameter, each element from the Iterable will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the Iterable
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* def list2 = list.toUnique{ p1, p2 {@code ->} p1.lname != p2.lname ? p1.lname <=> p2.lname : p1.fname <=> p2.fname }
* assert( list2 == [a, b, c] {@code &&} list == [a, b, c, d] )
* def list3 = list.toUnique{ it.toString() }
* assert( list3 == [a, b, c] {@code &&} list == [a, b, c, d] )
* </pre>
*
* @param self an Iterable
* @param condition a Closure used to determine unique items
* @return a new Collection
* @see #toUnique(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Collection<T> toUnique(Iterable<T> self, @ClosureParams(value = FromString.class, options = {"T", "T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<T>(condition, true)
: new ClosureComparator<T>(condition);
return toUnique(self, comparator);
}
/**
* Returns a List containing the items from the List but with duplicates removed.
* The items in the List are compared by the given Closure condition.
* For each duplicate, the first member which is returned from the
* Iterable is retained, but all other ones are removed.
* <p>
* If the closure takes a single parameter, each element from the Iterable will be passed to the closure. The closure
* should return a value used for comparison (either using {@link java.lang.Comparable#compareTo(java.lang.Object)} or
* {@link java.lang.Object#equals(java.lang.Object)}). If the closure takes two parameters, two items from the Iterable
* will be passed as arguments, and the closure should return an int value (with 0 indicating the items are not unique).
* <p>
* <pre class="groovyTestCase">
* class Person {
* def fname, lname
* String toString() {
* return fname + " " + lname
* }
* }
*
* Person a = new Person(fname:"John", lname:"Taylor")
* Person b = new Person(fname:"Clark", lname:"Taylor")
* Person c = new Person(fname:"Tom", lname:"Cruz")
* Person d = new Person(fname:"Clark", lname:"Taylor")
*
* def list = [a, b, c, d]
* def list2 = list.toUnique{ p1, p2 {@code ->} p1.lname != p2.lname ? p1.lname <=> p2.lname : p1.fname <=> p2.fname }
* assert( list2 == [a, b, c] {@code &&} list == [a, b, c, d] )
* def list3 = list.toUnique{ it.toString() }
* assert( list3 == [a, b, c] {@code &&} list == [a, b, c, d] )
* </pre>
*
* @param self a List
* @param condition a Closure used to determine unique items
* @return a new List
* @see #toUnique(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toUnique(List<T> self, @ClosureParams(value = FromString.class, options = {"T", "T,T"}) Closure condition) {
return (List<T>) toUnique((Iterable<T>) self, condition);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed with the supplied
* comparator determining which items are unique.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T']
* String[] lower = ['c', 'a', 't', 's', 'h']
* class LowerComparator implements Comparator {
* int compare(let1, let2) { let1.toLowerCase() {@code <=>} let2.toLowerCase() }
* }
* assert letters.toUnique(new LowerComparator()) == lower
* </pre>
*
* @param self an array
* @param comparator a Comparator used to determine unique (equal) items
* If {@code null}, the Comparable natural ordering of the elements will be used.
* @return the unique items from the array
*/
@SuppressWarnings("unchecked")
public static <T> T[] toUnique(T[] self, Comparator<T> comparator) {
Collection<T> items = toUnique(toList(self), comparator);
T[] result = createSimilarArray(self, items.size());
return items.toArray(result);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed using the
* natural ordering of the items in the array.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'a', 't', 'h', 'a', 't']
* String[] expected = ['c', 'a', 't', 's', 'h']
* def result = letters.toUnique()
* assert result == expected
* assert result.class.componentType == String
* </pre>
*
* @param self an array
* @return the unique items from the array
*/
@SuppressWarnings("unchecked")
public static <T> T[] toUnique(T[] self) {
return (T[]) toUnique(self, (Comparator) null);
}
/**
* Returns a new Array containing the items from the original Array but with duplicates removed with the supplied
* comparator determining which items are unique.
* <p>
* <pre class="groovyTestCase">
* String[] letters = ['c', 'a', 't', 's', 'A', 't', 'h', 'a', 'T']
* String[] expected = ['c', 'a', 't', 's', 'h']
* assert letters.toUnique{ p1, p2 {@code ->} p1.toLowerCase() {@code <=>} p2.toLowerCase() } == expected
* assert letters.toUnique{ it.toLowerCase() } == expected
* </pre>
*
* @param self an array
* @param condition a Closure used to determine unique items
* @return the unique items from the array
*/
@SuppressWarnings("unchecked")
public static <T> T[] toUnique(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
? new OrderBy<T>(condition, true)
: new ClosureComparator<T>(condition);
return toUnique(self, comparator);
}
/**
* Iterates through an array passing each array entry to the given closure.
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c']
* String result = ''
* letters.each{ result += it }
* assert result == 'abc'
* </pre>
*
* @param self the array over which we iterate
* @param closure the closure applied on each array entry
* @return the self array
* @since 2.5.0
*/
public static <T> T[] each(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
for(T item : self){
closure.call(item);
}
return self;
}
/**
* Iterates through an aggregate type or data structure,
* passing each item to the given closure. Custom types may utilize this
* method by simply providing an "iterator()" method. The items returned
* from the resulting iterator will be passed to the closure.
* <pre class="groovyTestCase">
* String result = ''
* ['a', 'b', 'c'].each{ result += it }
* assert result == 'abc'
* </pre>
*
* @param self the object over which we iterate
* @param closure the closure applied on each element found
* @return the self Object
* @since 1.0
*/
public static <T> T each(T self, Closure closure) {
each(InvokerHelper.asIterator(self), closure);
return self;
}
/**
* Iterates through an array,
* passing each array element and the element's index (a counter starting at
* zero) to the given closure.
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c']
* String result = ''
* letters.eachWithIndex{ letter, index {@code ->} result += "$index:$letter" }
* assert result == '0:a1:b2:c'
* </pre>
*
* @param self an array
* @param closure a Closure to operate on each array entry
* @return the self array
* @since 2.5.0
*/
public static <T> T[] eachWithIndex(T[] self, @ClosureParams(value=FromString.class, options="T,Integer") Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
for(T item : self) {
args[0] = item;
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through an aggregate type or data structure,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
* <pre class="groovyTestCase">
* String result = ''
* ['a', 'b', 'c'].eachWithIndex{ letter, index {@code ->} result += "$index:$letter" }
* assert result == '0:a1:b2:c'
* </pre>
*
* @param self an Object
* @param closure a Closure to operate on each item
* @return the self Object
* @since 1.0
*/
public static <T> T eachWithIndex(T self, /*@ClosureParams(value=FromString.class, options="?,Integer")*/ Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
args[0] = iter.next();
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through an iterable type,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self an Iterable
* @param closure a Closure to operate on each item
* @return the self Iterable
* @since 2.3.0
*/
public static <T> Iterable<T> eachWithIndex(Iterable<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
eachWithIndex(self.iterator(), closure);
return self;
}
/**
* Iterates through an iterator type,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self an Iterator
* @param closure a Closure to operate on each item
* @return the self Iterator (now exhausted)
* @since 2.3.0
*/
public static <T> Iterator<T> eachWithIndex(Iterator<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
final Object[] args = new Object[2];
int counter = 0;
while (self.hasNext()) {
args[0] = self.next();
args[1] = counter++;
closure.call(args);
}
return self;
}
/**
* Iterates through a Collection,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a Collection
* @param closure a Closure to operate on each item
* @return the self Collection
* @since 2.4.0
*/
public static <T> Collection<T> eachWithIndex(Collection<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (Collection<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a List,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a List
* @param closure a Closure to operate on each item
* @return the self List
* @since 2.4.0
*/
public static <T> List<T> eachWithIndex(List<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (List<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a Set,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a Set
* @param closure a Closure to operate on each item
* @return the self Set
* @since 2.4.0
*/
public static <T> Set<T> eachWithIndex(Set<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (Set<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through a SortedSet,
* passing each item and the item's index (a counter starting at
* zero) to the given closure.
*
* @param self a SortedSet
* @param closure a Closure to operate on each item
* @return the self SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> eachWithIndex(SortedSet<T> self, @ClosureParams(value=FromString.class, options="T,java.lang.Integer") Closure closure) {
return (SortedSet<T>) eachWithIndex((Iterable<T>) self, closure);
}
/**
* Iterates through an Iterable, passing each item to the given closure.
*
* @param self the Iterable over which we iterate
* @param closure the closure applied on each element found
* @return the self Iterable
*/
public static <T> Iterable<T> each(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
each(self.iterator(), closure);
return self;
}
/**
* Iterates through an Iterator, passing each item to the given closure.
*
* @param self the Iterator over which we iterate
* @param closure the closure applied on each element found
* @return the self Iterator
* @since 2.4.0
*/
public static <T> Iterator<T> each(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
while (self.hasNext()) {
Object arg = self.next();
closure.call(arg);
}
return self;
}
/**
* Iterates through a Collection, passing each item to the given closure.
*
* @param self the Collection over which we iterate
* @param closure the closure applied on each element found
* @return the self Collection
* @since 2.4.0
*/
public static <T> Collection<T> each(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Collection<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a List, passing each item to the given closure.
*
* @param self the List over which we iterate
* @param closure the closure applied on each element found
* @return the self List
* @since 2.4.0
*/
public static <T> List<T> each(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a Set, passing each item to the given closure.
*
* @param self the Set over which we iterate
* @param closure the closure applied on each element found
* @return the self Set
* @since 2.4.0
*/
public static <T> Set<T> each(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Set<T>) each((Iterable<T>) self, closure);
}
/**
* Iterates through a SortedSet, passing each item to the given closure.
*
* @param self the SortedSet over which we iterate
* @param closure the closure applied on each element found
* @return the self SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> each(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (SortedSet<T>) each((Iterable<T>) self, closure);
}
/**
* Allows a Map to be iterated through using a closure. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].each { key, value {@code ->} result += "$key$value" }
* assert result == "a1b3"</pre>
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].each { entry {@code ->} result += entry }
* assert result == "a=1b=3"</pre>
*
* In general, the order in which the map contents are processed
* cannot be guaranteed. In practise, specialized forms of Map,
* e.g. a TreeMap will have its contents processed according to
* the natural ordering of the map.
*
* @param self the map over which we iterate
* @param closure the 1 or 2 arg closure applied on each entry of the map
* @return returns the self parameter
* @since 1.5.0
*/
public static <K, V> Map<K, V> each(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
for (Map.Entry entry : self.entrySet()) {
callClosureForMapEntry(closure, entry);
}
return self;
}
/**
* Allows a Map to be iterated through in reverse order using a closure.
*
* In general, the order in which the map contents are processed
* cannot be guaranteed. In practise, specialized forms of Map,
* e.g. a TreeMap will have its contents processed according to the
* reverse of the natural ordering of the map.
*
* @param self the map over which we iterate
* @param closure the 1 or 2 arg closure applied on each entry of the map
* @return returns the self parameter
* @see #each(Map, Closure)
* @since 1.7.2
*/
public static <K, V> Map<K, V> reverseEach(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
final Iterator<Map.Entry<K, V>> entries = reverse(self.entrySet().iterator());
while (entries.hasNext()) {
callClosureForMapEntry(closure, entries.next());
}
return self;
}
/**
* Allows a Map to be iterated through using a closure. If the
* closure takes two parameters then it will be passed the Map.Entry and
* the item's index (a counter starting at zero) otherwise if the closure
* takes three parameters then it will be passed the key, the value, and
* the index.
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].eachWithIndex { key, value, index {@code ->} result += "$index($key$value)" }
* assert result == "0(a1)1(b3)"</pre>
* <pre class="groovyTestCase">def result = ""
* [a:1, b:3].eachWithIndex { entry, index {@code ->} result += "$index($entry)" }
* assert result == "0(a=1)1(b=3)"</pre>
*
* @param self the map over which we iterate
* @param closure a 2 or 3 arg Closure to operate on each item
* @return the self Object
* @since 1.5.0
*/
public static <K, V> Map<K, V> eachWithIndex(Map<K, V> self, @ClosureParams(value=MapEntryOrKeyValue.class, options="index=true") Closure closure) {
int counter = 0;
for (Map.Entry entry : self.entrySet()) {
callClosureForMapEntryAndCounter(closure, entry, counter++);
}
return self;
}
/**
* Iterate over each element of the list in the reverse order.
* <pre class="groovyTestCase">def result = []
* [1,2,3].reverseEach { result << it }
* assert result == [3,2,1]</pre>
*
* @param self a List
* @param closure a closure to which each item is passed.
* @return the original list
* @since 1.5.0
*/
public static <T> List<T> reverseEach(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
each(new ReverseListIterator<T>(self), closure);
return self;
}
/**
* Iterate over each element of the array in the reverse order.
*
* @param self an array
* @param closure a closure to which each item is passed
* @return the original array
* @since 1.5.2
*/
public static <T> T[] reverseEach(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(new ReverseListIterator<T>(Arrays.asList(self)), closure);
return self;
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this data structure).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.every { it {@code >} 2 }
* </pre>
*
* @param self the object over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 1.0
*/
public static boolean every(Object self, Closure predicate) {
return every(InvokerHelper.asIterator(self), predicate);
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this iterator).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.iterator().every { it {@code >} 2 }
* </pre>
*
* @param self the iterator over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 2.3.0
*/
public static <T> boolean every(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
while (self.hasNext()) {
if (!bcw.call(self.next())) {
return false;
}
}
return true;
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this Array).
*
* @param self an Array
* @param predicate the closure predicate used for matching
* @return true if every element of the Array matches the closure predicate
* @since 2.5.0
*/
public static <T> boolean every(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
return every(new ArrayIterator<T>(self), predicate);
}
/**
* Used to determine if the given predicate closure is valid (i.e. returns
* <code>true</code> for all items in this iterable).
* A simple example for a list:
* <pre>def list = [3,4,5]
* def greaterThanTwo = list.every { it {@code >} 2 }
* </pre>
*
* @param self the iterable over which we iterate
* @param predicate the closure predicate used for matching
* @return true if every iteration of the object matches the closure predicate
* @since 2.3.0
*/
public static <T> boolean every(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
return every(self.iterator(), predicate);
}
/**
* Iterates over the entries of a map, and checks whether a predicate is
* valid for all entries. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">def map = [a:1, b:2.0, c:2L]
* assert !map.every { key, value {@code ->} value instanceof Integer }
* assert map.every { entry {@code ->} entry.value instanceof Number }</pre>
*
* @param self the map over which we iterate
* @param predicate the 1 or 2 arg Closure predicate used for matching
* @return true if every entry of the map matches the closure predicate
* @since 1.5.0
*/
public static <K, V> boolean every(Map<K, V> self, @ClosureParams(value = MapEntryOrKeyValue.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (!bcw.callForMap(entry)) {
return false;
}
}
return true;
}
/**
* Iterates over every element of a collection, and checks whether all
* elements are <code>true</code> according to the Groovy Truth.
* Equivalent to <code>self.every({element {@code ->} element})</code>
* <pre class="groovyTestCase">
* assert [true, true].every()
* assert [1, 1].every()
* assert ![1, 0].every()
* </pre>
*
* @param self the object over which we iterate
* @return true if every item in the collection matches satisfies Groovy truth
* @since 1.5.0
*/
public static boolean every(Object self) {
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
if (!bmi.convertToBoolean(iter.next())) {
return false;
}
}
return true;
}
/**
* Iterates over the contents of an object or collection, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].any { it == 2 }
* assert ![1, 2, 3].any { it {@code >} 3 }
* </pre>
*
* @param self the object over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static boolean any(Object self, Closure predicate) {
return any(InvokerHelper.asIterator(self), predicate);
}
/**
* Iterates over the contents of an iterator, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].iterator().any { it == 2 }
* assert ![1, 2, 3].iterator().any { it {@code >} 3 }
* </pre>
*
* @param self the iterator over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static <T> boolean any(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
while (self.hasNext()) {
if (bcw.call(self.next())) return true;
}
return false;
}
/**
* Iterates over the contents of an iterable, and checks whether a
* predicate is valid for at least one element.
* <pre class="groovyTestCase">
* assert [1, 2, 3].any { it == 2 }
* assert ![1, 2, 3].any { it {@code >} 3 }
* </pre>
*
* @param self the iterable over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 1.0
*/
public static <T> boolean any(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure predicate) {
return any(self.iterator(), predicate);
}
/**
* Iterates over the contents of an Array, and checks whether a
* predicate is valid for at least one element.
*
* @param self the array over which we iterate
* @param predicate the closure predicate used for matching
* @return true if any iteration for the object matches the closure predicate
* @since 2.5.0
*/
public static <T> boolean any(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
return any(new ArrayIterator<T>(self), predicate);
}
/**
* Iterates over the entries of a map, and checks whether a predicate is
* valid for at least one entry. If the
* closure takes one parameter then it will be passed the Map.Entry
* otherwise if the closure takes two parameters then it will be
* passed the key and the value.
* <pre class="groovyTestCase">
* assert [2:3, 4:5, 5:10].any { key, value {@code ->} key * 2 == value }
* assert ![2:3, 4:5, 5:10].any { entry {@code ->} entry.key == entry.value * 2 }
* </pre>
*
* @param self the map over which we iterate
* @param predicate the 1 or 2 arg closure predicate used for matching
* @return true if any entry in the map matches the closure predicate
* @since 1.5.0
*/
public static <K, V> boolean any(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> predicate) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(predicate);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
return true;
}
}
return false;
}
/**
* Iterates over the elements of a collection, and checks whether at least
* one element is true according to the Groovy Truth.
* Equivalent to self.any({element {@code ->} element})
* <pre class="groovyTestCase">
* assert [false, true].any()
* assert [0, 1].any()
* assert ![0, 0].any()
* </pre>
*
* @param self the object over which we iterate
* @return true if any item in the collection matches the closure predicate
* @since 1.5.0
*/
public static boolean any(Object self) {
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker();
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
if (bmi.convertToBoolean(iter.next())) {
return true;
}
}
return false;
}
/**
* Iterates over the collection of items which this Object represents and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self the object over which we iterate
* @param filter the filter to perform on the object (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 1.5.6
*/
public static Collection grep(Object self, Object filter) {
Collection answer = createSimilarOrDefaultCollection(self);
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
Object object = iter.next();
if (bmi.invoke(filter, object)) {
answer.add(object);
}
}
return answer;
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self a collection
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 2.0
*/
public static <T> Collection<T> grep(Collection<T> self, Object filter) {
Collection<T> answer = createSimilarCollection(self);
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (T element : self) {
if (bmi.invoke(filter, element)) {
answer.add(element);
}
}
return answer;
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def list = ['a', 'b', 'aa', 'bc', 3, 4.5]
* assert list.grep( ~/a+/ ) == ['a', 'aa']
* assert list.grep( ~/../ ) == ['aa', 'bc']
* assert list.grep( Number ) == [ 3, 4.5 ]
* assert list.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self a List
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a List of objects which match the filter
* @since 2.4.0
*/
public static <T> List<T> grep(List<T> self, Object filter) {
return (List<T>) grep((Collection<T>) self, filter);
}
/**
* Iterates over the collection of items and returns each item that matches
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def set = ['a', 'b', 'aa', 'bc', 3, 4.5] as Set
* assert set.grep( ~/a+/ ) == ['a', 'aa'] as Set
* assert set.grep( ~/../ ) == ['aa', 'bc'] as Set
* assert set.grep( Number ) == [ 3, 4.5 ] as Set
* assert set.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ] as Set
* </pre>
*
* @param self a Set
* @param filter the filter to perform on each element of the collection (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a Set of objects which match the filter
* @since 2.4.0
*/
public static <T> Set<T> grep(Set<T> self, Object filter) {
return (Set<T>) grep((Collection<T>) self, filter);
}
/**
* Iterates over the array of items and returns a collection of items that match
* the given filter - calling the <code>{@link #isCase(java.lang.Object, java.lang.Object)}</code>
* method used by switch statements. This method can be used with different
* kinds of filters like regular expressions, classes, ranges etc.
* Example:
* <pre class="groovyTestCase">
* def items = ['a', 'b', 'aa', 'bc', 3, 4.5] as Object[]
* assert items.grep( ~/a+/ ) == ['a', 'aa']
* assert items.grep( ~/../ ) == ['aa', 'bc']
* assert items.grep( Number ) == [ 3, 4.5 ]
* assert items.grep{ it.toString().size() == 1 } == [ 'a', 'b', 3 ]
* </pre>
*
* @param self an array
* @param filter the filter to perform on each element of the array (using the {@link #isCase(java.lang.Object, java.lang.Object)} method)
* @return a collection of objects which match the filter
* @since 2.0
*/
public static <T> Collection<T> grep(T[] self, Object filter) {
Collection<T> answer = new ArrayList<T>();
BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
for (T element : self) {
if (bmi.invoke(filter, element)) {
answer.add(element);
}
}
return answer;
}
/**
* Iterates over the collection of items which this Object represents and returns each item that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self the object over which we iterate
* @return a collection of objects which match the filter
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Collection grep(Object self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a Collection
* @return a collection of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.0
*/
public static <T> Collection<T> grep(Collection<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a List
* @return a List of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.4.0
*/
public static <T> List<T> grep(List<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the collection returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Set
* assert items.grep() == [1, 2, true, 'foo', [4, 5]] as Set
* </pre>
*
* @param self a Set
* @return a Set of elements satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.4.0
*/
public static <T> Set<T> grep(Set<T> self) {
return grep(self, Closure.IDENTITY);
}
/**
* Iterates over the array returning each element that matches
* using the IDENTITY Closure as a filter - effectively returning all elements which satisfy Groovy truth.
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Object[]
* assert items.grep() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an array
* @return a collection of elements which satisfy Groovy truth
* @see Closure#IDENTITY
* @since 2.0
*/
@SuppressWarnings("unchecked")
public static <T> Collection<T> grep(T[] self) {
return grep(self, Closure.IDENTITY);
}
/**
* Counts the number of occurrences of the given value from the
* items within this Iterator.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
* The iterator will become exhausted of elements after determining the count value.
*
* @param self the Iterator from which we count the number of matching occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.5.0
*/
public static Number count(Iterator self, Object value) {
long answer = 0;
while (self.hasNext()) {
if (DefaultTypeTransformation.compareEqual(self.next(), value)) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* Counts the number of occurrences which satisfy the given closure from the
* items within this Iterator.
* The iterator will become exhausted of elements after determining the count value.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].toSet().iterator().count{ it % 2 == 0 } == 2</pre>
*
* @param self the Iterator from which we count the number of matching occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 1.8.0
*/
public static <T> Number count(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
long answer = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (self.hasNext()) {
if (bcw.call(self.next())) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* @deprecated use count(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static Number count(Collection self, Object value) {
return count(self.iterator(), value);
}
/**
* Counts the number of occurrences of the given value inside this Iterable.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].count(4) == 2</pre>
*
* @param self the Iterable within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 2.2.0
*/
public static Number count(Iterable self, Object value) {
return count(self.iterator(), value);
}
/**
* @deprecated use count(Iterable, Closure)
* @since 1.8.0
*/
@Deprecated
public static Number count(Collection self, Closure closure) {
return count(self.iterator(), closure);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this Iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [2,4,2,1,3,5,2,4,3].count{ it % 2 == 0 } == 5</pre>
*
* @param self the Iterable within which we count the number of occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 2.2.0
*/
public static <T> Number count(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return count(self.iterator(), closure);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this map.
* If the closure takes one parameter then it will be passed the Map.Entry.
* Otherwise, the closure should take two parameters and will be passed the key and value.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [a:1, b:1, c:2, d:2].count{ k,v {@code ->} k == 'a' {@code ||} v == 2 } == 3</pre>
*
* @param self the map within which we count the number of occurrences
* @param closure a 1 or 2 arg Closure condition applying on the entries
* @return the number of occurrences
* @since 1.8.0
*/
public static <K,V> Number count(Map<K,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> closure) {
long answer = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Object entry : self.entrySet()) {
if (bcw.callForMap((Map.Entry)entry)) {
++answer;
}
}
// for b/c with Java return an int if we can
if (answer <= Integer.MAX_VALUE) return (int) answer;
return answer;
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(Object[] self, Object value) {
return count((Iterable)Arrays.asList(self), value);
}
/**
* Counts the number of occurrences which satisfy the given closure from inside this array.
*
* @param self the array within which we count the number of occurrences
* @param closure a closure condition
* @return the number of occurrences
* @since 1.8.0
*/
public static <T> Number count(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return count((Iterable)Arrays.asList(self), closure);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(int[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(long[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(short[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(char[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(boolean[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(double[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(float[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* Counts the number of occurrences of the given value inside this array.
* Comparison is done using Groovy's == operator (using
* <code>compareTo(value) == 0</code> or <code>equals(value)</code> ).
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.6.4
*/
public static Number count(byte[] self, Object value) {
return count(InvokerHelper.asIterator(self), value);
}
/**
* @deprecated Use the Iterable version of toList instead
* @see #toList(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> List<T> toList(Collection<T> self) {
List<T> answer = new ArrayList<T>(self.size());
answer.addAll(self);
return answer;
}
/**
* Convert an iterator to a List. The iterator will become
* exhausted of elements after making this conversion.
*
* @param self an iterator
* @return a List
* @since 1.5.0
*/
public static <T> List<T> toList(Iterator<T> self) {
List<T> answer = new ArrayList<T>();
while (self.hasNext()) {
answer.add(self.next());
}
return answer;
}
/**
* Convert an Iterable to a List. The Iterable's iterator will
* become exhausted of elements after making this conversion.
* <p>
* Example usage:
* <pre class="groovyTestCase">def x = [1,2,3] as HashSet
* assert x.class == HashSet
* assert x.toList() instanceof List</pre>
*
* @param self an Iterable
* @return a List
* @since 1.8.7
*/
public static <T> List<T> toList(Iterable<T> self) {
return toList(self.iterator());
}
/**
* Convert an enumeration to a List.
*
* @param self an enumeration
* @return a List
* @since 1.5.0
*/
public static <T> List<T> toList(Enumeration<T> self) {
List<T> answer = new ArrayList<T>();
while (self.hasMoreElements()) {
answer.add(self.nextElement());
}
return answer;
}
/**
* Collates this iterable into sub-lists of length <code>size</code>.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4, 5, 6, 7 ]
* def coll = list.collate( 3 )
* assert coll == [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size) {
return collate(self, size, true);
}
/**
* Collates an array.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @return a List containing the array values collated into sub-lists
* @see #collate(Iterable, int)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size) {
return collate((Iterable)Arrays.asList(self), size, true);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size ) {
return collate((Iterable<T>) self, size) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code> stepping through the code <code>step</code>
* elements for each subList.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4 ]
* def coll = list.collate( 3, 1 )
* assert coll == [ [ 1, 2, 3 ], [ 2, 3, 4 ], [ 3, 4 ], [ 4 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, int step) {
return collate(self, size, step, true);
}
/**
* Collates an array into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @return a List containing the array elements collated into sub-lists
* @see #collate(Iterable, int, int)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, int step) {
return collate((Iterable)Arrays.asList(self), size, step, true);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, int)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, int step ) {
return collate((Iterable<T>) self, size, step) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code>. Any remaining elements in
* the iterable after the subdivision will be dropped if <code>keepRemainder</code> is false.
* Example:
* <pre class="groovyTestCase">def list = [ 1, 2, 3, 4, 5, 6, 7 ]
* def coll = list.collate( 3, false )
* assert coll == [ [ 1, 2, 3 ], [ 4, 5, 6 ] ]</pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the data collated into sub-lists
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, boolean keepRemainder) {
return collate(self, size, size, keepRemainder);
}
/**
* Collates this array into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the array elements collated into sub-lists
* @see #collate(Iterable, int, boolean)
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, boolean keepRemainder) {
return collate((Iterable)Arrays.asList(self), size, size, keepRemainder);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, boolean)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, boolean keepRemainder ) {
return collate((Iterable<T>) self, size, keepRemainder) ;
}
/**
* Collates this iterable into sub-lists of length <code>size</code> stepping through the code <code>step</code>
* elements for each sub-list. Any remaining elements in the iterable after the subdivision will be dropped if
* <code>keepRemainder</code> is false.
* Example:
* <pre class="groovyTestCase">
* def list = [ 1, 2, 3, 4 ]
* assert list.collate( 2, 2, true ) == [ [ 1, 2 ], [ 3, 4 ] ]
* assert list.collate( 3, 1, true ) == [ [ 1, 2, 3 ], [ 2, 3, 4 ], [ 3, 4 ], [ 4 ] ]
* assert list.collate( 3, 1, false ) == [ [ 1, 2, 3 ], [ 2, 3, 4 ] ]
* </pre>
*
* @param self an Iterable
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the data collated into sub-lists
* @throws IllegalArgumentException if the step is zero.
* @since 2.4.0
*/
public static <T> List<List<T>> collate(Iterable<T> self, int size, int step, boolean keepRemainder) {
List<T> selfList = asList(self);
List<List<T>> answer = new ArrayList<List<T>>();
if (size <= 0) {
answer.add(selfList);
} else {
if (step == 0) throw new IllegalArgumentException("step cannot be zero");
for (int pos = 0; pos < selfList.size() && pos > -1; pos += step) {
if (!keepRemainder && pos > selfList.size() - size) {
break ;
}
List<T> element = new ArrayList<T>() ;
for (int offs = pos; offs < pos + size && offs < selfList.size(); offs++) {
element.add(selfList.get(offs));
}
answer.add( element ) ;
}
}
return answer ;
}
/**
* Collates this array into into sub-lists.
*
* @param self an array
* @param size the length of each sub-list in the returned list
* @param step the number of elements to step through for each sub-list
* @param keepRemainder if true, any remaining elements are returned as sub-lists. Otherwise they are discarded
* @return a List containing the array elements collated into sub-lists
* @since 2.5.0
*/
public static <T> List<List<T>> collate(T[] self, int size, int step, boolean keepRemainder) {
return collate((Iterable)Arrays.asList(self), size, step, keepRemainder);
}
/**
* @deprecated use the Iterable variant instead
* @see #collate(Iterable, int, int, boolean)
* @since 1.8.6
*/
@Deprecated
public static <T> List<List<T>> collate( List<T> self, int size, int step, boolean keepRemainder ) {
return collate((Iterable<T>) self, size, step, keepRemainder);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original object.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].iterator().collect()</pre>
*
* @param self an aggregate Object with an Iterator returning its items
* @return a Collection of the transformed values
* @see Closure#IDENTITY
* @since 1.8.5
*/
public static Collection collect(Object self) {
return collect(self, Closure.IDENTITY);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
* Example:
* <pre class="groovyTestCase">def list = [1, 'a', 1.23, true ]
* def types = list.collect { it.class }
* assert types == [Integer, String, BigDecimal, Boolean]</pre>
*
* @param self an aggregate Object with an Iterator returning its items
* @param transform the closure used to transform each item of the aggregate object
* @return a List of the transformed values
* @since 1.0
*/
public static <T> List<T> collect(Object self, Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<T>(), transform);
}
/**
* Iterates through this aggregate Object transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
*
* @param self an aggregate Object with an Iterator returning its items
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item of the aggregate object
* @return the collector with all transformed values added to it
* @since 1.0
*/
public static <T> Collection<T> collect(Object self, Collection<T> collector, Closure<? extends T> transform) {
return collect(InvokerHelper.asIterator(self), collector, transform);
}
/**
* Iterates through this Array transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
*
* @param self an Array
* @param transform the closure used to transform each item of the Array
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> transform) {
return collect(new ArrayIterator<S>(self), transform);
}
/**
* Iterates through this Array transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">
* Integer[] nums = [1,2,3]
* List<Integer> answer = []
* nums.collect(answer) { it * 2 }
* assert [2,4,6] == answer
* </pre>
*
* @param self an Array
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(S[] self, Collection<T> collector, @ClosureParams(FirstParam.Component.class) Closure<? extends T> transform) {
return collect(new ArrayIterator<S>(self), collector, transform);
}
/**
* Iterates through this Iterator transforming each item into a new value using the
* <code>transform</code> closure, returning a list of transformed values.
*
* @param self an Iterator
* @param transform the closure used to transform each item
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(Iterator<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<T>(), transform);
}
/**
* Iterates through this Iterator transforming each item into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
*
* @param self an Iterator
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(Iterator<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
while (self.hasNext()) {
collector.add(transform.call(self.next()));
}
return collector;
}
/**
* Iterates through this collection transforming each entry into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original collection.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].collect()</pre>
*
* @param self a collection
* @return a List of the transformed values
* @see Closure#IDENTITY
* @since 1.8.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <T> List<T> collect(Collection<T> self) {
return collect((Iterable<T>) self);
}
/**
* Iterates through this collection transforming each entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
*
* @param self a collection
* @param transform the closure used to transform each item of the collection
* @return a List of the transformed values
* @deprecated use the Iterable version instead
* @since 1.0
*/
@Deprecated
public static <S,T> List<T> collect(Collection<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<T>(self.size()), transform);
}
/**
* Iterates through this collection transforming each value into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }</pre>
*
* @param self a collection
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item of the collection
* @return the collector with all transformed values added to it
* @deprecated use the Iterable version instead
* @since 1.0
*/
@Deprecated
public static <S,T> Collection<T> collect(Collection<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
for (S item : self) {
collector.add(transform.call(item));
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* Iterates through this collection transforming each entry into a new value using Closure.IDENTITY
* as a transformer, basically returning a list of items copied from the original collection.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2,3].collect()</pre>
*
* @param self an Iterable
* @return a List of the transformed values
* @see Closure#IDENTITY
* @since 2.5.0
*/
@SuppressWarnings("unchecked")
public static <T> List<T> collect(Iterable<T> self) {
return collect(self, (Closure<T>) Closure.IDENTITY);
}
/**
* Iterates through this Iterable transforming each entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
* <pre class="groovyTestCase">assert [2,4,6] == [1,2,3].collect { it * 2 }</pre>
*
* @param self an Iterable
* @param transform the closure used to transform each item of the collection
* @return a List of the transformed values
* @since 2.5.0
*/
public static <S,T> List<T> collect(Iterable<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
return collect(self.iterator(), transform);
}
/**
* Iterates through this collection transforming each value into a new value using the <code>transform</code> closure
* and adding it to the supplied <code>collector</code>.
* <pre class="groovyTestCase">assert [1,2,3] as HashSet == [2,4,5,6].collect(new HashSet()) { (int)(it / 2) }</pre>
*
* @param self an Iterable
* @param collector the Collection to which the transformed values are added
* @param transform the closure used to transform each item
* @return the collector with all transformed values added to it
* @since 2.5.0
*/
public static <S,T> Collection<T> collect(Iterable<S> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends T> transform) {
for (S item : self) {
collector.add(transform.call(item));
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* Deprecated alias for collectNested
*
* @deprecated Use collectNested instead
* @see #collectNested(Collection, Closure)
*/
@Deprecated
public static List collectAll(Collection self, Closure transform) {
return collectNested(self, transform);
}
/**
* Recursively iterates through this collection transforming each non-Collection value
* into a new value using the closure as a transformer. Returns a potentially nested
* list of transformed values.
* <pre class="groovyTestCase">
* assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectNested { it * 2 }
* </pre>
*
* @param self a collection
* @param transform the closure used to transform each item of the collection
* @return the resultant collection
* @since 1.8.1
*/
public static List collectNested(Collection self, Closure transform) {
return (List) collectNested((Iterable) self, new ArrayList(self.size()), transform);
}
/**
* Recursively iterates through this Iterable transforming each non-Collection value
* into a new value using the closure as a transformer. Returns a potentially nested
* list of transformed values.
* <pre class="groovyTestCase">
* assert [2,[4,6],[8],[]] == [1,[2,3],[4],[]].collectNested { it * 2 }
* </pre>
*
* @param self an Iterable
* @param transform the closure used to transform each item of the Iterable
* @return the resultant list
* @since 2.2.0
*/
public static List collectNested(Iterable self, Closure transform) {
return (List) collectNested(self, new ArrayList(), transform);
}
/**
* Deprecated alias for collectNested
*
* @deprecated Use collectNested instead
* @see #collectNested(Iterable, Collection, Closure)
*/
@Deprecated
public static Collection collectAll(Collection self, Collection collector, Closure transform) {
return collectNested((Iterable)self, collector, transform);
}
/**
* @deprecated Use the Iterable version of collectNested instead
* @see #collectNested(Iterable, Collection, Closure)
* @since 1.8.1
*/
@Deprecated
public static Collection collectNested(Collection self, Collection collector, Closure transform) {
return collectNested((Iterable)self, collector, transform);
}
/**
* Recursively iterates through this Iterable transforming each non-Collection value
* into a new value using the <code>transform</code> closure. Returns a potentially nested
* collection of transformed values.
* <pre class="groovyTestCase">
* def x = [1,[2,3],[4],[]].collectNested(new Vector()) { it * 2 }
* assert x == [2,[4,6],[8],[]]
* assert x instanceof Vector
* </pre>
*
* @param self an Iterable
* @param collector an initial Collection to which the transformed values are added
* @param transform the closure used to transform each element of the Iterable
* @return the collector with all transformed values added to it
* @since 2.2.0
*/
public static Collection collectNested(Iterable self, Collection collector, Closure transform) {
for (Object item : self) {
if (item instanceof Collection) {
Collection c = (Collection) item;
collector.add(collectNested((Iterable)c, createSimilarCollection(collector, c.size()), transform));
} else {
collector.add(transform.call(item));
}
if (transform.getDirective() == Closure.DONE) {
break;
}
}
return collector;
}
/**
* @deprecated Use the Iterable version of collectMany instead
* @see #collectMany(Iterable, Closure)
* @since 1.8.1
*/
@Deprecated
public static <T,E> List<T> collectMany(Collection<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)self, projection);
}
/**
* @deprecated Use the Iterable version of collectMany instead
* @see #collectMany(Iterable, Collection, Closure)
* @since 1.8.5
*/
@Deprecated
public static <T,E> Collection<T> collectMany(Collection<E> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)self, collector, projection);
}
/**
* Projects each item from a source Iterable to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def nums = 1..10
* def squaresAndCubesOfEvens = nums.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216, 64, 512, 100, 1000]
*
* def animals = ['CAT', 'DOG', 'ELEPHANT'] as Set
* def smallAnimals = animals.collectMany{ it.size() {@code >} 3 ? [] : [it.toLowerCase()] }
* assert smallAnimals == ['cat', 'dog']
*
* def orig = nums as Set
* def origPlusIncrements = orig.collectMany{ [it, it+1] }
* assert origPlusIncrements.size() == orig.size() * 2
* assert origPlusIncrements.unique().size() == orig.size() + 1
* </pre>
*
* @param self an Iterable
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(java.util.Collection, groovy.lang.Closure)
* @since 2.2.0
*/
public static <T,E> List<T> collectMany(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return (List<T>) collectMany(self, new ArrayList<T>(), projection);
}
/**
* Projects each item from a source collection to a result collection and concatenates (flattens) the resulting
* collections adding them into the <code>collector</code>.
* <p>
* <pre class="groovyTestCase">
* def animals = ['CAT', 'DOG', 'ELEPHANT'] as Set
* def smallAnimals = animals.collectMany(['ant', 'bee']){ it.size() {@code >} 3 ? [] : [it.toLowerCase()] }
* assert smallAnimals == ['ant', 'bee', 'cat', 'dog']
*
* def nums = 1..5
* def origPlusIncrements = nums.collectMany([] as Set){ [it, it+1] }
* assert origPlusIncrements.size() == nums.size() + 1
* </pre>
*
* @param self an Iterable
* @param collector an initial collection to add the projected items to
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) into it
* @since 2.2.0
*/
public static <T,E> Collection<T> collectMany(Iterable<E> self, Collection<T> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
for (E next : self) {
collector.addAll(projection.call(next));
}
return collector;
}
/**
* Projects each item from a source map to a result collection and concatenates (flattens) the resulting
* collections adding them into the <code>collector</code>.
* <p>
* <pre class="groovyTestCase">
* def map = [bread:3, milk:5, butter:2]
* def result = map.collectMany(['x']){ k, v {@code ->} k.startsWith('b') ? k.toList() : [] }
* assert result == ['x', 'b', 'r', 'e', 'a', 'd', 'b', 'u', 't', 't', 'e', 'r']
* </pre>
*
* @param self a map
* @param collector an initial collection to add the projected items to
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) to it
* @since 1.8.8
*/
public static <T,K,V> Collection<T> collectMany(Map<K, V> self, Collection<T> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends Collection<? extends T>> projection) {
for (Map.Entry<K, V> entry : self.entrySet()) {
collector.addAll(callClosureForMapEntry(projection, entry));
}
return collector;
}
/**
* Projects each item from a source map to a result collection and concatenates (flattens) the resulting
* collections adding them into a collection.
* <p>
* <pre class="groovyTestCase">
* def map = [bread:3, milk:5, butter:2]
* def result = map.collectMany{ k, v {@code ->} k.startsWith('b') ? k.toList() : [] }
* assert result == ['b', 'r', 'e', 'a', 'd', 'b', 'u', 't', 't', 'e', 'r']
* </pre>
*
* @param self a map
* @param projection a projecting Closure returning a collection of items
* @return the collector with the projected collections concatenated (flattened) to it
* @since 1.8.8
*/
public static <T,K,V> Collection<T> collectMany(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany(self, new ArrayList<T>(), projection);
}
/**
* Projects each item from a source array to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def nums = [1, 2, 3, 4, 5, 6] as Object[]
* def squaresAndCubesOfEvens = nums.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216]
* </pre>
*
* @param self an array
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(Object[], groovy.lang.Closure)
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T,E> List<T> collectMany(E[] self, @ClosureParams(FirstParam.Component.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable<E>)toList(self), projection);
}
/**
* Projects each item from a source iterator to a collection and concatenates (flattens) the resulting collections into a single list.
* <p>
* <pre class="groovyTestCase">
* def numsIter = [1, 2, 3, 4, 5, 6].iterator()
* def squaresAndCubesOfEvens = numsIter.collectMany{ it % 2 ? [] : [it**2, it**3] }
* assert squaresAndCubesOfEvens == [4, 8, 16, 64, 36, 216]
* </pre>
*
* @param self an iterator
* @param projection a projecting Closure returning a collection of items
* @return a list created from the projected collections concatenated (flattened) together
* @see #sum(Iterator, groovy.lang.Closure)
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T,E> List<T> collectMany(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
return collectMany((Iterable)toList(self), projection);
}
/**
* Iterates through this Map transforming each map entry into a new value using the <code>transform</code> closure
* returning the <code>collector</code> with all transformed values added to it.
* <pre class="groovyTestCase">assert [a:1, b:2].collect( [] as HashSet ) { key, value {@code ->} key*value } == ["a", "bb"] as Set
* assert [3:20, 2:30].collect( [] as HashSet ) { entry {@code ->} entry.key * entry.value } == [60] as Set</pre>
*
* @param self a Map
* @param collector the Collection to which transformed values are added
* @param transform the transformation closure which can take one (Map.Entry) or two (key, value) parameters
* @return the collector with all transformed values added to it
* @since 1.0
*/
public static <T,K,V> Collection<T> collect(Map<K, V> self, Collection<T> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends T> transform) {
for (Map.Entry<K, V> entry : self.entrySet()) {
collector.add(callClosureForMapEntry(transform, entry));
}
return collector;
}
/**
* Iterates through this Map transforming each map entry into a new value using the <code>transform</code> closure
* returning a list of transformed values.
* <pre class="groovyTestCase">assert [a:1, b:2].collect { key, value {@code ->} key*value } == ["a", "bb"]
* assert [3:20, 2:30].collect { entry {@code ->} entry.key * entry.value } == [60, 60]</pre>
*
* @param self a Map
* @param transform the transformation closure which can take one (Map.Entry) or two (key, value) parameters
* @return the resultant list of transformed values
* @since 1.0
*/
public static <T,K,V> List<T> collect(Map<K,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> transform) {
return (List<T>) collect(self, new ArrayList<T>(self.size()), transform);
}
/**
* Iterates through this Map transforming each map entry using the <code>transform</code> closure
* returning a map of the transformed entries.
* <pre class="groovyTestCase">
* assert [a:1, b:2].collectEntries( [:] ) { k, v {@code ->} [v, k] } == [1:'a', 2:'b']
* assert [a:1, b:2].collectEntries( [30:'C'] ) { key, value {@code ->}
* [(value*10): key.toUpperCase()] } == [10:'A', 20:'B', 30:'C']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self a Map
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which can take one (Map.Entry) or two (key, value) parameters and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
public static <K, V, S, T> Map<K, V> collectEntries(Map<S, T> self, Map<K, V> collector, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> transform) {
for (Map.Entry<S, T> entry : self.entrySet()) {
addEntry(collector, callClosureForMapEntry(transform, entry));
}
return collector;
}
/**
* Iterates through this Map transforming each entry using the <code>transform</code> closure
* and returning a map of the transformed entries.
* <pre class="groovyTestCase">
* assert [a:1, b:2].collectEntries { key, value {@code ->} [value, key] } == [1:'a', 2:'b']
* assert [a:1, b:2].collectEntries { key, value {@code ->}
* [(value*10): key.toUpperCase()] } == [10:'A', 20:'B']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self a Map
* @param transform the closure used for transforming, which can take one (Map.Entry) or two (key, value) parameters and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
public static <K,V> Map<?, ?> collectEntries(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> transform) {
return collectEntries(self, createSimilarMap(self), transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Closure)
* @since 1.7.9
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Closure<?> transform) {
return collectEntries((Iterable)self, new LinkedHashMap<K, V>(), transform);
}
/**
* A variant of collectEntries for Iterators.
*
* @param self an Iterator
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterable, Closure)
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self, new LinkedHashMap<K, V>(), transform);
}
/**
* Iterates through this Iterable transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* // collect letters with index using list style
* assert (0..2).collectEntries { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* // collect letters with index using map style
* assert (0..2).collectEntries { index {@code ->} [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
*
* @param self an Iterable
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterator, Closure)
* @since 1.8.7
*/
public static <K,V,E> Map<K, V> collectEntries(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self.iterator(), transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable)
* @since 1.8.5
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self) {
return collectEntries((Iterable)self, new LinkedHashMap<K, V>(), Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterators using the identity closure as the transform.
*
* @param self an Iterator
* @return a Map of the transformed entries
* @see #collectEntries(Iterable)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterator<?> self) {
return collectEntries(self, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterable objects using the identity closure as the transform.
* The source Iterable should contain a list of <code>[key, value]</code> tuples or <code>Map.Entry</code> objects.
* <pre class="groovyTestCase">
* def nums = [1, 10, 100, 1000]
* def tuples = nums.collect{ [it, it.toString().size()] }
* assert tuples == [[1, 1], [10, 2], [100, 3], [1000, 4]]
* def map = tuples.collectEntries()
* assert map == [1:1, 10:2, 100:3, 1000:4]
* </pre>
*
* @param self an Iterable
* @return a Map of the transformed entries
* @see #collectEntries(Iterator)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterable<?> self) {
return collectEntries(self.iterator());
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Map, Closure)
* @since 1.7.9
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Map<K, V> collector, Closure<?> transform) {
return collectEntries((Iterable<?>)self, collector, transform);
}
/**
* A variant of collectEntries for Iterators using a supplied map as the destination of transformed entries.
*
* @param self an Iterator
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterator<E> self, Map<K, V> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
while (self.hasNext()) {
E next = self.next();
addEntry(collector, transform.call(next));
}
return collector;
}
/**
* Iterates through this Iterable transforming each item using the closure
* as a transformer into a map entry, returning the supplied map with all of the transformed entries added to it.
* <pre class="groovyTestCase">
* def letters = "abc"
* // collect letters with index
* assert (0..2).collectEntries( [:] ) { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* assert (0..2).collectEntries( [4:'d'] ) { index {@code ->}
* [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self an Iterable
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterator, Map, Closure)
* @since 1.8.7
*/
public static <K, V, E> Map<K, V> collectEntries(Iterable<E> self, Map<K, V> collector, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
return collectEntries(self.iterator(), collector, transform);
}
/**
* @deprecated Use the Iterable version of collectEntries instead
* @see #collectEntries(Iterable, Map)
* @since 1.8.5
*/
@Deprecated
public static <K, V> Map<K, V> collectEntries(Collection<?> self, Map<K, V> collector) {
return collectEntries((Iterable<?>)self, collector, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterators using the identity closure as the
* transform and a supplied map as the destination of transformed entries.
*
* @param self an Iterator
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterable, Map)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterator<?> self, Map<K, V> collector) {
return collectEntries(self, collector, Closure.IDENTITY);
}
/**
* A variant of collectEntries for Iterables using the identity closure as the
* transform and a supplied map as the destination of transformed entries.
*
* @param self an Iterable
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Iterator, Map)
* @since 1.8.7
*/
public static <K, V> Map<K, V> collectEntries(Iterable<?> self, Map<K, V> collector) {
return collectEntries(self.iterator(), collector);
}
/**
* Iterates through this array transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* def nums = [0, 1, 2] as Integer[]
* // collect letters with index
* assert nums.collectEntries( [:] ) { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* assert nums.collectEntries( [4:'d'] ) { index {@code ->}
* [(index+1): letters[index]] } == [1:'a', 2:'b', 3:'c', 4:'d']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
* If your collector Map doesn't support null keys or values, you might get a runtime error, e.g. NullPointerException or IllegalArgumentException.
*
* @param self an array
* @param collector the Map into which the transformed entries are put
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return the collector with all transformed values added to it
* @see #collect(Map, Collection, Closure)
* @since 1.7.9
*/
@SuppressWarnings("unchecked")
public static <K, V, E> Map<K, V> collectEntries(E[] self, Map<K, V> collector, @ClosureParams(FirstParam.Component.class) Closure<?> transform) {
return collectEntries((Iterable)toList(self), collector, transform);
}
/**
* A variant of collectEntries using the identity closure as the transform.
*
* @param self an array
* @param collector the Map into which the transformed entries are put
* @return the collector with all transformed values added to it
* @see #collectEntries(Object[], Map, Closure)
* @since 1.8.5
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self, Map<K, V> collector) {
return collectEntries(self, collector, Closure.IDENTITY);
}
/**
* Iterates through this array transforming each item using the <code>transform</code> closure
* and returning a map of the resulting transformed entries.
* <pre class="groovyTestCase">
* def letters = "abc"
* def nums = [0, 1, 2] as Integer[]
* // collect letters with index using list style
* assert nums.collectEntries { index {@code ->} [index, letters[index]] } == [0:'a', 1:'b', 2:'c']
* // collect letters with index using map style
* assert nums.collectEntries { index {@code ->} [(index): letters[index]] } == [0:'a', 1:'b', 2:'c']
* </pre>
* Note: When using the list-style of result, the behavior is '<code>def (key, value) = listResultFromClosure</code>'.
* While we strongly discourage using a list of size other than 2, Groovy's normal semantics apply in this case;
* throwing away elements after the second one and using null for the key or value for the case of a shortened list.
*
* @param self a Collection
* @param transform the closure used for transforming, which has an item from self as the parameter and
* should return a Map.Entry, a Map or a two-element list containing the resulting key and value
* @return a Map of the transformed entries
* @see #collectEntries(Iterable, Map, Closure)
* @since 1.7.9
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self, @ClosureParams(FirstParam.Component.class) Closure<?> transform) {
return collectEntries((Iterable)toList(self), new LinkedHashMap<K, V>(), transform);
}
/**
* A variant of collectEntries using the identity closure as the transform.
*
* @param self an array
* @return the collector with all transformed values added to it
* @see #collectEntries(Object[], Closure)
* @since 1.8.5
*/
public static <K, V, E> Map<K, V> collectEntries(E[] self) {
return collectEntries(self, Closure.IDENTITY);
}
private static <K, V> void addEntry(Map<K, V> result, Object newEntry) {
if (newEntry instanceof Map) {
leftShift(result, (Map)newEntry);
} else if (newEntry instanceof List) {
List list = (List) newEntry;
// def (key, value) == list
Object key = list.isEmpty() ? null : list.get(0);
Object value = list.size() <= 1 ? null : list.get(1);
leftShift(result, new MapEntry(key, value));
} else if (newEntry.getClass().isArray()) {
Object[] array = (Object[]) newEntry;
// def (key, value) == array.toList()
Object key = array.length == 0 ? null : array[0];
Object value = array.length <= 1 ? null : array[1];
leftShift(result, new MapEntry(key, value));
} else {
// TODO: enforce stricter behavior?
// given Map.Entry is an interface, we get a proxy which gives us lots
// of flexibility but sometimes the error messages might be unexpected
leftShift(result, asType(newEntry, Map.Entry.class));
}
}
/**
* Finds the first value matching the closure condition.
*
* <pre class="groovyTestCase">
* def numbers = [1, 2, 3]
* def result = numbers.find { it {@code >} 1}
* assert result == 2
* </pre>
*
* @param self an Object with an iterator returning its values
* @param closure a closure condition
* @return the first Object found or null if none was found
* @since 1.0
*/
public static Object find(Object self, Closure closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext();) {
Object value = iter.next();
if (bcw.call(value)) {
return value;
}
}
return null;
}
/**
* Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [null, 0, 0.0, false, '', [], 42, 43]
* assert items.find() == 42
* </pre>
*
* @param self an Object with an Iterator returning its values
* @return the first Object found or null if none was found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Object find(Object self) {
return find(self, Closure.IDENTITY);
}
/**
* Finds the first value matching the closure condition. Example:
* <pre class="groovyTestCase">def list = [1,2,3]
* assert 2 == list.find { it {@code >} 1 }
* </pre>
*
* @param self a Collection
* @param closure a closure condition
* @return the first Object found, in the order of the collections iterator, or null if no element matches
* @since 1.0
*/
public static <T> T find(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (T value : self) {
if (bcw.call(value)) {
return value;
}
}
return null;
}
/**
* Finds the first element in the array that matches the given closure condition.
* Example:
* <pre class="groovyTestCase">
* def list = [1,2,3] as Integer[]
* assert 2 == list.find { it {@code >} 1 }
* assert null == list.find { it {@code >} 5 }
* </pre>
*
* @param self an Array
* @param condition a closure condition
* @return the first element from the array that matches the condition or null if no element matches
* @since 2.0
*/
public static <T> T find(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T element : self) {
if (bcw.call(element)) {
return element;
}
}
return null;
}
/**
* Finds the first item matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [null, 0, 0.0, false, '', [], 42, 43]
* assert items.find() == 42
* </pre>
*
* @param self a Collection
* @return the first Object found or null if none was found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static <T> T find(Collection<T> self) {
return find(self, Closure.IDENTITY);
}
/**
* Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns null.
* <p>
* <pre class="groovyTestCase">
* int[] numbers = [1, 2, 3]
* assert numbers.findResult { if(it {@code >} 1) return it } == 2
* assert numbers.findResult { if(it {@code >} 4) return it } == null
* </pre>
*
* @param self an Object with an iterator returning its values
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result of the closure
* @since 1.7.5
*/
public static Object findResult(Object self, Closure condition) {
for (Iterator iter = InvokerHelper.asIterator(self); iter.hasNext(); ) {
Object value = iter.next();
Object result = condition.call(value);
if (result != null) {
return result;
}
}
return null;
}
/**
* Treats the object as iterable, iterating through the values it represents and returns the first non-null result obtained from calling the closure, otherwise returns the defaultResult.
* <p>
* <pre class="groovyTestCase">
* int[] numbers = [1, 2, 3]
* assert numbers.findResult(5) { if(it {@code >} 1) return it } == 2
* assert numbers.findResult(5) { if(it {@code >} 4) return it } == 5
* </pre>
*
* @param self an Object with an iterator returning its values
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result of the closure, otherwise the default value
* @since 1.7.5
*/
public static Object findResult(Object self, Object defaultResult, Closure condition) {
Object result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the collection calling the given closure for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
*
* @param self a Collection
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 1.7.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <S, T, U extends T, V extends T> T findResult(Collection<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
return findResult((Iterable<S>) self, defaultResult, condition);
}
/**
* Iterates through the collection calling the given closure for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self a Collection
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 1.7.5
* @deprecated use the Iterable version instead
*/
@Deprecated
public static <S,T> T findResult(Collection<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
return findResult((Iterable<S>) self, condition);
}
/**
* Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
* <p>
* Examples:
* <pre class="groovyTestCase">
* def iter = [1,2,3].iterator()
* assert "Found 2" == iter.findResult("default") { it {@code >} 1 ? "Found $it" : null }
* assert "default" == iter.findResult("default") { it {@code >} 3 ? "Found $it" : null }
* </pre>
*
* @param self an Iterator
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(Iterator<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the Iterator calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Iterator
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <T, U> T findResult(Iterator<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
while (self.hasNext()) {
U next = self.next();
T result = condition.call(next);
if (result != null) {
return result;
}
}
return null;
}
/**
* Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
* <p>
* Examples:
* <pre class="groovyTestCase">
* def list = [1,2,3]
* assert "Found 2" == list.findResult("default") { it {@code >} 1 ? "Found $it" : null }
* assert "default" == list.findResult("default") { it {@code >} 3 ? "Found $it" : null }
* </pre>
*
* @param self an Iterable
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(Iterable<S> self, U defaultResult, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* Iterates through the Iterable calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Iterable
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <T, U> T findResult(Iterable<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> condition) {
return findResult(self.iterator(), condition);
}
/**
* Iterates through the Array calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all are null, the defaultResult is returned.
*
* @param self an Array
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or the defaultValue
* @since 2.5.0
*/
public static <S, T, U extends T, V extends T> T findResult(S[] self, U defaultResult, @ClosureParams(FirstParam.Component.class) Closure<V> condition) {
return findResult(new ArrayIterator<S>(self), defaultResult, condition);
}
/**
* Iterates through the Array calling the given closure condition for each item but stopping once the first non-null
* result is found and returning that result. If all results are null, null is returned.
*
* @param self an Array
* @param condition a closure that returns a non-null value to indicate that processing should stop and the value should be returned
* @return the first non-null result from calling the closure, or null
* @since 2.5.0
*/
public static <S, T> T findResult(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> condition) {
return findResult(new ArrayIterator<S>(self), condition);
}
/**
* Returns the first non-null closure result found by passing each map entry to the closure, otherwise null is returned.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">
* assert "Found b:3" == [a:1, b:3].findResult { if (it.value == 3) return "Found ${it.key}:${it.value}" }
* assert null == [a:1, b:3].findResult { if (it.value == 9) return "Found ${it.key}:${it.value}" }
* assert "Found a:1" == [a:1, b:3].findResult { k, v {@code ->} if (k.size() + v == 2) return "Found $k:$v" }
* </pre>
*
* @param self a Map
* @param condition a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
* @return the first non-null result collected by calling the closure, or null if no such result was found
* @since 1.7.5
*/
public static <T, K, V> T findResult(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> condition) {
for (Map.Entry<K, V> entry : self.entrySet()) {
T result = callClosureForMapEntry(condition, entry);
if (result != null) {
return result;
}
}
return null;
}
/**
* Returns the first non-null closure result found by passing each map entry to the closure, otherwise the defaultResult is returned.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">
* assert "Found b:3" == [a:1, b:3].findResult("default") { if (it.value == 3) return "Found ${it.key}:${it.value}" }
* assert "default" == [a:1, b:3].findResult("default") { if (it.value == 9) return "Found ${it.key}:${it.value}" }
* assert "Found a:1" == [a:1, b:3].findResult("default") { k, v {@code ->} if (k.size() + v == 2) return "Found $k:$v" }
* </pre>
*
* @param self a Map
* @param defaultResult an Object that should be returned if all closure results are null
* @param condition a 1 or 2 arg Closure that returns a non-null value when processing should stop and a value should be returned
* @return the first non-null result collected by calling the closure, or the defaultResult if no such result was found
* @since 1.7.5
*/
public static <T, U extends T, V extends T, A, B> T findResult(Map<A, B> self, U defaultResult, @ClosureParams(MapEntryOrKeyValue.class) Closure<V> condition) {
T result = findResult(self, condition);
if (result == null) return defaultResult;
return result;
}
/**
* @see #findResults(Iterable, Closure)
* @since 1.8.1
* @deprecated Use the Iterable version of findResults instead
*/
@Deprecated
public static <T, U> Collection<T> findResults(Collection<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
return findResults((Iterable<?>) self, filteringTransform);
}
/**
* Iterates through the Iterable transforming items using the supplied closure
* and collecting any non-null results.
* <p>
* Example:
* <pre class="groovyTestCase">
* def list = [1,2,3]
* def result = list.findResults { it {@code >} 1 ? "Found $it" : null }
* assert result == ["Found 2", "Found 3"]
* </pre>
*
* @param self an Iterable
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.2.0
*/
public static <T, U> Collection<T> findResults(Iterable<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
return findResults(self.iterator(), filteringTransform);
}
/**
* Iterates through the Iterator transforming items using the supplied closure
* and collecting any non-null results.
*
* @param self an Iterator
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.5.0
*/
public static <T, U> Collection<T> findResults(Iterator<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
List<T> result = new ArrayList<T>();
while (self.hasNext()) {
U value = self.next();
T transformed = filteringTransform.call(value);
if (transformed != null) {
result.add(transformed);
}
}
return result;
}
/**
* Iterates through the Array transforming items using the supplied closure
* and collecting any non-null results.
*
* @param self an Array
* @param filteringTransform a Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 2.5.0
*/
public static <T, U> Collection<T> findResults(U[] self, @ClosureParams(FirstParam.Component.class) Closure<T> filteringTransform) {
return findResults(new ArrayIterator<U>(self), filteringTransform);
}
/**
* Iterates through the map transforming items using the supplied closure
* and collecting any non-null results.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <p>
* Example:
* <pre class="groovyTestCase">
* def map = [a:1, b:2, hi:2, cat:3, dog:2]
* def result = map.findResults { k, v {@code ->} k.size() == v ? "Found $k:$v" : null }
* assert result == ["Found a:1", "Found hi:2", "Found cat:3"]
* </pre>
*
* @param self a Map
* @param filteringTransform a 1 or 2 arg Closure that should return either a non-null transformed value or null for items which should be discarded
* @return the list of non-null transformed values
* @since 1.8.1
*/
public static <T, K, V> Collection<T> findResults(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> filteringTransform) {
List<T> result = new ArrayList<T>();
for (Map.Entry<K, V> entry : self.entrySet()) {
T transformed = callClosureForMapEntry(filteringTransform, entry);
if (transformed != null) {
result.add(transformed);
}
}
return result;
}
/**
* Finds the first entry matching the closure condition.
* If the closure takes two parameters, the entry key and value are passed.
* If the closure takes one parameter, the Map.Entry object is passed.
* <pre class="groovyTestCase">assert [a:1, b:3].find { it.value == 3 }.key == "b"</pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure condition
* @return the first Object found
* @since 1.0
*/
public static <K, V> Map.Entry<K, V> find(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<?> closure) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
return entry;
}
}
return null;
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert ([2,4] as Set) == ([1,2,3,4] as Set).findAll { it % 2 == 0 }</pre>
*
* @param self a Set
* @param closure a closure condition
* @return a Set of matching values
* @since 2.4.0
*/
public static <T> Set<T> findAll(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (Set<T>) findAll((Collection<T>) self, closure);
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }</pre>
*
* @param self a List
* @param closure a closure condition
* @return a List of matching values
* @since 2.4.0
*/
public static <T> List<T> findAll(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<T>) findAll((Collection<T>) self, closure);
}
/**
* Finds all values matching the closure condition.
* <pre class="groovyTestCase">assert [2,4] == [1,2,3,4].findAll { it % 2 == 0 }</pre>
*
* @param self a Collection
* @param closure a closure condition
* @return a Collection of matching values
* @since 1.5.6
*/
public static <T> Collection<T> findAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Collection<T> answer = createSimilarCollection(self);
Iterator<T> iter = self.iterator();
return findAll(closure, answer, iter);
}
/**
* Finds all elements of the array matching the given Closure condition.
* <pre class="groovyTestCase">
* def items = [1,2,3,4] as Integer[]
* assert [2,4] == items.findAll { it % 2 == 0 }
* </pre>
*
* @param self an array
* @param condition a closure condition
* @return a list of matching values
* @since 2.0
*/
public static <T> Collection<T> findAll(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
Collection<T> answer = new ArrayList<T>();
return findAll(condition, answer, new ArrayIterator<T>(self));
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Set
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]] as Set
* </pre>
*
* @param self a Set
* @return a Set of the values found
* @since 2.4.0
* @see Closure#IDENTITY
*/
public static <T> Set<T> findAll(Set<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a List
* @return a List of the values found
* @since 2.4.0
* @see Closure#IDENTITY
*/
public static <T> List<T> findAll(List<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self a Collection
* @return a Collection of the values found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static <T> Collection<T> findAll(Collection<T> self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds the elements of the array matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null] as Object[]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an array
* @return a collection of the elements found
* @see Closure#IDENTITY
* @since 2.0
*/
public static <T> Collection<T> findAll(T[] self) {
return findAll(self, Closure.IDENTITY);
}
/**
* Finds all items matching the closure condition.
*
* @param self an Object with an Iterator returning its values
* @param closure a closure condition
* @return a List of the values found
* @since 1.6.0
*/
public static Collection findAll(Object self, Closure closure) {
List answer = new ArrayList();
Iterator iter = InvokerHelper.asIterator(self);
return findAll(closure, answer, iter);
}
/**
* Finds all items matching the IDENTITY Closure (i.e. matching Groovy truth).
* <p>
* Example:
* <pre class="groovyTestCase">
* def items = [1, 2, 0, false, true, '', 'foo', [], [4, 5], null]
* assert items.findAll() == [1, 2, true, 'foo', [4, 5]]
* </pre>
*
* @param self an Object with an Iterator returning its values
* @return a List of the values found
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Collection findAll(Object self) {
return findAll(self, Closure.IDENTITY);
}
private static <T> Collection<T> findAll(Closure closure, Collection<T> answer, Iterator<? extends T> iter) {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (iter.hasNext()) {
T value = iter.next();
if (bcw.call(value)) {
answer.add(value);
}
}
return answer;
}
/**
* Returns <tt>true</tt> if this iterable contains the item.
*
* @param self an Iterable to be checked for containment
* @param item an Object to be checked for containment in this iterable
* @return <tt>true</tt> if this iterable contains the item
* @see Collection#contains(Object)
* @since 2.4.0
*/
public static boolean contains(Iterable self, Object item) {
for (Object e : self) {
if (Objects.equals(item, e)) {
return true;
}
}
return false;
}
/**
* Returns <tt>true</tt> if this iterable contains all of the elements
* in the specified array.
*
* @param self an Iterable to be checked for containment
* @param items array to be checked for containment in this iterable
* @return <tt>true</tt> if this collection contains all of the elements
* in the specified array
* @see Collection#containsAll(Collection)
* @since 2.4.0
*/
public static boolean containsAll(Iterable self, Object[] items) {
return asCollection(self).containsAll(Arrays.asList(items));
}
/**
* @deprecated use the Iterable variant instead
* @see #containsAll(Iterable, Object[])
* @since 1.7.2
*/
@Deprecated
public static boolean containsAll(Collection self, Object[] items) {
return self.containsAll(Arrays.asList(items));
}
/**
* Modifies this collection by removing its elements that are contained
* within the specified object array.
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which don't match some criteria while leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be removed from this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#removeAll(Collection)
* @since 1.7.2
*/
public static boolean removeAll(Collection self, Object[] items) {
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(Arrays.asList(items));
return self.removeAll(pickFrom);
}
/**
* Modifies this collection so that it retains only its elements that are contained
* in the specified array. In other words, removes from this collection all of
* its elements that are not contained in the specified array.
*
* See also <code>grep</code> and <code>findAll</code> when wanting to produce a new list
* containing items which match some specified items but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be retained from this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#retainAll(Collection)
* @since 1.7.2
*/
public static boolean retainAll(Collection self, Object[] items) {
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(Arrays.asList(items));
return self.retainAll(pickFrom);
}
/**
* Modifies this collection so that it retains only its elements
* that are matched according to the specified closure condition. In other words,
* removes from this collection all of its elements that don't match.
*
* <pre class="groovyTestCase">def list = ['a', 'b']
* list.retainAll { it == 'b' }
* assert list == ['b']</pre>
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which match some criteria but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param condition a closure condition
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Iterator#remove()
* @since 1.7.2
*/
public static <T> boolean retainAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Iterator iter = InvokerHelper.asIterator(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Object value = iter.next();
if (!bcw.call(value)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this map so that it retains only its elements that are matched
* according to the specified closure condition. In other words, removes from
* this map all of its elements that don't match. If the closure takes one
* parameter then it will be passed the <code>Map.Entry</code>. Otherwise the closure should
* take two parameters, which will be the key and the value.
*
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map.retainAll { k,v {@code ->} k == 'b' }
* assert map == [b:2]</pre>
*
* See also <code>findAll</code> when wanting to produce a new map containing items
* which match some criteria but leaving the original map unchanged.
*
* @param self a Map to be modified
* @param condition a 1 or 2 arg Closure condition applying on the entries
* @return <tt>true</tt> if this map changed as a result of the call
* @since 2.5.0
*/
public static <K, V> boolean retainAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
Iterator<Map.Entry<K, V>> iter = self.entrySet().iterator();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Map.Entry<K, V> entry = iter.next();
if (!bcw.callForMap(entry)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this collection by removing the elements that are matched according
* to the specified closure condition.
*
* <pre class="groovyTestCase">def list = ['a', 'b']
* list.removeAll { it == 'b' }
* assert list == ['a']</pre>
*
* See also <code>findAll</code> and <code>grep</code> when wanting to produce a new list
* containing items which match some criteria but leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param condition a closure condition
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Iterator#remove()
* @since 1.7.2
*/
public static <T> boolean removeAll(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Iterator iter = InvokerHelper.asIterator(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Object value = iter.next();
if (bcw.call(value)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies this map by removing the elements that are matched according to the
* specified closure condition. If the closure takes one parameter then it will be
* passed the <code>Map.Entry</code>. Otherwise the closure should take two parameters, which
* will be the key and the value.
*
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map.removeAll { k,v {@code ->} k == 'b' }
* assert map == [a:1]</pre>
*
* See also <code>findAll</code> when wanting to produce a new map containing items
* which match some criteria but leaving the original map unchanged.
*
* @param self a Map to be modified
* @param condition a 1 or 2 arg Closure condition applying on the entries
* @return <tt>true</tt> if this map changed as a result of the call
* @since 2.5.0
*/
public static <K, V> boolean removeAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
Iterator<Map.Entry<K, V>> iter = self.entrySet().iterator();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
boolean result = false;
while (iter.hasNext()) {
Map.Entry<K, V> entry = iter.next();
if (bcw.callForMap(entry)) {
iter.remove();
result = true;
}
}
return result;
}
/**
* Modifies the collection by adding all of the elements in the specified array to the collection.
* The behavior of this operation is undefined if
* the specified array is modified while the operation is in progress.
*
* See also <code>plus</code> or the '+' operator if wanting to produce a new collection
* containing additional items but while leaving the original collection unchanged.
*
* @param self a Collection to be modified
* @param items array containing elements to be added to this collection
* @return <tt>true</tt> if this collection changed as a result of the call
* @see Collection#addAll(Collection)
* @since 1.7.2
*/
public static <T> boolean addAll(Collection<T> self, T[] items) {
return self.addAll(Arrays.asList(items));
}
/**
* Modifies this list by inserting all of the elements in the specified array into the
* list at the specified position. Shifts the
* element currently at that position (if any) and any subsequent
* elements to the right (increases their indices). The new elements
* will appear in this list in the order that they occur in the array.
* The behavior of this operation is undefined if the specified array
* is modified while the operation is in progress.
*
* See also <code>plus</code> for similar functionality with copy semantics, i.e. which produces a new
* list after adding the additional items at the specified position but leaves the original list unchanged.
*
* @param self a list to be modified
* @param items array containing elements to be added to this collection
* @param index index at which to insert the first element from the
* specified array
* @return <tt>true</tt> if this collection changed as a result of the call
* @see List#addAll(int, Collection)
* @since 1.7.2
*/
public static <T> boolean addAll(List<T> self, int index, T[] items) {
return self.addAll(index, Arrays.asList(items));
}
/**
* Splits all items into two lists based on the closure condition.
* The first list contains all items matching the closure expression.
* The second list all those that don't.
*
* @param self an Object with an Iterator returning its values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 1.6.0
*/
public static Collection split(Object self, Closure closure) {
List accept = new ArrayList();
List reject = new ArrayList();
return split(closure, accept, reject, InvokerHelper.asIterator(self));
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }</pre>
*
* @param self a Collection of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 1.6.0
*/
public static <T> Collection<Collection<T>> split(Collection<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Collection<T> accept = createSimilarCollection(self);
Collection<T> reject = createSimilarCollection(self);
Iterator<T> iter = self.iterator();
return split(closure, accept, reject, iter);
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
*
* @param self an Array
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.5.0
*/
public static <T> Collection<Collection<T>> split(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
List<T> accept = new ArrayList<T>();
List<T> reject = new ArrayList<T>();
Iterator<T> iter = new ArrayIterator<T>(self);
return split(closure, accept, reject, iter);
}
private static <T> Collection<Collection<T>> split(Closure closure, Collection<T> accept, Collection<T> reject, Iterator<T> iter) {
List<Collection<T>> answer = new ArrayList<Collection<T>>();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
while (iter.hasNext()) {
T value = iter.next();
if (bcw.call(value)) {
accept.add(value);
} else {
reject.add(value);
}
}
answer.add(accept);
answer.add(reject);
return answer;
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4],[1,3]] == [1,2,3,4].split { it % 2 == 0 }</pre>
*
* @param self a List of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.4.0
*/
@SuppressWarnings("unchecked")
public static <T> List<List<T>> split(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<List<T>>) (List<?>) split((Collection<T>) self, closure);
}
/**
* Splits all items into two collections based on the closure condition.
* The first list contains all items which match the closure expression.
* The second list all those that don't.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2,4] as Set, [1,3] as Set] == ([1,2,3,4] as Set).split { it % 2 == 0 }</pre>
*
* @param self a Set of values
* @param closure a closure condition
* @return a List whose first item is the accepted values and whose second item is the rejected values
* @since 2.4.0
*/
@SuppressWarnings("unchecked")
public static <T> List<Set<T>> split(Set<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return (List<Set<T>>) (List<?>) split((Collection<T>) self, closure);
}
/**
* @deprecated Use the Iterable version of combinations instead
* @see #combinations(Iterable)
* @since 1.5.0
*/
@Deprecated
public static List combinations(Collection self) {
return combinations((Iterable)self);
}
/**
* Adds GroovyCollections#combinations(Iterable) as a method on Iterables.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [['a', 'b'],[1, 2, 3]].combinations() == [['a', 1], ['b', 1], ['a', 2], ['b', 2], ['a', 3], ['b', 3]]
* </pre>
*
* @param self an Iterable of collections
* @return a List of the combinations found
* @see groovy.util.GroovyCollections#combinations(java.lang.Iterable)
* @since 2.2.0
*/
public static List combinations(Iterable self) {
return GroovyCollections.combinations(self);
}
/**
* Adds GroovyCollections#combinations(Iterable, Closure) as a method on collections.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [[2, 3],[4, 5, 6]].combinations {x,y {@code ->} x*y } == [8, 12, 10, 15, 12, 18]</pre>
*
* @param self a Collection of lists
* @param function a closure to be called on each combination
* @return a List of the results of applying the closure to each combinations found
* @see groovy.util.GroovyCollections#combinations(Iterable)
* @since 2.2.0
*/
public static List combinations(Iterable self, Closure<?> function) {
return collect((Iterable)GroovyCollections.combinations(self), function);
}
/**
* Applies a function on each combination of the input lists.
* <p>
* Example usage:
* <pre class="groovyTestCase">[[2, 3],[4, 5, 6]].eachCombination { println "Found $it" }</pre>
*
* @param self a Collection of lists
* @param function a closure to be called on each combination
* @see groovy.util.GroovyCollections#combinations(Iterable)
* @since 2.2.0
*/
public static void eachCombination(Iterable self, Closure<?> function) {
each(GroovyCollections.combinations(self), function);
}
/**
* Finds all non-null subsequences of a list.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [1, 2, 3].subsequences()
* assert result == [[1, 2, 3], [1, 3], [2, 3], [1, 2], [1], [2], [3]] as Set</pre>
*
* @param self the List of items
* @return the subsequences from the list
* @since 1.7.0
*/
public static <T> Set<List<T>> subsequences(List<T> self) {
return GroovyCollections.subsequences(self);
}
/**
* Finds all permutations of an iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [1, 2, 3].permutations()
* assert result == [[3, 2, 1], [3, 1, 2], [1, 3, 2], [2, 3, 1], [2, 1, 3], [1, 2, 3]] as Set</pre>
*
* @param self the Iterable of items
* @return the permutations from the list
* @since 1.7.0
*/
public static <T> Set<List<T>> permutations(Iterable<T> self) {
Set<List<T>> ans = new HashSet<List<T>>();
PermutationGenerator<T> generator = new PermutationGenerator<T>(self);
while (generator.hasNext()) {
ans.add(generator.next());
}
return ans;
}
/**
* @deprecated Use the Iterable version of permutations instead
* @see #permutations(Iterable)
* @since 1.7.0
*/
@Deprecated
public static <T> Set<List<T>> permutations(List<T> self) {
return permutations((Iterable<T>) self);
}
/**
* Finds all permutations of an iterable, applies a function to each permutation and collects the result
* into a list.
* <p>
* Example usage:
* <pre class="groovyTestCase">Set result = [1, 2, 3].permutations { it.collect { v {@code ->} 2*v }}
* assert result == [[6, 4, 2], [6, 2, 4], [2, 6, 4], [4, 6, 2], [4, 2, 6], [2, 4, 6]] as Set</pre>
*
* @param self the Iterable of items
* @param function the function to apply on each permutation
* @return the list of results of the application of the function on each permutation
* @since 2.2.0
*/
public static <T,V> List<V> permutations(Iterable<T> self, Closure<V> function) {
return collect((Iterable<List<T>>) permutations(self),function);
}
/**
* @deprecated Use the Iterable version of permutations instead
* @see #permutations(Iterable, Closure)
* @since 2.2.0
*/
@Deprecated
public static <T, V> List<V> permutations(List<T> self, Closure<V> function) {
return permutations((Iterable<T>) self, function);
}
/**
* @deprecated Use the Iterable version of eachPermutation instead
* @see #eachPermutation(Iterable, Closure)
* @since 1.7.0
*/
@Deprecated
public static <T> Iterator<List<T>> eachPermutation(Collection<T> self, Closure closure) {
return eachPermutation((Iterable<T>) self, closure);
}
/**
* Iterates over all permutations of a collection, running a closure for each iteration.
* <p>
* Example usage:
* <pre class="groovyTestCase">def permutations = []
* [1, 2, 3].eachPermutation{ permutations << it }
* assert permutations == [[1, 2, 3], [1, 3, 2], [2, 1, 3], [2, 3, 1], [3, 1, 2], [3, 2, 1]]</pre>
*
* @param self the Collection of items
* @param closure the closure to call for each permutation
* @return the permutations from the list
* @since 1.7.0
*/
public static <T> Iterator<List<T>> eachPermutation(Iterable<T> self, Closure closure) {
Iterator<List<T>> generator = new PermutationGenerator<T>(self);
while (generator.hasNext()) {
closure.call(generator.next());
}
return generator;
}
/**
* Adds GroovyCollections#transpose(List) as a method on lists.
* A Transpose Function takes a collection of columns and returns a collection of
* rows. The first row consists of the first element from each column. Successive
* rows are constructed similarly.
* <p>
* Example usage:
* <pre class="groovyTestCase">def result = [['a', 'b'], [1, 2]].transpose()
* assert result == [['a', 1], ['b', 2]]</pre>
* <pre class="groovyTestCase">def result = [['a', 'b'], [1, 2], [3, 4]].transpose()
* assert result == [['a', 1, 3], ['b', 2, 4]]</pre>
*
* @param self a List of lists
* @return a List of the transposed lists
* @see groovy.util.GroovyCollections#transpose(java.util.List)
* @since 1.5.0
*/
public static List transpose(List self) {
return GroovyCollections.transpose(self);
}
/**
* Finds all entries matching the closure condition. If the
* closure takes one parameter then it will be passed the Map.Entry.
* Otherwise if the closure should take two parameters, which will be
* the key and the value.
* <p>
* If the <code>self</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [a:1, b:2, c:4, d:5].findAll { it.value % 2 == 0 }
* assert result.every { it instanceof Map.Entry }
* assert result*.key == ["b", "c"]
* assert result*.value == [2, 4]
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure condition applying on the entries
* @return a new subMap
* @since 1.0
*/
public static <K, V> Map<K, V> findAll(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure closure) {
Map<K, V> answer = createSimilarMap(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (bcw.callForMap(entry)) {
answer.put(entry.getKey(), entry.getValue());
}
}
return answer;
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <K, T> Map<K, List<T>> groupBy(Collection<T> self, Closure<K> closure) {
return groupBy((Iterable<T>)self, closure);
}
/**
* Sorts all Iterable members into groups determined by the supplied mapping closure.
* The closure should return the key that this item should be grouped by. The returned
* LinkedHashMap will have an entry for each distinct key returned from the closure,
* with each value being a list of items for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [0:[2,4,6], 1:[1,3,5]] == [1,2,3,4,5,6].groupBy { it % 2 }
* </pre>
*
* @param self a collection to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @since 2.2.0
*/
public static <K, T> Map<K, List<T>> groupBy(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
Map<K, List<T>> answer = new LinkedHashMap<K, List<T>>();
for (T element : self) {
K value = closure.call(element);
groupAnswer(answer, element, value);
}
return answer;
}
/**
* Sorts all array members into groups determined by the supplied mapping closure.
* The closure should return the key that this item should be grouped by. The returned
* LinkedHashMap will have an entry for each distinct key returned from the closure,
* with each value being a list of items for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* Integer[] items = [1,2,3,4,5,6]
* assert [0:[2,4,6], 1:[1,3,5]] == items.groupBy { it % 2 }
* </pre>
*
* @param self an array to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @see #groupBy(Iterable, Closure)
* @since 2.2.0
*/
public static <K, T> Map<K, List<T>> groupBy(T[] self, @ClosureParams(FirstParam.Component.class) Closure<K> closure) {
return groupBy((Iterable<T>)Arrays.asList(self), closure);
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, Object...)
* @since 1.8.1
*/
@Deprecated
public static Map groupBy(Collection self, Object... closures) {
return groupBy((Iterable)self, closures);
}
/**
* Sorts all Iterable members into (sub)groups determined by the supplied
* mapping closures. Each closure should return the key that this item
* should be grouped by. The returned LinkedHashMap will have an entry for each
* distinct 'key path' returned from the closures, with each value being a list
* of items for that 'group path'.
*
* Example usage:
* <pre class="groovyTestCase">def result = [1,2,3,4,5,6].groupBy({ it % 2 }, { it {@code <} 4 })
* assert result == [1:[(true):[1, 3], (false):[5]], 0:[(true):[2], (false):[4, 6]]]</pre>
*
* Another example:
* <pre>def sql = groovy.sql.Sql.newInstance(/* ... */)
* def data = sql.rows("SELECT * FROM a_table").groupBy({ it.column1 }, { it.column2 }, { it.column3 })
* if (data.val1.val2.val3) {
* // there exists a record where:
* // a_table.column1 == val1
* // a_table.column2 == val2, and
* // a_table.column3 == val3
* } else {
* // there is no such record
* }</pre>
* If an empty array of closures is supplied the IDENTITY Closure will be used.
*
* @param self a collection to group
* @param closures an array of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @since 2.2.0
* @see Closure#IDENTITY
*/
public static Map groupBy(Iterable self, Object... closures) {
final Closure head = closures.length == 0 ? Closure.IDENTITY : (Closure) closures[0];
@SuppressWarnings("unchecked")
Map<Object, List> first = groupBy(self, head);
if (closures.length < 2)
return first;
final Object[] tail = new Object[closures.length - 1];
System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
// inject([:]) { a,e {@code ->} a {@code <<} [(e.key): e.value.groupBy(tail)] }
Map<Object, Map> acc = new LinkedHashMap<Object, Map>();
for (Map.Entry<Object, List> item : first.entrySet()) {
acc.put(item.getKey(), groupBy((Iterable)item.getValue(), tail));
}
return acc;
}
/**
* Sorts all array members into (sub)groups determined by the supplied
* mapping closures as per the Iterable variant of this method.
*
* @param self an array to group
* @param closures an array of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @see #groupBy(Iterable, Object...)
* @see Closure#IDENTITY
* @since 2.2.0
*/
public static Map groupBy(Object[] self, Object... closures) {
return groupBy((Iterable)Arrays.asList(self), closures);
}
/**
* @deprecated Use the Iterable version of groupBy instead
* @see #groupBy(Iterable, List)
* @since 1.8.1
*/
@Deprecated
public static Map groupBy(Collection self, List<Closure> closures) {
return groupBy((Iterable)self, closures);
}
/**
* Sorts all Iterable members into (sub)groups determined by the supplied
* mapping closures. Each closure should return the key that this item
* should be grouped by. The returned LinkedHashMap will have an entry for each
* distinct 'key path' returned from the closures, with each value being a list
* of items for that 'group path'.
*
* Example usage:
* <pre class="groovyTestCase">
* def result = [1,2,3,4,5,6].groupBy([{ it % 2 }, { it {@code <} 4 }])
* assert result == [1:[(true):[1, 3], (false):[5]], 0:[(true):[2], (false):[4, 6]]]
* </pre>
*
* Another example:
* <pre>
* def sql = groovy.sql.Sql.newInstance(/* ... */)
* def data = sql.rows("SELECT * FROM a_table").groupBy([{ it.column1 }, { it.column2 }, { it.column3 }])
* if (data.val1.val2.val3) {
* // there exists a record where:
* // a_table.column1 == val1
* // a_table.column2 == val2, and
* // a_table.column3 == val3
* } else {
* // there is no such record
* }
* </pre>
* If an empty list of closures is supplied the IDENTITY Closure will be used.
*
* @param self a collection to group
* @param closures a list of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @since 2.2.0
* @see Closure#IDENTITY
*/
public static Map groupBy(Iterable self, List<Closure> closures) {
return groupBy(self, closures.toArray());
}
/**
* Sorts all array members into (sub)groups determined by the supplied
* mapping closures as per the list variant of this method.
*
* @param self an array to group
* @param closures a list of closures, each mapping entries on keys
* @return a new Map grouped by keys on each criterion
* @see Closure#IDENTITY
* @see #groupBy(Iterable, List)
* @since 2.2.0
*/
public static Map groupBy(Object[] self, List<Closure> closures) {
return groupBy((Iterable)Arrays.asList(self), closures);
}
/**
* @deprecated Use the Iterable version of countBy instead
* @see #countBy(Iterable, Closure)
* @since 1.8.0
*/
@Deprecated
public static <K> Map<K, Integer> countBy(Collection self, Closure<K> closure) {
return countBy((Iterable) self, closure);
}
/**
* Sorts all collection members into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [0:2, 1:3] == [1,2,3,4,5].countBy { it % 2 }</pre>
*
* @param self a collection to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @since 2.2.0
*/
public static <K,E> Map<K, Integer> countBy(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
return countBy(self.iterator(), closure);
}
/**
* Sorts all array members into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert ([1,2,2,2,3] as Object[]).countBy{ it % 2 } == [1:2, 0:3]</pre>
*
* @param self an array to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @see #countBy(Collection, Closure)
* @since 1.8.0
*/
public static <K,E> Map<K, Integer> countBy(E[] self, @ClosureParams(FirstParam.Component.class) Closure<K> closure) {
return countBy((Iterable)Arrays.asList(self), closure);
}
/**
* Sorts all iterator items into groups determined by the supplied mapping
* closure and counts the group size. The closure should return the key that each
* item should be grouped by. The returned Map will have an entry for each
* distinct key returned from the closure, with each value being the frequency of
* items occurring for that group.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [1,2,2,2,3].toSet().iterator().countBy{ it % 2 } == [1:2, 0:1]</pre>
*
* @param self an iterator to group and count
* @param closure a closure mapping items to the frequency keys
* @return a new Map grouped by keys with frequency counts
* @see #countBy(Collection, Closure)
* @since 1.8.0
*/
public static <K,E> Map<K, Integer> countBy(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
Map<K, Integer> answer = new LinkedHashMap<K, Integer>();
while (self.hasNext()) {
K value = closure.call(self.next());
countAnswer(answer, value);
}
return answer;
}
/**
* Groups all map entries into groups determined by the
* supplied mapping closure. The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the list of map entries that belong to each
* group. (If instead of a list of map entries, you want an actual map
* use {code}groupBy{code}.)
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupEntriesBy { it.value % 2 }
* assert result[0]*.key == ["b", "d", "f"]
* assert result[1]*.value == [1, 3, 5]</pre>
*
* @param self a map to group
* @param closure a 1 or 2 arg Closure mapping entries on keys
* @return a new Map grouped by keys
* @since 1.5.2
*/
public static <G, K, V> Map<G, List<Map.Entry<K, V>>> groupEntriesBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
final Map<G, List<Map.Entry<K, V>>> answer = new LinkedHashMap<G, List<Map.Entry<K, V>>>();
for (Map.Entry<K, V> entry : self.entrySet()) {
G value = callClosureForMapEntry(closure, entry);
groupAnswer(answer, entry, value);
}
return answer;
}
/**
* Groups the members of a map into sub maps determined by the
* supplied mapping closure. The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the map members from the original map that
* belong to each group. (If instead of a map, you want a list of map entries
* use {code}groupEntriesBy{code}.)
* <p>
* If the <code>self</code> map is one of TreeMap, Hashtable or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy { it.value % 2 }
* assert result == [0:[b:2, d:4, f:6], 1:[a:1, c:3, e:5]]</pre>
*
* @param self a map to group
* @param closure a closure mapping entries on keys
* @return a new Map grouped by keys
* @since 1.0
*/
public static <G, K, V> Map<G, Map<K, V>> groupBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
final Map<G, List<Map.Entry<K, V>>> initial = groupEntriesBy(self, closure);
final Map<G, Map<K, V>> answer = new LinkedHashMap<G, Map<K, V>>();
for (Map.Entry<G, List<Map.Entry<K, V>>> outer : initial.entrySet()) {
G key = outer.getKey();
List<Map.Entry<K, V>> entries = outer.getValue();
Map<K, V> target = createSimilarMap(self);
putAll(target, entries);
answer.put(key, target);
}
return answer;
}
/**
* Groups the members of a map into sub maps determined by the supplied
* mapping closures. Each closure will be passed a Map.Entry or key and
* value (depending on the number of parameters the closure accepts) and
* should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group path' returned by all
* closures, with values being the map members from the original map that
* belong to each such 'group path'.
*
* If the <code>self</code> map is one of TreeMap, Hashtable, or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
*
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy({ it.value % 2 }, { it.key.next() })
* assert result == [1:[b:[a:1], d:[c:3], f:[e:5]], 0:[c:[b:2], e:[d:4], g:[f:6]]]</pre>
* If an empty array of closures is supplied the IDENTITY Closure will be used.
*
* @param self a map to group
* @param closures an array of closures that map entries on keys
* @return a new map grouped by keys on each criterion
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Map<Object, Map> groupBy(Map self, Object... closures) {
@SuppressWarnings("unchecked")
final Closure<Object> head = closures.length == 0 ? Closure.IDENTITY : (Closure) closures[0];
@SuppressWarnings("unchecked")
Map<Object, Map> first = groupBy(self, head);
if (closures.length < 2)
return first;
final Object[] tail = new Object[closures.length - 1];
System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
Map<Object, Map> acc = new LinkedHashMap<Object, Map>();
for (Map.Entry<Object, Map> item: first.entrySet()) {
acc.put(item.getKey(), groupBy(item.getValue(), tail));
}
return acc;
}
/**
* Groups the members of a map into sub maps determined by the supplied
* mapping closures. Each closure will be passed a Map.Entry or key and
* value (depending on the number of parameters the closure accepts) and
* should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group path' returned by all
* closures, with values being the map members from the original map that
* belong to each such 'group path'.
*
* If the <code>self</code> map is one of TreeMap, Hashtable, or Properties,
* the returned Map will preserve that type, otherwise a LinkedHashMap will
* be returned.
*
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5,f:6].groupBy([{ it.value % 2 }, { it.key.next() }])
* assert result == [1:[b:[a:1], d:[c:3], f:[e:5]], 0:[c:[b:2], e:[d:4], g:[f:6]]]</pre>
* If an empty list of closures is supplied the IDENTITY Closure will be used.
*
* @param self a map to group
* @param closures a list of closures that map entries on keys
* @return a new map grouped by keys on each criterion
* @since 1.8.1
* @see Closure#IDENTITY
*/
public static Map<Object, Map> groupBy(Map self, List<Closure> closures) {
return groupBy(self, closures.toArray());
}
/**
* Groups the members of a map into groups determined by the
* supplied mapping closure and counts the frequency of the created groups.
* The closure will be passed a Map.Entry or
* key and value (depending on the number of parameters the closure accepts)
* and should return the key that each item should be grouped under. The
* resulting map will have an entry for each 'group' key returned by the
* closure, with values being the frequency counts for that 'group'.
* <p>
* <pre class="groovyTestCase">def result = [a:1,b:2,c:3,d:4,e:5].countBy { it.value % 2 }
* assert result == [0:2, 1:3]</pre>
*
* @param self a map to group and count
* @param closure a closure mapping entries to frequency count keys
* @return a new Map grouped by keys with frequency counts
* @since 1.8.0
*/
public static <K,U,V> Map<K, Integer> countBy(Map<U,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<K> closure) {
Map<K, Integer> answer = new LinkedHashMap<K, Integer>();
for (Map.Entry<U,V> entry : self.entrySet()) {
countAnswer(answer, callClosureForMapEntry(closure, entry));
}
return answer;
}
/**
* Groups the current element according to the value
*
* @param answer the map containing the results
* @param element the element to be placed
* @param value the value according to which the element will be placed
* @since 1.5.0
*/
protected static <K, T> void groupAnswer(final Map<K, List<T>> answer, T element, K value) {
List<T> groupedElements = answer.computeIfAbsent(value, k -> new ArrayList<T>());
groupedElements.add(element);
}
private static <T> void countAnswer(final Map<T, Integer> answer, T mappedKey) {
Integer current = answer.get(mappedKey);
if (null == current) {
current = 0;
}
answer.put(mappedKey, current + 1);
}
// internal helper method
protected static <T, K, V> T callClosureForMapEntry(@ClosureParams(value=FromString.class, options={"K,V","Map.Entry<K,V>"}) Closure<T> closure, Map.Entry<K,V> entry) {
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(entry.getKey(), entry.getValue());
}
return closure.call(entry);
}
// internal helper method
protected static <T> T callClosureForLine(@ClosureParams(value=FromString.class, options={"String","String,Integer"}) Closure<T> closure, String line, int counter) {
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(line, counter);
}
return closure.call(line);
}
// internal helper method
protected static <T, K, V> T callClosureForMapEntryAndCounter(@ClosureParams(value=FromString.class, options={"K,V,Integer", "K,V","Map.Entry<K,V>"}) Closure<T> closure, Map.Entry<K,V> entry, int counter) {
if (closure.getMaximumNumberOfParameters() == 3) {
return closure.call(entry.getKey(), entry.getValue(), counter);
}
if (closure.getMaximumNumberOfParameters() == 2) {
return closure.call(entry, counter);
}
return closure.call(entry);
}
/**
* Performs the same function as the version of inject that takes an initial value, but
* uses the head of the Collection as the initial value, and iterates over the tail.
* <pre class="groovyTestCase">
* assert 1 * 2 * 3 * 4 == [ 1, 2, 3, 4 ].inject { acc, val {@code ->} acc * val }
* assert ['b'] == [['a','b'], ['b','c'], ['d','b']].inject { acc, val {@code ->} acc.intersect( val ) }
* LinkedHashSet set = [ 't', 'i', 'm' ]
* assert 'tim' == set.inject { a, b {@code ->} a + b }
* </pre>
*
* @param self a Collection
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the collection is empty.
* @see #inject(Collection, Object, Closure)
* @since 1.8.7
*/
public static <T, V extends T> T inject(Collection<T> self, @ClosureParams(value=FromString.class,options="V,T") Closure<V> closure ) {
if( self.isEmpty() ) {
throw new NoSuchElementException( "Cannot call inject() on an empty collection without passing an initial value." ) ;
}
Iterator<T> iter = self.iterator();
T head = iter.next();
Collection<T> tail = tail(self);
if (!tail.iterator().hasNext()) {
return head;
}
// cast with explicit weaker generics for now to keep jdk6 happy, TODO: find better fix
return (T) inject((Collection) tail, head, closure);
}
/**
* Iterates through the given Collection, passing in the initial value to
* the 2-arg closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the entire collection
* has been used. Also known as <tt>foldLeft</tt> or <tt>reduce</tt> in functional parlance.
*
* Examples:
* <pre class="groovyTestCase">
* assert 1*1*2*3*4 == [1,2,3,4].inject(1) { acc, val {@code ->} acc * val }
*
* assert 0+1+2+3+4 == [1,2,3,4].inject(0) { acc, val {@code ->} acc + val }
*
* assert 'The quick brown fox' ==
* ['quick', 'brown', 'fox'].inject('The') { acc, val {@code ->} acc + ' ' + val }
*
* assert 'bat' ==
* ['rat', 'bat', 'cat'].inject('zzz') { min, next {@code ->} next {@code <} min ? next : min }
*
* def max = { a, b {@code ->} [a, b].max() }
* def animals = ['bat', 'rat', 'cat']
* assert 'rat' == animals.inject('aaa', max)
* </pre>
* Visual representation of the last example above:
* <pre>
* initVal animals[0]
* v v
* max('aaa', 'bat') {@code =>} 'bat' animals[1]
* v v
* max('bat', 'rat') {@code =>} 'rat' animals[2]
* v v
* max('rat', 'cat') {@code =>} 'rat'
* </pre>
*
* @param self a Collection
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @since 1.0
*/
public static <E, T, U extends T, V extends T> T inject(Collection<E> self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
// cast with explicit weaker generics for now to keep jdk6 happy, TODO: find better fix
return (T) inject((Iterator) self.iterator(), initialValue, closure);
}
/**
* Iterates through the given Map, passing in the initial value to
* the 2-arg Closure along with the first item (or 3-arg Closure along with the first key and value).
* The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the entire collection
* has been used. Also known as <tt>foldLeft</tt> or <tt>reduce</tt> in functional parlance.
*
* Examples:
* <pre class="groovyTestCase">
* def map = [a:1, b:2, c:3]
* assert map.inject([]) { list, k, v {@code ->}
* list + [k] * v
* } == ['a', 'b', 'b', 'c', 'c', 'c']
* </pre>
*
* @param self a Map
* @param initialValue some initial value
* @param closure a 2 or 3 arg Closure
* @return the result of the last closure call
* @since 1.8.1
*/
public static <K, V, T, U extends T, W extends T> T inject(Map<K, V> self, U initialValue, @ClosureParams(value=FromString.class,options={"U,Map.Entry<K,V>","U,K,V"}) Closure<W> closure) {
T value = initialValue;
for (Map.Entry<K, V> entry : self.entrySet()) {
if (closure.getMaximumNumberOfParameters() == 3) {
value = closure.call(value, entry.getKey(), entry.getValue());
} else {
value = closure.call(value, entry);
}
}
return value;
}
/**
* Iterates through the given Iterator, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until the Iterator has been
* expired of values. Also known as foldLeft in functional parlance.
*
* @param self an Iterator
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <E,T, U extends T, V extends T> T inject(Iterator<E> self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
T value = initialValue;
Object[] params = new Object[2];
while (self.hasNext()) {
Object item = self.next();
params[0] = value;
params[1] = item;
value = closure.call(params);
}
return value;
}
/**
* Iterates through the given Object, passing in the first value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until further iteration of
* the object is not possible. Also known as foldLeft in functional parlance.
*
* @param self an Object
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the collection is empty.
* @see #inject(Collection, Object, Closure)
* @since 1.8.7
*/
public static <T, V extends T> T inject(Object self, Closure<V> closure) {
Iterator iter = InvokerHelper.asIterator(self);
if( !iter.hasNext() ) {
throw new NoSuchElementException( "Cannot call inject() over an empty iterable without passing an initial value." ) ;
}
Object initialValue = iter.next() ;
return (T) inject(iter, initialValue, closure);
}
/**
* Iterates through the given Object, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until further iteration of
* the object is not possible. Also known as foldLeft in functional parlance.
*
* @param self an Object
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <T, U extends T, V extends T> T inject(Object self, U initialValue, Closure<V> closure) {
Iterator iter = InvokerHelper.asIterator(self);
return (T) inject(iter, initialValue, closure);
}
/**
* Iterates through the given array as with inject(Object[],initialValue,closure), but
* using the first element of the array as the initialValue, and then iterating
* the remaining elements of the array.
*
* @param self an Object[]
* @param closure a closure
* @return the result of the last closure call
* @throws NoSuchElementException if the array is empty.
* @see #inject(Object[], Object, Closure)
* @since 1.8.7
*/
public static <E,T, V extends T> T inject(E[] self, @ClosureParams(value=FromString.class,options="E,E") Closure<V> closure) {
return inject( (Object)self, closure ) ;
}
/**
* Iterates through the given array, passing in the initial value to
* the closure along with the first item. The result is passed back (injected) into
* the closure along with the second item. The new result is injected back into
* the closure along with the third item and so on until all elements of the array
* have been used. Also known as foldLeft in functional parlance.
*
* @param self an Object[]
* @param initialValue some initial value
* @param closure a closure
* @return the result of the last closure call
* @see #inject(Collection, Object, Closure)
* @since 1.5.0
*/
public static <E, T, U extends T, V extends T> T inject(E[] self, U initialValue, @ClosureParams(value=FromString.class,options="U,E") Closure<V> closure) {
Object[] params = new Object[2];
T value = initialValue;
for (Object next : self) {
params[0] = value;
params[1] = next;
value = closure.call(params);
}
return value;
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable)
* @since 1.0
*/
@Deprecated
public static Object sum(Collection self) {
return sum((Iterable)self);
}
/**
* Sums the items in an Iterable. This is equivalent to invoking the
* "plus" method on all items in the Iterable.
* <pre class="groovyTestCase">assert 1+2+3+4 == [1,2,3,4].sum()</pre>
*
* @param self Iterable of values to add together
* @return The sum of all of the items
* @since 2.2.0
*/
public static Object sum(Iterable self) {
return sum(self, null, true);
}
/**
* Sums the items in an array. This is equivalent to invoking the
* "plus" method on all items in the array.
*
* @param self The array of values to add together
* @return The sum of all of the items
* @see #sum(java.util.Iterator)
* @since 1.7.1
*/
public static Object sum(Object[] self) {
return sum(toList(self), null, true);
}
/**
* Sums the items from an Iterator. This is equivalent to invoking the
* "plus" method on all items from the Iterator. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self an Iterator for the values to add together
* @return The sum of all of the items
* @since 1.5.5
*/
public static Object sum(Iterator<Object> self) {
return sum(toList(self), null, true);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static byte sum(byte[] self) {
return sum(self, (byte) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as short) == ([1,2,3,4] as short[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static short sum(short[] self) {
return sum(self, (short) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert 1+2+3+4 == ([1,2,3,4] as int[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static int sum(int[] self) {
return sum(self, 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as long) == ([1,2,3,4] as long[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static long sum(long[] self) {
return sum(self, 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as char) == ([1,2,3,4] as char[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static char sum(char[] self) {
return sum(self, (char) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as float) == ([1,2,3,4] as float[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static float sum(float[] self) {
return sum(self, (float) 0);
}
/**
* Sums the items in an array.
* <pre class="groovyTestCase">assert (1+2+3+4 as double) == ([1,2,3,4] as double[]).sum()</pre>
*
* @param self The array of values to add together
* @return The sum of all of the items
* @since 2.4.2
*/
public static double sum(double[] self) {
return sum(self, 0);
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Object)
* @since 1.5.0
*/
@Deprecated
public static Object sum(Collection self, Object initialValue) {
return sum(self, initialValue, false);
}
/**
* Sums the items in an Iterable, adding the result to some initial value.
* <pre class="groovyTestCase">
* assert 5+1+2+3+4 == [1,2,3,4].sum(5)
* </pre>
*
* @param self an Iterable of values to sum
* @param initialValue the items in the collection will be summed to this initial value
* @return The sum of all of the items.
* @since 2.2.0
*/
public static Object sum(Iterable self, Object initialValue) {
return sum(self, initialValue, false);
}
/**
* Sums the items in an array, adding the result to some initial value.
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 1.7.1
*/
public static Object sum(Object[] self, Object initialValue) {
return sum(toList(self), initialValue, false);
}
/**
* Sums the items from an Iterator, adding the result to some initial value. This is
* equivalent to invoking the "plus" method on all items from the Iterator. The iterator
* will become exhausted of elements after determining the sum value.
*
* @param self an Iterator for the values to add together
* @param initialValue the items in the collection will be summed to this initial value
* @return The sum of all of the items
* @since 1.5.5
*/
public static Object sum(Iterator<Object> self, Object initialValue) {
return sum(toList(self), initialValue, false);
}
private static Object sum(Iterable self, Object initialValue, boolean first) {
Object result = initialValue;
Object[] param = new Object[1];
for (Object next : self) {
param[0] = next;
if (first) {
result = param[0];
first = false;
continue;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", param);
}
return result;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as byte) == ([1,2,3,4] as byte[]).sum(5 as byte)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static byte sum(byte[] self, byte initialValue) {
byte s = initialValue;
for (byte v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as short) == ([1,2,3,4] as short[]).sum(5 as short)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static short sum(short[] self, short initialValue) {
short s = initialValue;
for (short v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert 5+1+2+3+4 == ([1,2,3,4] as int[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static int sum(int[] self, int initialValue) {
int s = initialValue;
for (int v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as long) == ([1,2,3,4] as long[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static long sum(long[] self, long initialValue) {
long s = initialValue;
for (long v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as char) == ([1,2,3,4] as char[]).sum(5 as char)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static char sum(char[] self, char initialValue) {
char s = initialValue;
for (char v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as float) == ([1,2,3,4] as float[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static float sum(float[] self, float initialValue) {
float s = initialValue;
for (float v : self) {
s += v;
}
return s;
}
/**
* Sums the items in an array, adding the result to some initial value.
* <pre class="groovyTestCase">assert (5+1+2+3+4 as double) == ([1,2,3,4] as double[]).sum(5)</pre>
*
* @param self an array of values to sum
* @param initialValue the items in the array will be summed to this initial value
* @return The sum of all of the items.
* @since 2.4.2
*/
public static double sum(double[] self, double initialValue) {
double s = initialValue;
for (double v : self) {
s += v;
}
return s;
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static Object sum(Collection self, Closure closure) {
return sum((Iterable)self, closure);
}
/**
* Sums the result of applying a closure to each item of an Iterable.
* <code>coll.sum(closure)</code> is equivalent to:
* <code>coll.collect(closure).sum()</code>.
* <pre class="groovyTestCase">assert 4+6+10+12 == [2,3,5,6].sum { it * 2 }</pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item of the Iterable.
* @since 2.2.0
*/
public static <T> Object sum(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self.iterator(), null, closure, true);
}
/**
* Sums the result of applying a closure to each item of an array.
* <code>array.sum(closure)</code> is equivalent to:
* <code>array.collect(closure).sum()</code>.
*
* @param self An array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item of the array.
* @since 1.7.1
*/
public static <T> Object sum(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return sum(new ArrayIterator<T>(self), null, closure, true);
}
/**
* Sums the result of applying a closure to each item returned from an iterator.
* <code>iter.sum(closure)</code> is equivalent to:
* <code>iter.collect(closure).sum()</code>. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self An Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The sum of the values returned by applying the closure to each
* item from the Iterator.
* @since 1.7.1
*/
public static <T> Object sum(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self, null, closure, true);
}
/**
* @deprecated Use the Iterable version of sum instead
* @see #sum(Iterable, Object, Closure)
* @since 1.5.0
*/
@Deprecated
public static Object sum(Collection self, Object initialValue, Closure closure) {
return sum((Iterable)self, initialValue, closure);
}
/**
* Sums the result of applying a closure to each item of an Iterable to some initial value.
* <code>iter.sum(initVal, closure)</code> is equivalent to:
* <code>iter.collect(closure).sum(initVal)</code>.
* <pre class="groovyTestCase">assert 50+4+6+10+12 == [2,3,5,6].sum(50) { it * 2 }</pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item of the collection.
* @since 1.5.0
*/
public static <T> Object sum(Iterable<T> self, Object initialValue, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self.iterator(), initialValue, closure, false);
}
/**
* Sums the result of applying a closure to each item of an array to some initial value.
* <code>array.sum(initVal, closure)</code> is equivalent to:
* <code>array.collect(closure).sum(initVal)</code>.
*
* @param self an array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item of the array.
* @since 1.7.1
*/
public static <T> Object sum(T[] self, Object initialValue, @ClosureParams(FirstParam.Component.class) Closure closure) {
return sum(new ArrayIterator<T>(self), initialValue, closure, false);
}
/**
* Sums the result of applying a closure to each item of an Iterator to some initial value.
* <code>iter.sum(initVal, closure)</code> is equivalent to:
* <code>iter.collect(closure).sum(initVal)</code>. The iterator will become
* exhausted of elements after determining the sum value.
*
* @param self an Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @param initialValue the closure results will be summed to this initial value
* @return The sum of the values returned by applying the closure to each
* item from the Iterator.
* @since 1.7.1
*/
public static <T> Object sum(Iterator<T> self, Object initialValue, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return sum(self, initialValue, closure, false);
}
private static <T> Object sum(Iterator<T> self, Object initialValue, Closure closure, boolean first) {
Object result = initialValue;
Object[] closureParam = new Object[1];
Object[] plusParam = new Object[1];
while (self.hasNext()) {
closureParam[0] = self.next();
plusParam[0] = closure.call(closureParam);
if (first) {
result = plusParam[0];
first = false;
continue;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", plusParam);
}
return result;
}
/**
* Averages the items in an Iterable. This is equivalent to invoking the
* "plus" method on all items in the Iterable and then dividing by the
* total count using the "div" method for the resulting sum.
* <pre class="groovyTestCase">assert 3 == [1, 2, 6].average()</pre>
*
* @param self Iterable of values to average
* @return The average of all of the items
* @since 3.0.0
*/
public static Object average(Iterable self) {
Object result = null;
long count = 0;
Object[] param = new Object[1];
for (Object next : self) {
param[0] = next;
if (count == 0) {
result = param[0];
} else {
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", param);
}
count++;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", count);
return result;
}
/**
* Averages the items in an array. This is equivalent to invoking the
* "plus" method on all items in the array and then dividing by the
* total count using the "div" method for the resulting sum.
* <pre class="groovyTestCase">assert 3 == ([1, 2, 6] as Integer[]).average()</pre>
*
* @param self The array of values to average
* @return The average of all of the items
* @see #sum(java.lang.Object[])
* @since 3.0.0
*/
public static Object average(Object[] self) {
Object result = sum(self);
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", self.length);
return result;
}
/**
* Averages the items from an Iterator. This is equivalent to invoking the
* "plus" method on all items in the array and then dividing by the
* total count using the "div" method for the resulting sum.
* The iterator will become exhausted of elements after determining the average value.
*
* @param self an Iterator for the values to average
* @return The average of all of the items
* @since 3.0.0
*/
public static Object average(Iterator<Object> self) {
return average(toList(self));
}
/**
* Calculates the average of the bytes in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as byte[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(byte[] self) {
long s = 0;
int count = 0;
for (byte v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the shorts in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as short[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(short[] self) {
long s = 0;
int count = 0;
for (short v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the ints in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as int[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(int[] self) {
long s = 0;
int count = 0;
for (int v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the longs in the array.
* <pre class="groovyTestCase">assert 5.0G == ([2,4,6,8] as long[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static BigDecimal average(long[] self) {
long s = 0;
int count = 0;
for (long v : self) {
s += v;
count++;
}
return BigDecimal.valueOf(s).divide(BigDecimal.valueOf(count));
}
/**
* Calculates the average of the floats in the array.
* <pre class="groovyTestCase">assert 5.0d == ([2,4,6,8] as float[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static double average(float[] self) {
double s = 0.0d;
int count = 0;
for (float v : self) {
s += v;
count++;
}
return s/count;
}
/**
* Calculates the average of the doubles in the array.
* <pre class="groovyTestCase">assert 5.0d == ([2,4,6,8] as double[]).average()</pre>
*
* @param self The array of values to calculate the average of
* @return The average of the items
* @since 3.0.0
*/
public static double average(double[] self) {
double s = 0.0d;
int count = 0;
for (double v : self) {
s += v;
count++;
}
return s/count;
}
/**
* Averages the result of applying a closure to each item of an Iterable.
* <code>iter.average(closure)</code> is equivalent to:
* <code>iter.collect(closure).average()</code>.
* <pre class="groovyTestCase">
* assert 20 == [1, 3].average { it * 10 }
* assert 3 == ['to', 'from'].average { it.size() }
* </pre>
*
* @param self an Iterable
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item of the Iterable.
* @since 3.0.0
*/
public static <T> Object average(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
return average(self.iterator(), closure);
}
/**
* Averages the result of applying a closure to each item of an array.
* <code>array.average(closure)</code> is equivalent to:
* <code>array.collect(closure).average()</code>.
* <pre class="groovyTestCase">
* def (nums, strings) = [[1, 3] as Integer[], ['to', 'from'] as String[]]
* assert 20 == nums.average { it * 10 }
* assert 3 == strings.average { it.size() }
* assert 3 == strings.average (String::size)
* </pre>
*
* @param self An array
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item of the array.
* @since 3.0.0
*/
public static <T> Object average(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
return average(new ArrayIterator<T>(self), closure);
}
/**
* Averages the result of applying a closure to each item returned from an iterator.
* <code>iter.average(closure)</code> is equivalent to:
* <code>iter.collect(closure).average()</code>.
* The iterator will become exhausted of elements after determining the average value.
*
* @param self An Iterator
* @param closure a single parameter closure that returns a (typically) numeric value.
* @return The average of the values returned by applying the closure to each
* item from the Iterator.
* @since 3.0.0
*/
public static <T> Object average(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
Object result = null;
long count = 0;
Object[] closureParam = new Object[1];
Object[] plusParam = new Object[1];
while (self.hasNext()) {
closureParam[0] = self.next();
plusParam[0] = closure.call(closureParam);
if (count == 0) {
result = plusParam[0];
} else {
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "plus", plusParam);
}
count++;
}
MetaClass metaClass = InvokerHelper.getMetaClass(result);
result = metaClass.invokeMethod(result, "div", count);
return result;
}
/**
* Concatenates the <code>toString()</code> representation of each
* item from the iterator, with the given String as a separator between
* each item. The iterator will become exhausted of elements after
* determining the resulting conjoined value.
*
* @param self an Iterator of items
* @param separator a String separator
* @return the joined String
* @since 1.5.5
*/
public static String join(Iterator<Object> self, String separator) {
return join((Iterable)toList(self), separator);
}
/**
* @deprecated Use the Iterable version of join instead
* @see #join(Iterable, String)
* @since 1.0
*/
@Deprecated
public static String join(Collection self, String separator) {
return join((Iterable)self, separator);
}
/**
* Concatenates the <code>toString()</code> representation of each
* item in this Iterable, with the given String as a separator between each item.
* <pre class="groovyTestCase">assert "1, 2, 3" == [1,2,3].join(", ")</pre>
*
* @param self an Iterable of objects
* @param separator a String separator
* @return the joined String
* @since 1.0
*/
public static String join(Iterable self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (Object value : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(InvokerHelper.toString(value));
}
return buffer.toString();
}
/**
* Concatenates the <code>toString()</code> representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of Object
* @param separator a String separator
* @return the joined String
* @since 1.0
*/
public static String join(Object[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (Object next : self) {
String value = InvokerHelper.toString(next);
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(value);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of boolean
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(boolean[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (boolean next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of byte
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(byte[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (byte next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of char
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(char[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (char next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of double
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(double[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (double next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of float
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(float[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (float next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of int
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(int[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (int next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of long
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(long[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (long next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* Concatenates the string representation of each
* items in this array, with the given String as a separator between each
* item.
*
* @param self an array of short
* @param separator a String separator
* @return the joined String
* @since 2.4.1
*/
public static String join(short[] self, String separator) {
StringBuilder buffer = new StringBuilder();
boolean first = true;
if (separator == null) separator = "";
for (short next : self) {
if (first) {
first = false;
} else {
buffer.append(separator);
}
buffer.append(next);
}
return buffer.toString();
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self) {
return GroovyCollections.min(self);
}
/**
* Adds min() method to Collection objects.
* <pre class="groovyTestCase">assert 2 == [4,2,5].min()</pre>
*
* @param self a Collection
* @return the minimum value
* @see groovy.util.GroovyCollections#min(java.util.Collection)
* @since 1.0
*/
public static <T> T min(Iterable<T> self) {
return GroovyCollections.min(self);
}
/**
* Adds min() method to Iterator objects. The iterator will become
* exhausted of elements after determining the minimum value.
*
* @param self an Iterator
* @return the minimum value
* @see #min(java.util.Collection)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self) {
return min((Iterable<T>)toList(self));
}
/**
* Adds min() method to Object arrays.
*
* @param self an array
* @return the minimum value
* @see #min(java.util.Collection)
* @since 1.5.5
*/
public static <T> T min(T[] self) {
return min((Iterable<T>)toList(self));
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self, Comparator<T> comparator) {
return min((Iterable<T>) self, comparator);
}
/**
* Selects the minimum value found in the Iterable using the given comparator.
* <pre class="groovyTestCase">assert "hi" == ["hello","hi","hey"].min( { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )</pre>
*
* @param self an Iterable
* @param comparator a Comparator
* @return the minimum value or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T min(Iterable<T> self, Comparator<T> comparator) {
T answer = null;
boolean first = true;
for (T value : self) {
if (first) {
first = false;
answer = value;
} else if (comparator.compare(value, answer) < 0) {
answer = value;
}
}
return answer;
}
/**
* Selects the minimum value found from the Iterator using the given comparator.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the minimum value
* @see #min(java.util.Collection, java.util.Comparator)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self, Comparator<T> comparator) {
return min((Iterable<T>)toList(self), comparator);
}
/**
* Selects the minimum value found from the Object array using the given comparator.
*
* @param self an array
* @param comparator a Comparator
* @return the minimum value
* @see #min(java.util.Collection, java.util.Comparator)
* @since 1.5.5
*/
public static <T> T min(T[] self, Comparator<T> comparator) {
return min((Iterable<T>)toList(self), comparator);
}
/**
* @deprecated Use the Iterable version of min instead
* @see #min(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> T min(Collection<T> self, Closure closure) {
return min((Iterable<T>)self, closure);
}
/**
* Selects the item in the iterable which when passed as a parameter to the supplied closure returns the
* minimum value. A null return value represents the least possible return value. If more than one item
* has the minimum value, an arbitrary choice is made between the items having the minimum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">
* assert "hi" == ["hello","hi","hey"].min { it.length() }
* </pre>
* <pre class="groovyTestCase">
* def lastDigit = { a, b {@code ->} a % 10 {@code <=>} b % 10 }
* assert [19, 55, 91].min(lastDigit) == 91
* </pre>
* <pre class="groovyTestCase">
* def pets = ['dog', 'cat', 'anaconda']
* def shortestName = pets.min{ it.size() } // one of 'dog' or 'cat'
* assert shortestName.size() == 3
* </pre>
*
* @param self an Iterable
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return an item from the Iterable having the minimum value returned by calling the supplied closure with that item as parameter or null for an empty Iterable
* @since 1.0
*/
public static <T> T min(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
int params = closure.getMaximumNumberOfParameters();
if (params != 1) {
return min(self, new ClosureComparator<T>(closure));
}
boolean first = true;
T answer = null;
Object answerValue = null;
for (T item : self) {
Object value = closure.call(item);
if (first) {
first = false;
answer = item;
answerValue = value;
} else if (ScriptBytecodeAdapter.compareLessThan(value, answerValue)) {
answer = item;
answerValue = value;
}
}
return answer;
}
/**
* Selects an entry in the map having the minimum
* calculated value as determined by the supplied closure.
* If more than one entry has the minimum value,
* an arbitrary choice is made between the entries having the minimum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def leastCommonEntry = zoo.min{ it.value }
* assert leastCommonEntry.value == 5
* def mostCommonEntry = zoo.min{ a, b {@code ->} b.value {@code <=>} a.value } // double negative!
* assert mostCommonEntry.value == 7
* </pre>
* Edge case for multiple min values:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def lastCharOfName = { e {@code ->} e.key[-1] }
* def ans = zoo.min(lastCharOfName) // some random entry
* assert lastCharOfName(ans) == 's'
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return the Map.Entry having the minimum value as determined by the closure
* @since 1.7.6
*/
public static <K, V> Map.Entry<K, V> min(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>", "Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
return min((Iterable<Map.Entry<K, V>>)self.entrySet(), closure);
}
/**
* Selects an entry in the map having the maximum
* calculated value as determined by the supplied closure.
* If more than one entry has the maximum value,
* an arbitrary choice is made between the entries having the maximum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison. An example:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def mostCommonEntry = zoo.max{ it.value }
* assert mostCommonEntry.value == 7
* def leastCommonEntry = zoo.max{ a, b {@code ->} b.value {@code <=>} a.value } // double negative!
* assert leastCommonEntry.value == 5
* </pre>
* Edge case for multiple max values:
* <pre class="groovyTestCase">
* def zoo = [monkeys:6, lions:5, tigers:7]
* def lengthOfNamePlusNumber = { e {@code ->} e.key.size() + e.value }
* def ans = zoo.max(lengthOfNamePlusNumber) // one of [monkeys:6, tigers:7]
* assert lengthOfNamePlusNumber(ans) == 13
* </pre>
*
* @param self a Map
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return the Map.Entry having the maximum value as determined by the closure
* @since 1.7.6
*/
public static <K, V> Map.Entry<K, V> max(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>", "Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
return max((Iterable<Map.Entry<K, V>>)self.entrySet(), closure);
}
/**
* Selects the minimum value found from the Iterator
* using the closure to determine the correct ordering.
* The iterator will become
* exhausted of elements after this operation.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an Iterator
* @param closure a Closure used to determine the correct ordering
* @return the minimum value
* @see #min(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T min(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return min((Iterable<T>)toList(self), closure);
}
/**
* Selects the minimum value found from the Object array
* using the closure to determine the correct ordering.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an array
* @param closure a Closure used to determine the correct ordering
* @return the minimum value
* @see #min(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T min(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return min((Iterable<T>)toList(self), closure);
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self) {
return GroovyCollections.max((Iterable<T>)self);
}
/**
* Adds max() method to Iterable objects.
* <pre class="groovyTestCase">
* assert 5 == [2,3,1,5,4].max()
* </pre>
*
* @param self an Iterable
* @return the maximum value
* @see groovy.util.GroovyCollections#max(java.lang.Iterable)
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self) {
return GroovyCollections.max(self);
}
/**
* Adds max() method to Iterator objects. The iterator will become
* exhausted of elements after determining the maximum value.
*
* @param self an Iterator
* @return the maximum value
* @see groovy.util.GroovyCollections#max(java.util.Collection)
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self) {
return max((Iterable<T>)toList(self));
}
/**
* Adds max() method to Object arrays.
*
* @param self an array
* @return the maximum value
* @see #max(java.util.Collection)
* @since 1.5.5
*/
public static <T> T max(T[] self) {
return max((Iterable<T>)toList(self));
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self, Closure closure) {
return max((Iterable<T>) self, closure);
}
/**
* Selects the item in the iterable which when passed as a parameter to the supplied closure returns the
* maximum value. A null return value represents the least possible return value, so any item for which
* the supplied closure returns null, won't be selected (unless all items return null). If more than one item
* has the maximum value, an arbitrary choice is made between the items having the maximum value.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert "hello" == ["hello","hi","hey"].max { it.length() }</pre>
* <pre class="groovyTestCase">assert "hello" == ["hello","hi","hey"].max { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
* <pre class="groovyTestCase">
* def pets = ['dog', 'elephant', 'anaconda']
* def longestName = pets.max{ it.size() } // one of 'elephant' or 'anaconda'
* assert longestName.size() == 8
* </pre>
*
* @param self an Iterable
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return an item from the Iterable having the maximum value returned by calling the supplied closure with that item as parameter or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
int params = closure.getMaximumNumberOfParameters();
if (params != 1) {
return max(self, new ClosureComparator<T>(closure));
}
boolean first = true;
T answer = null;
Object answerValue = null;
for (T item : self) {
Object value = closure.call(item);
if (first) {
first = false;
answer = item;
answerValue = value;
} else if (ScriptBytecodeAdapter.compareLessThan(answerValue, value)) {
answer = item;
answerValue = value;
}
}
return answer;
}
/**
* Selects the maximum value found from the Iterator
* using the closure to determine the correct ordering.
* The iterator will become exhausted of elements after this operation.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an Iterator
* @param closure a Closure used to determine the correct ordering
* @return the maximum value
* @see #max(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return max((Iterable<T>)toList(self), closure);
}
/**
* Selects the maximum value found from the Object array
* using the closure to determine the correct ordering.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
*
* @param self an array
* @param closure a Closure used to determine the correct ordering
* @return the maximum value
* @see #max(java.util.Collection, groovy.lang.Closure)
* @since 1.5.5
*/
public static <T> T max(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return max((Iterable<T>)toList(self), closure);
}
/**
* @deprecated Use the Iterable version of max instead
* @see #max(Iterable, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> T max(Collection<T> self, Comparator<T> comparator) {
return max((Iterable<T>)self, comparator);
}
/**
* Selects the maximum value found in the Iterable using the given comparator.
* <pre class="groovyTestCase">
* assert "hello" == ["hello","hi","hey"].max( { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )
* </pre>
*
* @param self an Iterable
* @param comparator a Comparator
* @return the maximum value or null for an empty Iterable
* @since 2.2.0
*/
public static <T> T max(Iterable<T> self, Comparator<T> comparator) {
T answer = null;
boolean first = true;
for (T value : self) {
if (first) {
first = false;
answer = value;
} else if (comparator.compare(value, answer) > 0) {
answer = value;
}
}
return answer;
}
/**
* Selects the maximum value found from the Iterator using the given comparator.
*
* @param self an Iterator
* @param comparator a Comparator
* @return the maximum value
* @since 1.5.5
*/
public static <T> T max(Iterator<T> self, Comparator<T> comparator) {
return max((Iterable<T>)toList(self), comparator);
}
/**
* Selects the maximum value found from the Object array using the given comparator.
*
* @param self an array
* @param comparator a Comparator
* @return the maximum value
* @since 1.5.5
*/
public static <T> T max(T[] self, Comparator<T> comparator) {
return max((Iterable<T>)toList(self), comparator);
}
/**
* Returns indices of the collection.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert 0..2 == [5, 6, 7].indices
* </pre>
*
* @param self a collection
* @return an index range
* @since 2.4.0
*/
public static IntRange getIndices(Collection self) {
return new IntRange(false, 0, self.size());
}
/**
* Returns indices of the array.
* <p>
* Example:
* <pre class="groovyTestCase">
* String[] letters = ['a', 'b', 'c', 'd']
* {@code assert 0..<4 == letters.indices}
* </pre>
*
* @param self an array
* @return an index range
* @since 2.4.0
*/
public static <T> IntRange getIndices(T[] self) {
return new IntRange(false, 0, self.length);
}
/**
* Provide the standard Groovy <code>size()</code> method for <code>Iterator</code>.
* The iterator will become exhausted of elements after determining the size value.
*
* @param self an Iterator
* @return the length of the Iterator
* @since 1.5.5
*/
public static int size(Iterator self) {
int count = 0;
while (self.hasNext()) {
self.next();
count++;
}
return count;
}
/**
* Provide the standard Groovy <code>size()</code> method for <code>Iterable</code>.
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def iterable = { [ hasNext:{ !items.isEmpty() }, next:{ items.pop() } ] as Iterator } as Iterable
* assert iterable.size() == 3
* </pre>
*
* @param self an Iterable
* @return the length of the Iterable
* @since 2.3.8
*/
public static int size(Iterable self) {
return size(self.iterator());
}
/**
* Provide the standard Groovy <code>size()</code> method for an array.
*
* @param self an Array of objects
* @return the size (length) of the Array
* @since 1.0
*/
public static int size(Object[] self) {
return self.length;
}
/**
* Check whether an <code>Iterable</code> has elements
* <pre class="groovyTestCase">
* def items = [1]
* def iterable = { [ hasNext:{ !items.isEmpty() }, next:{ items.pop() } ] as Iterator } as Iterable
* assert !iterable.isEmpty()
* iterable.iterator().next()
* assert iterable.isEmpty()
* </pre>
*
* @param self an Iterable
* @return true if the iterable has no elements, false otherwise
* @since 2.5.0
*/
public static boolean isEmpty(Iterable self) {
return !self.iterator().hasNext();
}
/**
* Support the range subscript operator for a List.
* <pre class="groovyTestCase">def list = [1, "a", 4.5, true]
* assert list[1..2] == ["a", 4.5]</pre>
*
* @param self a List
* @param range a Range indicating the items to get
* @return a new list instance based on range borders
*
* @since 1.0
*/
public static <T> List<T> getAt(List<T> self, Range range) {
RangeInfo info = subListBorders(self.size(), range);
List<T> subList = self.subList(info.from, info.to);
if (info.reverse) {
subList = reverse(subList);
}
// trying to guess the concrete list type and create a new instance from it
List<T> answer = createSimilarList(self, subList.size());
answer.addAll(subList);
return answer;
}
/**
* Select a List of items from an eager or lazy List using a Collection to
* identify the indices to be selected.
* <pre class="groovyTestCase">def list = [].withDefault { 42 }
* assert list[1,0,2] == [42, 42, 42]</pre>
*
* @param self a ListWithDefault
* @param indices a Collection of indices
*
* @return a new eager or lazy list of the values at the given indices
*/
@SuppressWarnings("unchecked")
public static <T> List<T> getAt(ListWithDefault<T> self, Collection indices) {
List<T> answer = ListWithDefault.newInstance(new ArrayList<T>(indices.size()), self.isLazyDefaultValues(), self.getInitClosure());
for (Object value : indices) {
if (value instanceof Collection) {
answer.addAll((List<T>) InvokerHelper.invokeMethod(self, "getAt", value));
} else {
int idx = normaliseIndex(DefaultTypeTransformation.intUnbox(value), self.size());
answer.add(self.getAt(idx));
}
}
return answer;
}
/**
* Support the range subscript operator for an eager or lazy List.
* <pre class="groovyTestCase">def list = [].withDefault { 42 }
* assert list[1..2] == [null, 42]</pre>
*
* @param self a ListWithDefault
* @param range a Range indicating the items to get
*
* @return a new eager or lazy list instance based on range borders
*/
public static <T> List<T> getAt(ListWithDefault<T> self, Range range) {
RangeInfo info = subListBorders(self.size(), range);
// if a positive index is accessed not initialized so far
// initialization up to that index takes place
if (self.size() < info.to) {
self.get(info.to - 1);
}
List<T> answer = self.subList(info.from, info.to);
if (info.reverse) {
answer = ListWithDefault.newInstance(reverse(answer), self.isLazyDefaultValues(), self.getInitClosure());
} else {
// instead of using the SubList backed by the parent list, a new ArrayList instance is used
answer = ListWithDefault.newInstance(new ArrayList<T>(answer), self.isLazyDefaultValues(), self.getInitClosure());
}
return answer;
}
/**
* Support the range subscript operator for an eager or lazy List.
* <pre class="groovyTestCase">
* def list = [true, 1, 3.4].withDefault{ 42 }
* {@code assert list[0..<0] == []}
* </pre>
*
* @param self a ListWithDefault
* @param range a Range indicating the items to get
*
* @return a new list instance based on range borders
*
*/
public static <T> List<T> getAt(ListWithDefault<T> self, EmptyRange range) {
return ListWithDefault.newInstance(new ArrayList<T>(), self.isLazyDefaultValues(), self.getInitClosure());
}
/**
* Support the range subscript operator for a List.
* <pre class="groovyTestCase">
* def list = [true, 1, 3.4]
* {@code assert list[0..<0] == []}
* </pre>
*
* @param self a List
* @param range a Range indicating the items to get
* @return a new list instance based on range borders
*
* @since 1.0
*/
public static <T> List<T> getAt(List<T> self, EmptyRange range) {
return createSimilarList(self, 0);
}
/**
* Select a List of items from a List using a Collection to
* identify the indices to be selected.
* <pre class="groovyTestCase">def list = [true, 1, 3.4, false]
* assert list[1,0,2] == [1, true, 3.4]</pre>
*
* @param self a List
* @param indices a Collection of indices
* @return a new list of the values at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> List<T> getAt(List<T> self, Collection indices) {
List<T> answer = new ArrayList<T>(indices.size());
for (Object value : indices) {
if (value instanceof Collection) {
answer.addAll((List<T>)InvokerHelper.invokeMethod(self, "getAt", value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(getAt(self, idx));
}
}
return answer;
}
/**
* Select a List of items from an array using a Collection to
* identify the indices to be selected.
*
* @param self an array
* @param indices a Collection of indices
* @return a new list of the values at the given indices
* @since 1.0
*/
public static <T> List<T> getAt(T[] self, Collection indices) {
List<T> answer = new ArrayList<T>(indices.size());
for (Object value : indices) {
if (value instanceof Range) {
answer.addAll(getAt(self, (Range) value));
} else if (value instanceof Collection) {
answer.addAll(getAt(self, (Collection) value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(getAtImpl(self, idx));
}
}
return answer;
}
/**
* Creates a sub-Map containing the given keys. This method is similar to
* List.subList() but uses keys rather than index ranges.
* <pre class="groovyTestCase">assert [1:10, 2:20, 4:40].subMap( [2, 4] ) == [2:20, 4:40]</pre>
*
* @param map a Map
* @param keys a Collection of keys
* @return a new Map containing the given keys
* @since 1.0
*/
public static <K, V> Map<K, V> subMap(Map<K, V> map, Collection<K> keys) {
Map<K, V> answer = new LinkedHashMap<K, V>(keys.size());
for (K key : keys) {
if (map.containsKey(key)) {
answer.put(key, map.get(key));
}
}
return answer;
}
/**
* Creates a sub-Map containing the given keys. This method is similar to
* List.subList() but uses keys rather than index ranges. The original
* map is unaltered.
* <pre class="groovyTestCase">
* def orig = [1:10, 2:20, 3:30, 4:40]
* assert orig.subMap([1, 3] as int[]) == [1:10, 3:30]
* assert orig.subMap([2, 4] as Integer[]) == [2:20, 4:40]
* assert orig.size() == 4
* </pre>
*
* @param map a Map
* @param keys an array of keys
* @return a new Map containing the given keys
* @since 2.1.0
*/
public static <K, V> Map<K, V> subMap(Map<K, V> map, K[] keys) {
Map<K, V> answer = new LinkedHashMap<K, V>(keys.length);
for (K key : keys) {
if (map.containsKey(key)) {
answer.put(key, map.get(key));
}
}
return answer;
}
/**
* Looks up an item in a Map for the given key and returns the value - unless
* there is no entry for the given key in which case add the default value
* to the map and return that.
* <pre class="groovyTestCase">def map=[:]
* map.get("a", []) << 5
* assert map == [a:[5]]</pre>
*
* @param map a Map
* @param key the key to lookup the value of
* @param defaultValue the value to return and add to the map for this key if
* there is no entry for the given key
* @return the value of the given key or the default value, added to the map if the
* key did not exist
* @since 1.0
*/
public static <K, V> V get(Map<K, V> map, K key, V defaultValue) {
if (!map.containsKey(key)) {
map.put(key, defaultValue);
}
return map.get(key);
}
/**
* Support the range subscript operator for an Array
*
* @param array an Array of Objects
* @param range a Range
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, Range range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
/**
*
* @param array an Array of Objects
* @param range an IntRange
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, IntRange range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
/**
*
* @param array an Array of Objects
* @param range an EmptyRange
* @return an empty Range
* @since 1.5.0
*/
public static <T> List<T> getAt(T[] array, EmptyRange range) {
return new ArrayList<T>();
}
/**
*
* @param array an Array of Objects
* @param range an ObjectRange
* @return a range of a list from the range's from index up to but not
* including the range's to value
* @since 1.0
*/
public static <T> List<T> getAt(T[] array, ObjectRange range) {
List<T> list = Arrays.asList(array);
return getAt(list, range);
}
private static <T> T getAtImpl(T[] array, int idx) {
return array[normaliseIndex(idx, array.length)];
}
/**
* Allows conversion of arrays into a mutable List.
*
* @param array an Array of Objects
* @return the array as a List
* @since 1.0
*/
public static <T> List<T> toList(T[] array) {
return new ArrayList<T>(Arrays.asList(array));
}
/**
* Support the subscript operator for a List.
* <pre class="groovyTestCase">def list = [2, "a", 5.3]
* assert list[1] == "a"</pre>
*
* @param self a List
* @param idx an index
* @return the value at the given index
* @since 1.0
*/
public static <T> T getAt(List<T> self, int idx) {
int size = self.size();
int i = normaliseIndex(idx, size);
if (i < size) {
return self.get(i);
} else {
return null;
}
}
/**
* Support subscript operator for list access.
*/
public static <T> T getAt(List<T> self, Number idx) {
return getAt(self, idx.intValue());
}
/**
* Support the subscript operator for an Iterator. The iterator
* will be partially exhausted up until the idx entry after returning
* if a +ve or 0 idx is used, or fully exhausted if a -ve idx is used
* or no corresponding entry was found. Typical usage:
* <pre class="groovyTestCase">
* def iter = [2, "a", 5.3].iterator()
* assert iter[1] == "a"
* </pre>
* A more elaborate example:
* <pre class="groovyTestCase">
* def items = [2, "a", 5.3]
* def iter = items.iterator()
* assert iter[-1] == 5.3
* // iter exhausted, so reset
* iter = items.iterator()
* assert iter[1] == "a"
* // iter partially exhausted so now idx starts after "a"
* assert iter[0] == 5.3
* </pre>
*
* @param self an Iterator
* @param idx an index value (-self.size() <= idx < self.size())
* @return the value at the given index (after normalisation) or null if no corresponding value was found
* @since 1.7.2
*/
public static <T> T getAt(Iterator<T> self, int idx) {
if (idx < 0) {
// calculate whole list in this case
// recommend avoiding -ve's as this is not as efficient
List<T> list = toList(self);
int adjustedIndex = idx + list.size();
if (adjustedIndex < 0 || adjustedIndex >= list.size()) return null;
return list.get(adjustedIndex);
}
int count = 0;
while (self.hasNext()) {
if (count == idx) {
return self.next();
} else {
count++;
self.next();
}
}
return null;
}
/**
* Support the subscript operator for an Iterable. Typical usage:
* <pre class="groovyTestCase">
* // custom Iterable example:
* class MyIterable implements Iterable {
* Iterator iterator() { [1, 2, 3].iterator() }
* }
* def myIterable = new MyIterable()
* assert myIterable[1] == 2
*
* // Set example:
* def set = [1,2,3] as LinkedHashSet
* assert set[1] == 2
* </pre>
*
* @param self an Iterable
* @param idx an index value (-self.size() <= idx < self.size()) but using -ve index values will be inefficient
* @return the value at the given index (after normalisation) or null if no corresponding value was found
* @since 2.1.0
*/
public static <T> T getAt(Iterable<T> self, int idx) {
return getAt(self.iterator(), idx);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = [2, 3]
* list[0] = 1
* assert list == [1, 3]</pre>
*
* @param self a List
* @param idx an index
* @param value the value to put at the given index
* @since 1.0
*/
public static <T> void putAt(List<T> self, int idx, T value) {
int size = self.size();
idx = normaliseIndex(idx, size);
if (idx < size) {
self.set(idx, value);
} else {
while (size < idx) {
self.add(size++, null);
}
self.add(idx, value);
}
}
/**
* Support subscript operator for list modification.
*/
public static <T> void putAt(List<T> self, Number idx, T value) {
putAt(self, idx.intValue(), value);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">
* def list = ["a", true]
* {@code list[1..<1] = 5}
* assert list == ["a", 5, true]
* </pre>
*
* @param self a List
* @param range the (in this case empty) subset of the list to set
* @param value the values to put at the given sublist or a Collection of values
* @since 1.0
*/
public static void putAt(List self, EmptyRange range, Object value) {
RangeInfo info = subListBorders(self.size(), range);
List sublist = self.subList(info.from, info.to);
sublist.clear();
if (value instanceof Collection) {
Collection col = (Collection) value;
if (col.isEmpty()) return;
sublist.addAll(col);
} else {
sublist.add(value);
}
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">
* def list = ["a", true]
* {@code list[1..<1] = [4, 3, 2]}
* assert list == ["a", 4, 3, 2, true]
* </pre>
*
* @param self a List
* @param range the (in this case empty) subset of the list to set
* @param value the Collection of values
* @since 1.0
* @see #putAt(java.util.List, groovy.lang.EmptyRange, java.lang.Object)
*/
public static void putAt(List self, EmptyRange range, Collection value) {
putAt(self, range, (Object)value);
}
private static <T> List<T> resizeListWithRangeAndGetSublist(List<T> self, IntRange range) {
RangeInfo info = subListBorders(self.size(), range);
int size = self.size();
if (info.to >= size) {
while (size < info.to) {
self.add(size++, null);
}
}
List<T> sublist = self.subList(info.from, info.to);
sublist.clear();
return sublist;
}
/**
* List subscript assignment operator when given a range as the index and
* the assignment operand is a collection.
* Example: <pre class="groovyTestCase">def myList = [4, 3, 5, 1, 2, 8, 10]
* myList[3..5] = ["a", true]
* assert myList == [4, 3, 5, "a", true, 10]</pre>
*
* Items in the given
* range are replaced with items from the collection.
*
* @param self a List
* @param range the subset of the list to set
* @param col the collection of values to put at the given sublist
* @since 1.5.0
*/
public static void putAt(List self, IntRange range, Collection col) {
List sublist = resizeListWithRangeAndGetSublist(self, range);
if (col.isEmpty()) return;
sublist.addAll(col);
}
/**
* List subscript assignment operator when given a range as the index.
* Example: <pre class="groovyTestCase">def myList = [4, 3, 5, 1, 2, 8, 10]
* myList[3..5] = "b"
* assert myList == [4, 3, 5, "b", 10]</pre>
*
* Items in the given
* range are replaced with the operand. The <code>value</code> operand is
* always treated as a single value.
*
* @param self a List
* @param range the subset of the list to set
* @param value the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, IntRange range, Object value) {
List sublist = resizeListWithRangeAndGetSublist(self, range);
sublist.add(value);
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = ["a", true, 42, 9.4]
* list[1, 4] = ["x", false]
* assert list == ["a", "x", 42, 9.4, false]</pre>
*
* @param self a List
* @param splice the subset of the list to set
* @param values the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, List splice, List values) {
if (splice.isEmpty()) {
if ( ! values.isEmpty() )
throw new IllegalArgumentException("Trying to replace 0 elements with "+values.size()+" elements");
return;
}
Object first = splice.iterator().next();
if (first instanceof Integer) {
if (values.size() != splice.size())
throw new IllegalArgumentException("Trying to replace "+splice.size()+" elements with "+values.size()+" elements");
Iterator<?> valuesIter = values.iterator();
for (Object index : splice) {
putAt(self, (Integer) index, valuesIter.next());
}
} else {
throw new IllegalArgumentException("Can only index a List with another List of Integers, not a List of "+first.getClass().getName());
}
}
/**
* A helper method to allow lists to work with subscript operators.
* <pre class="groovyTestCase">def list = ["a", true, 42, 9.4]
* list[1, 3] = 5
* assert list == ["a", 5, 42, 5]</pre>
*
* @param self a List
* @param splice the subset of the list to set
* @param value the value to put at the given sublist
* @since 1.0
*/
public static void putAt(List self, List splice, Object value) {
if (splice.isEmpty()) {
return;
}
Object first = splice.get(0);
if (first instanceof Integer) {
for (Object index : splice) {
self.set((Integer) index, value);
}
} else {
throw new IllegalArgumentException("Can only index a List with another List of Integers, not a List of "+first.getClass().getName());
}
}
// todo: remove after putAt(Splice) gets deleted
@Deprecated
protected static List getSubList(List self, List splice) {
int left /* = 0 */;
int right = 0;
boolean emptyRange = false;
if (splice.size() == 2) {
left = DefaultTypeTransformation.intUnbox(splice.get(0));
right = DefaultTypeTransformation.intUnbox(splice.get(1));
} else if (splice instanceof IntRange) {
IntRange range = (IntRange) splice;
left = range.getFrom();
right = range.getTo();
} else if (splice instanceof EmptyRange) {
RangeInfo info = subListBorders(self.size(), (EmptyRange) splice);
left = info.from;
emptyRange = true;
} else {
throw new IllegalArgumentException("You must specify a list of 2 indexes to create a sub-list");
}
int size = self.size();
left = normaliseIndex(left, size);
right = normaliseIndex(right, size);
List sublist /* = null */;
if (!emptyRange) {
sublist = self.subList(left, right + 1);
} else {
sublist = self.subList(left, left);
}
return sublist;
}
/**
* Support the subscript operator for a Map.
* <pre class="groovyTestCase">def map = [a:10]
* assert map["a"] == 10</pre>
*
* @param self a Map
* @param key an Object as a key for the map
* @return the value corresponding to the given key
* @since 1.0
*/
public static <K,V> V getAt(Map<K,V> self, Object key) {
return self.get(key);
}
/**
* Returns a new <code>Map</code> containing all entries from <code>left</code> and <code>right</code>,
* giving precedence to <code>right</code>. Any keys appearing in both Maps
* will appear in the resultant map with values from the <code>right</code>
* operand. If the <code>left</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
* <p>
* Roughly equivalent to <code>Map m = new HashMap(); m.putAll(left); m.putAll(right); return m;</code>
* but with some additional logic to preserve the <code>left</code> Map type for common cases as
* described above.
* <pre class="groovyTestCase">
* assert [a:10, b:20] + [a:5, c:7] == [a:5, b:20, c:7]
* </pre>
*
* @param left a Map
* @param right a Map
* @return a new Map containing all entries from left and right
* @since 1.5.0
*/
public static <K, V> Map<K, V> plus(Map<K, V> left, Map<K, V> right) {
Map<K, V> map = cloneSimilarMap(left);
map.putAll(right);
return map;
}
/**
* A helper method to allow maps to work with subscript operators
*
* @param self a Map
* @param key an Object as a key for the map
* @param value the value to put into the map
* @return the value corresponding to the given key
* @since 1.0
*/
public static <K,V> V putAt(Map<K,V> self, K key, V value) {
self.put(key, value);
return value;
}
/**
* Support the subscript operator for Collection.
* <pre class="groovyTestCase">
* assert [String, Long, Integer] == ["a",5L,2]["class"]
* </pre>
*
* @param coll a Collection
* @param property a String
* @return a List
* @since 1.0
*/
public static List getAt(Collection coll, String property) {
List<Object> answer = new ArrayList<Object>(coll.size());
return getAtIterable(coll, property, answer);
}
private static List getAtIterable(Iterable coll, String property, List<Object> answer) {
for (Object item : coll) {
if (item == null) continue;
Object value;
try {
value = InvokerHelper.getProperty(item, property);
} catch (MissingPropertyExceptionNoStack mpe) {
String causeString = new MissingPropertyException(mpe.getProperty(), mpe.getType()).toString();
throw new MissingPropertyException("Exception evaluating property '" + property +
"' for " + coll.getClass().getName() + ", Reason: " + causeString);
}
answer.add(value);
}
return answer;
}
/**
* A convenience method for creating an immutable Map.
*
* @param self a Map
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Map)
* @since 1.0
*/
public static <K, V> Map<K, V> asImmutable(Map<K, V> self) {
return asUnmodifiable(new LinkedHashMap<K, V>(self));
}
/**
* A convenience method for creating an immutable SortedMap.
*
* @param self a SortedMap
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.SortedMap)
* @since 1.0
*/
public static <K, V> SortedMap<K, V> asImmutable(SortedMap<K, V> self) {
return asUnmodifiable(new TreeMap<K, V>(self));
}
/**
* A convenience method for creating an immutable List.
* <pre class="groovyTestCase">
* def mutable = [1,2,3]
* def immutable = mutable.asImmutable()
* try {
* immutable << 4
* assert false
* } catch (UnsupportedOperationException) {
* assert true
* }
* mutable << 4
* assert mutable.size() == 4
* assert immutable.size() == 3
* </pre>
*
* @param self a List
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asUnmodifiable(java.util.List)
* @since 1.0
*/
public static <T> List<T> asImmutable(List<T> self) {
return asUnmodifiable(new ArrayList<T>(self));
}
/**
* A convenience method for creating an immutable Set.
*
* @param self a Set
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Set)
* @since 1.0
*/
public static <T> Set<T> asImmutable(Set<T> self) {
return asUnmodifiable(new LinkedHashSet<T>(self));
}
/**
* A convenience method for creating an immutable SortedSet.
*
* @param self a SortedSet
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.SortedSet)
* @since 1.0
*/
public static <T> SortedSet<T> asImmutable(SortedSet<T> self) {
return asUnmodifiable(new TreeSet<T>(self));
}
/**
* A convenience method for creating an immutable Collection.
*
* @param self a Collection
* @return an unmodifiable view of a copy of the original, i.e. an effectively immutable copy
* @see #asImmutable(java.util.List)
* @see #asUnmodifiable(java.util.Collection)
* @since 1.5.0
*/
public static <T> Collection<T> asImmutable(Collection<T> self) {
return asUnmodifiable((Collection<T>) new ArrayList<T>(self));
}
/**
* Creates an unmodifiable view of a Map.
*
* @param self a Map
* @return an unmodifiable view of the Map
* @see java.util.Collections#unmodifiableMap(java.util.Map)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <K, V> Map<K, V> asUnmodifiable(Map<K, V> self) {
return Collections.unmodifiableMap(self);
}
/**
* Creates an unmodifiable view of a SortedMap.
*
* @param self a SortedMap
* @return an unmodifiable view of the SortedMap
* @see java.util.Collections#unmodifiableSortedMap(java.util.SortedMap)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <K, V> SortedMap<K, V> asUnmodifiable(SortedMap<K, V> self) {
return Collections.unmodifiableSortedMap(self);
}
/**
* Creates an unmodifiable view of a List.
* <pre class="groovyTestCase">
* def mutable = [1,2,3]
* def unmodifiable = mutable.asUnmodifiable()
* try {
* unmodifiable << 4
* assert false
* } catch (UnsupportedOperationException) {
* assert true
* }
* mutable << 4
* assert unmodifiable.size() == 4
* </pre>
*
* @param self a List
* @return an unmodifiable view of the List
* @see java.util.Collections#unmodifiableList(java.util.List)
* @since 2.5.0
*/
public static <T> List<T> asUnmodifiable(List<T> self) {
return Collections.unmodifiableList(self);
}
/**
* Creates an unmodifiable view of a Set.
*
* @param self a Set
* @return an unmodifiable view of the Set
* @see java.util.Collections#unmodifiableSet(java.util.Set)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> Set<T> asUnmodifiable(Set<T> self) {
return Collections.unmodifiableSet(self);
}
/**
* Creates an unmodifiable view of a SortedSet.
*
* @param self a SortedSet
* @return an unmodifiable view of the SortedSet
* @see java.util.Collections#unmodifiableSortedSet(java.util.SortedSet)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> SortedSet<T> asUnmodifiable(SortedSet<T> self) {
return Collections.unmodifiableSortedSet(self);
}
/**
* Creates an unmodifiable view of a Collection.
*
* @param self a Collection
* @return an unmodifiable view of the Collection
* @see java.util.Collections#unmodifiableCollection(java.util.Collection)
* @see #asUnmodifiable(java.util.List)
* @since 2.5.0
*/
public static <T> Collection<T> asUnmodifiable(Collection<T> self) {
return Collections.unmodifiableCollection(self);
}
/**
* A convenience method for creating a synchronized Map.
*
* @param self a Map
* @return a synchronized Map
* @see java.util.Collections#synchronizedMap(java.util.Map)
* @since 1.0
*/
public static <K,V> Map<K,V> asSynchronized(Map<K,V> self) {
return Collections.synchronizedMap(self);
}
/**
* A convenience method for creating a synchronized SortedMap.
*
* @param self a SortedMap
* @return a synchronized SortedMap
* @see java.util.Collections#synchronizedSortedMap(java.util.SortedMap)
* @since 1.0
*/
public static <K,V> SortedMap<K,V> asSynchronized(SortedMap<K,V> self) {
return Collections.synchronizedSortedMap(self);
}
/**
* A convenience method for creating a synchronized Collection.
*
* @param self a Collection
* @return a synchronized Collection
* @see java.util.Collections#synchronizedCollection(java.util.Collection)
* @since 1.0
*/
public static <T> Collection<T> asSynchronized(Collection<T> self) {
return Collections.synchronizedCollection(self);
}
/**
* A convenience method for creating a synchronized List.
*
* @param self a List
* @return a synchronized List
* @see java.util.Collections#synchronizedList(java.util.List)
* @since 1.0
*/
public static <T> List<T> asSynchronized(List<T> self) {
return Collections.synchronizedList(self);
}
/**
* A convenience method for creating a synchronized Set.
*
* @param self a Set
* @return a synchronized Set
* @see java.util.Collections#synchronizedSet(java.util.Set)
* @since 1.0
*/
public static <T> Set<T> asSynchronized(Set<T> self) {
return Collections.synchronizedSet(self);
}
/**
* A convenience method for creating a synchronized SortedSet.
*
* @param self a SortedSet
* @return a synchronized SortedSet
* @see java.util.Collections#synchronizedSortedSet(java.util.SortedSet)
* @since 1.0
*/
public static <T> SortedSet<T> asSynchronized(SortedSet<T> self) {
return Collections.synchronizedSortedSet(self);
}
/**
* Synonym for {@link #toSpreadMap(java.util.Map)}.
* @param self a map
* @return a newly created SpreadMap
* @since 1.0
*/
public static SpreadMap spread(Map self) {
return toSpreadMap(self);
}
/**
* Returns a new <code>SpreadMap</code> from this map.
* <p>
* The example below shows the various possible use cases:
* <pre class="groovyTestCase">
* def fn(Map m) { return m.a + m.b + m.c + m.d }
*
* assert fn(a:1, b:2, c:3, d:4) == 10
* assert fn(a:1, *:[b:2, c:3], d:4) == 10
* assert fn([a:1, b:2, c:3, d:4].toSpreadMap()) == 10
* assert fn((['a', 1, 'b', 2, 'c', 3, 'd', 4] as Object[]).toSpreadMap()) == 10
* assert fn(['a', 1, 'b', 2, 'c', 3, 'd', 4].toSpreadMap()) == 10
* assert fn(['abcd'.toList(), 1..4].transpose().flatten().toSpreadMap()) == 10
* </pre>
* Note that toSpreadMap() is not normally used explicitly but under the covers by Groovy.
*
* @param self a map to be converted into a SpreadMap
* @return a newly created SpreadMap if this map is not null and its size is positive.
* @see groovy.lang.SpreadMap#SpreadMap(java.util.Map)
* @since 1.0
*/
public static SpreadMap toSpreadMap(Map self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Map to SpreadMap, because it is null.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this array.
* <p>
* @param self an object array
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.lang.Object[])
* @see #toSpreadMap(java.util.Map)
* @since 1.0
*/
public static SpreadMap toSpreadMap(Object[] self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Object[] to SpreadMap, because it is null.");
else if (self.length % 2 != 0)
throw new GroovyRuntimeException("Fail to convert Object[] to SpreadMap, because it's size is not even.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this list.
* <p>
* @param self a list
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.util.List)
* @see #toSpreadMap(java.util.Map)
* @since 1.8.0
*/
public static SpreadMap toSpreadMap(List self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert List to SpreadMap, because it is null.");
else if (self.size() % 2 != 0)
throw new GroovyRuntimeException("Fail to convert List to SpreadMap, because it's size is not even.");
else
return new SpreadMap(self);
}
/**
* Creates a spreadable map from this iterable.
* <p>
* @param self an iterable
* @return a newly created SpreadMap
* @see groovy.lang.SpreadMap#SpreadMap(java.util.List)
* @see #toSpreadMap(java.util.Map)
* @since 2.4.0
*/
public static SpreadMap toSpreadMap(Iterable self) {
if (self == null)
throw new GroovyRuntimeException("Fail to convert Iterable to SpreadMap, because it is null.");
else
return toSpreadMap(asList(self));
}
/**
* Wraps a map using the decorator pattern with a wrapper that intercepts all calls
* to <code>get(key)</code>. If an unknown key is found, a default value will be
* stored into the Map before being returned. The default value stored will be the
* result of calling the supplied Closure with the key as the parameter to the Closure.
* Example usage:
* <pre class="groovyTestCase">
* def map = [a:1, b:2].withDefault{ k {@code ->} k.toCharacter().isLowerCase() ? 10 : -10 }
* def expected = [a:1, b:2, c:10, D:-10]
* assert expected.every{ e {@code ->} e.value == map[e.key] }
*
* def constMap = [:].withDefault{ 42 }
* assert constMap.foo == 42
* assert constMap.size() == 1
* </pre>
*
* @param self a Map
* @param init a Closure which is passed the unknown key
* @return the wrapped Map
* @since 1.7.1
*/
public static <K, V> Map<K, V> withDefault(Map<K, V> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<V> init) {
return MapWithDefault.newInstance(self, init);
}
/**
* An alias for <code>withLazyDefault</code> which decorates a list allowing
* it to grow when called with index values outside the normal list bounds.
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the decorated List
* @see #withLazyDefault(java.util.List, groovy.lang.Closure)
* @see #withEagerDefault(java.util.List, groovy.lang.Closure)
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withDefault(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return withLazyDefault(self, init);
}
@Deprecated
public static <T> List<T> withDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return withDefault(self, init);
}
/**
* Decorates a list allowing it to grow when called with a non-existent index value.
* When called with such values, the list is grown in size and a default value
* is placed in the list by calling a supplied <code>init</code> Closure. Subsequent
* retrieval operations if finding a null value in the list assume it was set
* as null from an earlier growing operation and again call the <code>init</code> Closure
* to populate the retrieved value; consequently the list can't be used to store null values.
* <p>
* How it works: The decorated list intercepts all calls
* to <code>getAt(index)</code> and <code>get(index)</code>. If an index greater than
* or equal to the current <code>size()</code> is used, the list will grow automatically
* up to the specified index. Gaps will be filled by {@code null}. If a default value
* should also be used to fill gaps instead of {@code null}, use <code>withEagerDefault</code>.
* If <code>getAt(index)</code> or <code>get(index)</code> are called and a null value
* is found, it is assumed that the null value was a consequence of an earlier grow list
* operation and the <code>init</code> Closure is called to populate the value.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def list = [0, 1].withLazyDefault{ 42 }
* assert list[0] == 0
* assert list[1] == 1
* assert list[3] == 42 // default value
* assert list == [0, 1, null, 42] // gap filled with null
*
* // illustrate using the index when generating default values
* def list2 = [5].withLazyDefault{ index {@code ->} index * index }
* assert list2[3] == 9
* assert list2 == [5, null, null, 9]
* assert list2[2] == 4
* assert list2 == [5, null, 4, 9]
*
* // illustrate what happens with null values
* list2[2] = null
* assert list2[2] == 4
* </pre>
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the decorated List
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withLazyDefault(List<T> self, @ClosureParams(value=SimpleType.class, options="int") Closure<T> init) {
return ListWithDefault.newInstance(self, true, init);
}
@Deprecated
public static <T> List<T> withLazyDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return ListWithDefault.newInstance(self, true, init);
}
/**
* Decorates a list allowing it to grow when called with a non-existent index value.
* When called with such values, the list is grown in size and a default value
* is placed in the list by calling a supplied <code>init</code> Closure. Null values
* can be stored in the list.
* <p>
* How it works: The decorated list intercepts all calls
* to <code>getAt(index)</code> and <code>get(index)</code>. If an index greater than
* or equal to the current <code>size()</code> is used, the list will grow automatically
* up to the specified index. Gaps will be filled by calling the <code>init</code> Closure.
* If generating a default value is a costly operation consider using <code>withLazyDefault</code>.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def list = [0, 1].withEagerDefault{ 42 }
* assert list[0] == 0
* assert list[1] == 1
* assert list[3] == 42 // default value
* assert list == [0, 1, 42, 42] // gap filled with default value
*
* // illustrate using the index when generating default values
* def list2 = [5].withEagerDefault{ index {@code ->} index * index }
* assert list2[3] == 9
* assert list2 == [5, 1, 4, 9]
*
* // illustrate what happens with null values
* list2[2] = null
* assert list2[2] == null
* assert list2 == [5, 1, null, 9]
* </pre>
*
* @param self a List
* @param init a Closure with the target index as parameter which generates the default value
* @return the wrapped List
* @since 1.8.7
*/
public static <T> ListWithDefault<T> withEagerDefault(List<T> self, @ClosureParams(value=SimpleType.class, options="int") Closure<T> init) {
return ListWithDefault.newInstance(self, false, init);
}
@Deprecated
public static <T> List<T> withEagerDefault$$bridge(List<T> self, @ClosureParams(value=SimpleType.class, options = "int") Closure<T> init) {
return ListWithDefault.newInstance(self, false, init);
}
/**
* Zips an Iterable with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 0], ["b", 1]] == ["a", "b"].withIndex()
* assert ["0: a", "1: b"] == ["a", "b"].withIndex().collect { str, idx {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @return a zipped list with indices
* @see #indexed(Iterable)
* @since 2.4.0
*/
public static <E> List<Tuple2<E, Integer>> withIndex(Iterable<E> self) {
return withIndex(self, 0);
}
/**
* Zips an Iterable with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [0: "a", 1: "b"] == ["a", "b"].indexed()
* assert ["0: a", "1: b"] == ["a", "b"].indexed().collect { idx, str {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @return a zipped map with indices
* @see #withIndex(Iterable)
* @since 2.4.0
*/
public static <E> Map<Integer, E> indexed(Iterable<E> self) {
return indexed(self, 0);
}
/**
* Zips an Iterable with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 5], ["b", 6]] == ["a", "b"].withIndex(5)
* assert ["1: a", "2: b"] == ["a", "b"].withIndex(1).collect { str, idx {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @param offset an index to start from
* @return a zipped list with indices
* @see #indexed(Iterable, int)
* @since 2.4.0
*/
public static <E> List<Tuple2<E, Integer>> withIndex(Iterable<E> self, int offset) {
return toList(withIndex(self.iterator(), offset));
}
/**
* Zips an Iterable with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [5: "a", 6: "b"] == ["a", "b"].indexed(5)
* assert ["1: a", "2: b"] == ["a", "b"].indexed(1).collect { idx, str {@code ->} "$idx: $str" }
* </pre>
*
* @param self an Iterable
* @param offset an index to start from
* @return a Map (since the keys/indices are unique) containing the elements from the iterable zipped with indices
* @see #withIndex(Iterable, int)
* @since 2.4.0
*/
public static <E> Map<Integer, E> indexed(Iterable<E> self, int offset) {
Map<Integer, E> result = new LinkedHashMap<Integer, E>();
Iterator<Tuple2<Integer, E>> indexed = indexed(self.iterator(), offset);
while (indexed.hasNext()) {
Tuple2<Integer, E> next = indexed.next();
result.put(next.getV1(), next.getV2());
}
return result;
}
/**
* Zips an iterator with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 0], ["b", 1]] == ["a", "b"].iterator().withIndex().toList()
* assert ["0: a", "1: b"] == ["a", "b"].iterator().withIndex().collect { str, idx {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @return a zipped iterator with indices
* @see #indexed(Iterator)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<E, Integer>> withIndex(Iterator<E> self) {
return withIndex(self, 0);
}
/**
* Zips an iterator with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [[0, "a"], [1, "b"]] == ["a", "b"].iterator().indexed().collect{ tuple {@code ->} [tuple.first, tuple.second] }
* assert ["0: a", "1: b"] == ["a", "b"].iterator().indexed().collect { idx, str {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @return a zipped iterator with indices
* @see #withIndex(Iterator)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<Integer, E>> indexed(Iterator<E> self) {
return indexed(self, 0);
}
/**
* Zips an iterator with indices in (value, index) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [["a", 5], ["b", 6]] == ["a", "b"].iterator().withIndex(5).toList()
* assert ["1: a", "2: b"] == ["a", "b"].iterator().withIndex(1).collect { str, idx {@code ->} "$idx: $str" }.toList()
* </pre>
*
* @param self an iterator
* @param offset an index to start from
* @return a zipped iterator with indices
* @see #indexed(Iterator, int)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<E, Integer>> withIndex(Iterator<E> self, int offset) {
return new ZipPostIterator<E>(self, offset);
}
/**
* Zips an iterator with indices in (index, value) order.
* <p/>
* Example usage:
* <pre class="groovyTestCase">
* assert [[5, "a"], [6, "b"]] == ["a", "b"].iterator().indexed(5).toList()
* assert ["a: 1", "b: 2"] == ["a", "b"].iterator().indexed(1).collect { idx, str {@code ->} "$str: $idx" }.toList()
* </pre>
*
* @param self an iterator
* @param offset an index to start from
* @return a zipped iterator with indices
* @see #withIndex(Iterator, int)
* @since 2.4.0
*/
public static <E> Iterator<Tuple2<Integer, E>> indexed(Iterator<E> self, int offset) {
return new ZipPreIterator<E>(self, offset);
}
private static final class ZipPostIterator<E> implements Iterator<Tuple2<E, Integer>> {
private final Iterator<E> delegate;
private int index;
private ZipPostIterator(Iterator<E> delegate, int offset) {
this.delegate = delegate;
this.index = offset;
}
public boolean hasNext() {
return delegate.hasNext();
}
public Tuple2<E, Integer> next() {
if (!hasNext()) throw new NoSuchElementException();
return new Tuple2<E, Integer>(delegate.next(), index++);
}
public void remove() {
delegate.remove();
}
}
private static final class ZipPreIterator<E> implements Iterator<Tuple2<Integer, E>> {
private final Iterator<E> delegate;
private int index;
private ZipPreIterator(Iterator<E> delegate, int offset) {
this.delegate = delegate;
this.index = offset;
}
public boolean hasNext() {
return delegate.hasNext();
}
public Tuple2<Integer, E> next() {
if (!hasNext()) throw new NoSuchElementException();
return new Tuple2<Integer, E>(index++, delegate.next());
}
public void remove() {
delegate.remove();
}
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable,boolean)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self) {
return sort((Iterable<T>) self, true);
}
/**
* Sorts the Collection. Assumes that the collection items are comparable
* and uses their natural ordering to determine the resulting order.
* If the Collection is a List, it is sorted in place and returned.
* Otherwise, the elements are first placed into a new list which is then
* sorted and returned - leaving the original Collection unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [3,1,2].sort()</pre>
*
* @param self the Iterable to be sorted
* @return the sorted Iterable as a List
* @see #sort(Collection, boolean)
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self) {
return sort(self, true);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate) {
return sort((Iterable<T>) self, mutate);
}
/**
* Sorts the Iterable. Assumes that the Iterable items are
* comparable and uses their natural ordering to determine the resulting order.
* If the Iterable is a List and mutate is true,
* it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [3,1,2].sort()</pre>
* <pre class="groovyTestCase">
* def orig = [1, 3, 2]
* def sorted = orig.sort(false)
* assert orig == [1, 3, 2]
* assert sorted == [1, 2, 3]
* </pre>
*
* @param self the iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @return the sorted iterable as a List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate) {
List<T> answer = mutate ? asList(self) : toList(self);
answer.sort(new NumberAwareComparator<T>());
return answer;
}
/**
* Sorts the elements from the given map into a new ordered map using
* the closure as a comparator to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">def map = [a:5, b:3, c:6, d:4].sort { a, b {@code ->} a.value {@code <=>} b.value }
* assert map == [b:3, d:4, a:5, c:6]</pre>
*
* @param self the original unsorted map
* @param closure a Closure used as a comparator
* @return the sorted map
* @since 1.6.0
*/
public static <K, V> Map<K, V> sort(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
Map<K, V> result = new LinkedHashMap<K, V>();
List<Map.Entry<K, V>> entries = asList((Iterable<Map.Entry<K, V>>) self.entrySet());
sort((Iterable<Map.Entry<K, V>>) entries, closure);
for (Map.Entry<K, V> entry : entries) {
result.put(entry.getKey(), entry.getValue());
}
return result;
}
/**
* Sorts the elements from the given map into a new ordered Map using
* the specified key comparator to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">def map = [ba:3, cz:6, ab:5].sort({ a, b {@code ->} a[-1] {@code <=>} b[-1] } as Comparator)
* assert map*.value == [3, 5, 6]</pre>
*
* @param self the original unsorted map
* @param comparator a Comparator
* @return the sorted map
* @since 1.7.2
*/
public static <K, V> Map<K, V> sort(Map<K, V> self, Comparator<? super K> comparator) {
Map<K, V> result = new TreeMap<K, V>(comparator);
result.putAll(self);
return result;
}
/**
* Sorts the elements from the given map into a new ordered Map using
* the natural ordering of the keys to determine the ordering.
* The original map is unchanged.
* <pre class="groovyTestCase">map = [ba:3, cz:6, ab:5].sort()
* assert map*.value == [5, 3, 6]
* </pre>
*
* @param self the original unsorted map
* @return the sorted map
* @since 1.7.2
*/
public static <K, V> Map<K, V> sort(Map<K, V> self) {
return new TreeMap<K, V>(self);
}
/**
* Modifies this array so that its elements are in sorted order.
* The array items are assumed to be comparable.
*
* @param self the array to be sorted
* @return the sorted array
* @since 1.5.5
*/
public static <T> T[] sort(T[] self) {
Arrays.sort(self, new NumberAwareComparator<T>());
return self;
}
/**
* Sorts the given array into sorted order.
* The array items are assumed to be comparable.
* If mutate is true, the array is sorted in place and returned. Otherwise, a new sorted
* array is returned and the original array remains unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false)
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["Hey","hello","hi"] as String[]
* orig.sort(true)
* assert orig == ["Hey","hello","hi"] as String[]
* </pre>
*
* @param self the array to be sorted
* @param mutate false will always cause a new array to be created, true will mutate the array in place
* @return the sorted array
* @since 1.8.1
*/
public static <T> T[] sort(T[] self, boolean mutate) {
T[] answer = mutate ? self : self.clone();
Arrays.sort(answer, new NumberAwareComparator<T>());
return answer;
}
/**
* Sorts the given iterator items into a sorted iterator. The items are
* assumed to be comparable. The original iterator will become
* exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self) {
return sort((Iterable<T>) toList(self)).listIterator();
}
/**
* Sorts the given iterator items into a sorted iterator using the comparator. The
* original iterator will become exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @param comparator a Comparator used for comparing items
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self, Comparator<? super T> comparator) {
return sort(toList(self), true, comparator).listIterator();
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Comparator)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, Comparator<T> comparator) {
return sort((Iterable<T>) self, true, comparator);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Comparator)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate, Comparator<T> comparator) {
return sort((Iterable<T>) self, mutate, comparator);
}
/**
* Sorts the Iterable using the given Comparator. If the Iterable is a List and mutate
* is true, it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* assert ["hi","hey","hello"] == ["hello","hi","hey"].sort(false, { a, b {@code ->} a.length() {@code <=>} b.length() } as Comparator )
* </pre>
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.sort(false, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param comparator a Comparator used for the comparison
* @return a sorted List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate, Comparator<? super T> comparator) {
List<T> list = mutate ? asList(self) : toList(self);
list.sort(comparator);
return list;
}
/**
* Sorts the given array into sorted order using the given comparator.
*
* @param self the array to be sorted
* @param comparator a Comparator used for the comparison
* @return the sorted array
* @since 1.5.5
*/
public static <T> T[] sort(T[] self, Comparator<? super T> comparator) {
return sort(self, true, comparator);
}
/**
* Modifies this array so that its elements are in sorted order as determined by the given comparator.
* If mutate is true, the array is sorted in place and returned. Otherwise, a new sorted
* array is returned and the original array remains unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["hello","Hey","hi"] as String[]
* orig.sort(true, String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","Hey","hi"] as String[]
* </pre>
*
* @param self the array containing elements to be sorted
* @param mutate false will always cause a new array to be created, true will mutate arrays in place
* @param comparator a Comparator used for the comparison
* @return a sorted array
* @since 1.8.1
*/
public static <T> T[] sort(T[] self, boolean mutate, Comparator<? super T> comparator) {
T[] answer = mutate ? self : self.clone();
Arrays.sort(answer, comparator);
return answer;
}
/**
* Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.
* The original iterator will be fully processed after the method call.
* <p>
* If the closure has two parameters it is used like a traditional Comparator.
* I.e. it should compare its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than, equal to,
* or greater than the second respectively. Otherwise, the Closure is assumed
* to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the Iterator to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted items as an Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> sort(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort((Iterable<T>) toList(self), closure).listIterator();
}
/**
* Sorts the elements from this array into a newly created array using
* the Closure to determine the correct ordering.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the array containing the elements to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted array
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] sort(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort(self, false, closure);
}
/**
* Modifies this array so that its elements are in sorted order using the Closure to determine the correct ordering.
* If mutate is false, a new array is returned and the original array remains unchanged.
* Otherwise, the original array is sorted in place and returned.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"] as String[]
* def sorted = orig.sort(false) { it.size() }
* assert orig == ["hello","hi","Hey"] as String[]
* assert sorted == ["hi","Hey","hello"] as String[]
* orig.sort(true) { it.size() }
* assert orig == ["hi","Hey","hello"] as String[]
* </pre>
*
* @param self the array to be sorted
* @param mutate false will always cause a new array to be created, true will mutate arrays in place
* @param closure a Closure used to determine the correct ordering
* @return the sorted array
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T> T[] sort(T[] self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
T[] answer = (T[]) sort((Iterable<T>) toList(self), closure).toArray();
if (mutate) {
System.arraycopy(answer, 0, self, 0, answer.length);
}
return mutate ? self : answer;
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, boolean, Closure)
* @since 1.8.1
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, boolean mutate, Closure closure) {
return sort((Iterable<T>)self, mutate, closure);
}
/**
* @deprecated Use the Iterable version of sort instead
* @see #sort(Iterable, Closure)
* @since 1.0
*/
@Deprecated
public static <T> List<T> sort(Collection<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort((Iterable<T>)self, closure);
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. If the Iterable is a List,
* it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the Closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
*
* @param self the Iterable to be sorted
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @see #sort(Collection, boolean, Closure)
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
return sort(self, true, closure);
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. If the Iterable is a List
* and mutate is true, it is sorted in place and returned. Otherwise, the elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.sort(false) { it.toUpperCase() }
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param mutate false will always cause a new list to be created, true will mutate lists in place
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @since 2.2.0
*/
public static <T> List<T> sort(Iterable<T> self, boolean mutate, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
List<T> list = mutate ? asList(self) : toList(self);
// use a comparator of one item or two
int params = closure.getMaximumNumberOfParameters();
if (params == 1) {
list.sort(new OrderBy<T>(closure));
} else {
list.sort(new ClosureComparator<T>(closure));
}
return list;
}
/**
* Avoids doing unnecessary work when sorting an already sorted set (i.e. an identity function for an already sorted set).
*
* @param self an already sorted set
* @return the set
* @since 1.0
*/
public static <T> SortedSet<T> sort(SortedSet<T> self) {
return self;
}
/**
* Avoids doing unnecessary work when sorting an already sorted map (i.e. an identity function for an already sorted map).
*
* @param self an already sorted map
* @return the map
* @since 1.8.1
*/
public static <K, V> SortedMap<K, V> sort(SortedMap<K, V> self) {
return self;
}
/**
* Sorts the Iterable. Assumes that the Iterable elements are
* comparable and uses a {@link NumberAwareComparator} to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterable elements. The elements are first placed into a new list which
* is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* def orig = [1, 3, 2]
* def sorted = orig.toSorted()
* assert orig == [1, 3, 2]
* assert sorted == [1, 2, 3]
* </pre>
*
* @param self the Iterable to be sorted
* @return the sorted iterable as a List
* @see #toSorted(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self) {
return toSorted(self, new NumberAwareComparator<T>());
}
/**
* Sorts the Iterable using the given Comparator. The elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <pre class="groovyTestCase">
* def orig = ["hello","hi","Hey"]
* def sorted = orig.toSorted(String.CASE_INSENSITIVE_ORDER)
* assert orig == ["hello","hi","Hey"]
* assert sorted == ["hello","Hey","hi"]
* </pre>
*
* @param self the Iterable to be sorted
* @param comparator a Comparator used for the comparison
* @return a sorted List
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self, Comparator<T> comparator) {
List<T> list = toList(self);
list.sort(comparator);
return list;
}
/**
* Sorts this Iterable using the given Closure to determine the correct ordering. The elements are first placed
* into a new list which is then sorted and returned - leaving the original Iterable unchanged.
* <p>
* If the Closure has two parameters
* it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than,
* equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a
* Comparable (typically an Integer) which is then used for
* further comparison.
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { it.length() }</pre>
* <pre class="groovyTestCase">assert ["hi","hey","hello"] == ["hello","hi","hey"].sort { a, b {@code ->} a.length() {@code <=>} b.length() }</pre>
*
* @param self the Iterable to be sorted
* @param closure a 1 or 2 arg Closure used to determine the correct ordering
* @return a newly created sorted List
* @see #toSorted(Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> toSorted(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(closure) : new ClosureComparator<T>(closure);
return toSorted(self, comparator);
}
/**
* Sorts the Iterator. Assumes that the Iterator elements are
* comparable and uses a {@link NumberAwareComparator} to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterator elements.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @return the sorted items as an Iterator
* @see #toSorted(Iterator, Comparator)
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self) {
return toSorted(self, new NumberAwareComparator<T>());
}
/**
* Sorts the given iterator items using the comparator. The
* original iterator will become exhausted of elements after completing this method call.
* A new iterator is produced that traverses the items in sorted order.
*
* @param self the Iterator to be sorted
* @param comparator a Comparator used for comparing items
* @return the sorted items as an Iterator
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self, Comparator<T> comparator) {
return toSorted(toList(self), comparator).listIterator();
}
/**
* Sorts the given iterator items into a sorted iterator using the Closure to determine the correct ordering.
* The original iterator will be fully processed after the method call.
* <p>
* If the closure has two parameters it is used like a traditional Comparator.
* I.e. it should compare its two parameters for order, returning a negative integer,
* zero, or a positive integer when the first parameter is less than, equal to,
* or greater than the second respectively. Otherwise, the Closure is assumed
* to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the Iterator to be sorted
* @param closure a Closure used to determine the correct ordering
* @return the sorted items as an Iterator
* @see #toSorted(Iterator, Comparator)
* @since 2.4.0
*/
public static <T> Iterator<T> toSorted(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(closure) : new ClosureComparator<T>(closure);
return toSorted(self, comparator);
}
/**
* Returns a sorted version of the given array using the supplied comparator.
*
* @param self the array to be sorted
* @return the sorted array
* @see #toSorted(Object[], Comparator)
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self) {
return toSorted(self, new NumberAwareComparator<T>());
}
/**
* Returns a sorted version of the given array using the supplied comparator to determine the resulting order.
* <pre class="groovyTestCase">
* def sumDigitsComparator = [compare: { num1, num2 {@code ->} num1.toString().toList()*.toInteger().sum() {@code <=>} num2.toString().toList()*.toInteger().sum() }] as Comparator
* Integer[] nums = [9, 44, 222, 7000]
* def result = nums.toSorted(sumDigitsComparator)
* assert result instanceof Integer[]
* assert result == [222, 7000, 44, 9]
* </pre>
*
* @param self the array to be sorted
* @param comparator a Comparator used for the comparison
* @return the sorted array
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self, Comparator<T> comparator) {
T[] answer = self.clone();
Arrays.sort(answer, comparator);
return answer;
}
/**
* Sorts the elements from this array into a newly created array using
* the Closure to determine the correct ordering.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
*
* @param self the array containing the elements to be sorted
* @param condition a Closure used to determine the correct ordering
* @return a sorted array
* @see #toSorted(Object[], Comparator)
* @since 2.4.0
*/
public static <T> T[] toSorted(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
Comparator<T> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(condition) : new ClosureComparator<T>(condition);
return toSorted(self, comparator);
}
/**
* Sorts the elements from the given map into a new ordered map using
* a {@link NumberAwareComparator} on map entry values to determine the resulting order.
* {@code NumberAwareComparator} has special treatment for numbers but otherwise uses the
* natural ordering of the Iterator elements. The original map is unchanged.
* <pre class="groovyTestCase">
* def map = [a:5L, b:3, c:6, d:4.0].toSorted()
* assert map.toString() == '[b:3, d:4.0, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self) {
return toSorted(self, new NumberAwareValueComparator<K, V>());
}
private static class NumberAwareValueComparator<K, V> implements Comparator<Map.Entry<K, V>> {
private final Comparator<V> delegate = new NumberAwareComparator<V>();
@Override
public int compare(Map.Entry<K, V> e1, Map.Entry<K, V> e2) {
return delegate.compare(e1.getValue(), e2.getValue());
}
}
/**
* Sorts the elements from the given map into a new ordered map using
* the supplied comparator to determine the ordering. The original map is unchanged.
* <pre class="groovyTestCase">
* def keyComparator = [compare: { e1, e2 {@code ->} e1.key {@code <=>} e2.key }] as Comparator
* def valueComparator = [compare: { e1, e2 {@code ->} e1.value {@code <=>} e2.value }] as Comparator
* def map1 = [a:5, b:3, d:4, c:6].toSorted(keyComparator)
* assert map1.toString() == '[a:5, b:3, c:6, d:4]'
* def map2 = [a:5, b:3, d:4, c:6].toSorted(valueComparator)
* assert map2.toString() == '[b:3, d:4, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @param comparator a Comparator used for the comparison
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self, Comparator<Map.Entry<K, V>> comparator) {
List<Map.Entry<K, V>> sortedEntries = toSorted(self.entrySet(), comparator);
Map<K, V> result = new LinkedHashMap<K, V>();
for (Map.Entry<K, V> entry : sortedEntries) {
result.put(entry.getKey(), entry.getValue());
}
return result;
}
/**
* Sorts the elements from the given map into a new ordered map using
* the supplied Closure condition as a comparator to determine the ordering. The original map is unchanged.
* <p>
* If the closure has two parameters it is used like a traditional Comparator. I.e. it should compare
* its two entry parameters for order, returning a negative integer, zero, or a positive integer when the
* first parameter is less than, equal to, or greater than the second respectively. Otherwise,
* the Closure is assumed to take a single entry parameter and return a Comparable (typically an Integer)
* which is then used for further comparison.
* <pre class="groovyTestCase">
* def map = [a:5, b:3, c:6, d:4].toSorted { a, b {@code ->} a.value {@code <=>} b.value }
* assert map.toString() == '[b:3, d:4, a:5, c:6]'
* </pre>
*
* @param self the original unsorted map
* @param condition a Closure used as a comparator
* @return the sorted map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure condition) {
Comparator<Map.Entry<K,V>> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<Map.Entry<K,V>>(condition) : new ClosureComparator<Map.Entry<K,V>>(condition);
return toSorted(self, comparator);
}
/**
* Avoids doing unnecessary work when sorting an already sorted set
*
* @param self an already sorted set
* @return an ordered copy of the sorted set
* @since 2.4.0
*/
public static <T> Set<T> toSorted(SortedSet<T> self) {
return new LinkedHashSet<T>(self);
}
/**
* Avoids doing unnecessary work when sorting an already sorted map
*
* @param self an already sorted map
* @return an ordered copy of the map
* @since 2.4.0
*/
public static <K, V> Map<K, V> toSorted(SortedMap<K, V> self) {
return new LinkedHashMap<K, V>(self);
}
/**
* Removes the initial item from the List.
*
* <pre class="groovyTestCase">
* def list = ["a", false, 2]
* assert list.pop() == 'a'
* assert list == [false, 2]
* </pre>
*
* This is similar to pop on a Stack where the first item in the list
* represents the top of the stack.
*
* Note: The behavior of this method changed in Groovy 2.5 to align with Java.
* If you need the old behavior use 'removeLast'.
*
* @param self a List
* @return the item removed from the List
* @throws NoSuchElementException if the list is empty
* @since 1.0
*/
public static <T> T pop(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot pop() an empty List");
}
return self.remove(0);
}
/**
* Removes the last item from the List.
*
* <pre class="groovyTestCase">
* def list = ["a", false, 2]
* assert list.removeLast() == 2
* assert list == ["a", false]
* </pre>
*
* Using add() and removeLast() is similar to push and pop on a Stack
* where the last item in the list represents the top of the stack.
*
* @param self a List
* @return the item removed from the List
* @throws NoSuchElementException if the list is empty
* @since 2.5.0
*/
public static <T> T removeLast(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot removeLast() an empty List");
}
return self.remove(self.size() - 1);
}
/**
* Provides an easy way to append multiple Map.Entry values to a Map.
*
* @param self a Map
* @param entries a Collection of Map.Entry items to be added to the Map.
* @return the same map, after the items have been added to it.
* @since 1.6.1
*/
public static <K, V> Map<K, V> putAll(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) {
for (Map.Entry<? extends K, ? extends V> entry : entries) {
self.put(entry.getKey(), entry.getValue());
}
return self;
}
/**
* Returns a new <code>Map</code> containing all entries from <code>self</code> and <code>entries</code>,
* giving precedence to <code>entries</code>. Any keys appearing in both Maps
* will appear in the resultant map with values from the <code>entries</code>
* operand. If <code>self</code> map is one of TreeMap, LinkedHashMap, Hashtable
* or Properties, the returned Map will preserve that type, otherwise a HashMap will
* be returned.
*
* @param self a Map
* @param entries a Collection of Map.Entry items to be added to the Map.
* @return a new Map containing all key, value pairs from self and entries
* @since 1.6.1
*/
public static <K, V> Map<K, V> plus(Map<K, V> self, Collection<? extends Map.Entry<? extends K, ? extends V>> entries) {
Map<K, V> map = cloneSimilarMap(self);
putAll(map, entries);
return map;
}
/**
* Prepends an item to the start of the List.
*
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* list.push("x")
* assert list == ['x', 3, 4, 2]
* </pre>
*
* This is similar to push on a Stack where the first item in the list
* represents the top of the stack.
*
* Note: The behavior of this method changed in Groovy 2.5 to align with Java.
* If you need the old behavior use 'add'.
*
* @param self a List
* @param value element to be prepended to this list.
* @return <tt>true</tt> (for legacy compatibility reasons).
* @since 1.5.5
*/
public static <T> boolean push(List<T> self, T value) {
self.add(0, value);
return true;
}
/**
* Returns the last item from the List.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.last() == 2
* // check original is unaltered
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return the last item from the List
* @throws NoSuchElementException if the list is empty and you try to access the last() item.
* @since 1.5.5
*/
public static <T> T last(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot access last() element from an empty List");
}
return self.get(self.size() - 1);
}
/**
* Returns the last item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.last() == 2
* // check original unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The last element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the last item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the last() item.
* @since 1.8.7
*/
public static <T> T last(Iterable<T> self) {
Iterator<T> iterator = self.iterator();
if (!iterator.hasNext()) {
throw new NoSuchElementException("Cannot access last() element from an empty Iterable");
}
T result = null;
while (iterator.hasNext()) {
result = iterator.next();
}
return result;
}
/**
* Returns the last item from the array.
* <pre class="groovyTestCase">
* def array = [3, 4, 2].toArray()
* assert array.last() == 2
* </pre>
*
* @param self an array
* @return the last item from the array
* @throws NoSuchElementException if the array is empty and you try to access the last() item.
* @since 1.7.3
*/
public static <T> T last(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access last() element from an empty Array");
}
return self[self.length - 1];
}
/**
* Returns the first item from the List.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.first() == 3
* // check original is unaltered
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return the first item from the List
* @throws NoSuchElementException if the list is empty and you try to access the first() item.
* @since 1.5.5
*/
public static <T> T first(List<T> self) {
if (self.isEmpty()) {
throw new NoSuchElementException("Cannot access first() element from an empty List");
}
return self.get(0);
}
/**
* Returns the first item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.first() == 3
* // check original is unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The first element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the first item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the first() item.
* @since 1.8.7
*/
public static <T> T first(Iterable<T> self) {
Iterator<T> iterator = self.iterator();
if (!iterator.hasNext()) {
throw new NoSuchElementException("Cannot access first() element from an empty Iterable");
}
return iterator.next();
}
/**
* Returns the first item from the array.
* <pre class="groovyTestCase">
* def array = [3, 4, 2].toArray()
* assert array.first() == 3
* </pre>
*
* @param self an array
* @return the first item from the array
* @throws NoSuchElementException if the array is empty and you try to access the first() item.
* @since 1.7.3
*/
public static <T> T first(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access first() element from an empty array");
}
return self[0];
}
/**
* Returns the first item from the Iterable.
* <pre class="groovyTestCase">
* def set = [3, 4, 2] as LinkedHashSet
* assert set.head() == 3
* // check original is unaltered
* assert set == [3, 4, 2] as Set
* </pre>
* The first element returned by the Iterable's iterator is returned.
* If the Iterable doesn't guarantee a defined order it may appear like
* a random element is returned.
*
* @param self an Iterable
* @return the first item from the Iterable
* @throws NoSuchElementException if the Iterable is empty and you try to access the head() item.
* @since 2.4.0
*/
public static <T> T head(Iterable<T> self) {
return first(self);
}
/**
* Returns the first item from the List.
* <pre class="groovyTestCase">def list = [3, 4, 2]
* assert list.head() == 3
* assert list == [3, 4, 2]</pre>
*
* @param self a List
* @return the first item from the List
* @throws NoSuchElementException if the list is empty and you try to access the head() item.
* @since 1.5.5
*/
public static <T> T head(List<T> self) {
return first(self);
}
/**
* Returns the first item from the Object array.
* <pre class="groovyTestCase">def array = [3, 4, 2].toArray()
* assert array.head() == 3</pre>
*
* @param self an array
* @return the first item from the Object array
* @throws NoSuchElementException if the array is empty and you try to access the head() item.
* @since 1.7.3
*/
public static <T> T head(T[] self) {
return first(self);
}
/**
* Returns the items from the List excluding the first item.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.tail() == [4, 2]
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return a List without its first element
* @throws NoSuchElementException if the List is empty and you try to access the tail()
* @since 1.5.6
*/
public static <T> List<T> tail(List<T> self) {
return (List<T>) tail((Iterable<T>)self);
}
/**
* Returns the items from the SortedSet excluding the first item.
* <pre class="groovyTestCase">
* def sortedSet = [3, 4, 2] as SortedSet
* assert sortedSet.tail() == [3, 4] as SortedSet
* assert sortedSet == [3, 4, 2] as SortedSet
* </pre>
*
* @param self a SortedSet
* @return a SortedSet without its first element
* @throws NoSuchElementException if the SortedSet is empty and you try to access the tail()
* @since 2.4.0
*/
public static <T> SortedSet<T> tail(SortedSet<T> self) {
return (SortedSet<T>) tail((Iterable<T>) self);
}
/**
* Calculates the tail values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of tail on the items.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].tails() == [[1, 2, 3, 4], [2, 3, 4], [3, 4], [4], []]
* </pre>
*
* @param self an Iterable
* @return a List of the tail values from the given Iterable
* @since 2.5.0
*/
public static <T> List<List<T>> tails(Iterable<T> self) {
return GroovyCollections.tails(self);
}
/**
* Returns the items from the Iterable excluding the first item.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.tail() == [4, 2]
* assert list == [3, 4, 2]
* </pre>
*
* @param self an Iterable
* @return a collection without its first element
* @throws NoSuchElementException if the iterable is empty and you try to access the tail()
* @since 2.4.0
*/
public static <T> Collection<T> tail(Iterable<T> self) {
if (!self.iterator().hasNext()) {
throw new NoSuchElementException("Cannot access tail() for an empty iterable");
}
Collection<T> result = createSimilarCollection(self);
addAll(result, tail(self.iterator()));
return result;
}
/**
* Returns the items from the array excluding the first item.
* <pre class="groovyTestCase">
* String[] strings = ["a", "b", "c"]
* def result = strings.tail()
* assert result.class.componentType == String
* String[] expected = ["b", "c"]
* assert result == expected
* </pre>
*
* @param self an array
* @return an array without its first element
* @throws NoSuchElementException if the array is empty and you try to access the tail()
* @since 1.7.3
*/
@SuppressWarnings("unchecked")
public static <T> T[] tail(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access tail() for an empty array");
}
T[] result = createSimilarArray(self, self.length - 1);
System.arraycopy(self, 1, result, 0, self.length - 1);
return result;
}
/**
* Returns the original iterator after throwing away the first element.
*
* @param self the original iterator
* @return the iterator without its first element
* @throws NoSuchElementException if the array is empty and you try to access the tail()
* @since 1.8.1
*/
public static <T> Iterator<T> tail(Iterator<T> self) {
if (!self.hasNext()) {
throw new NoSuchElementException("Cannot access tail() for an empty Iterator");
}
self.next();
return self;
}
/**
* Calculates the init values of this Iterable: the first value will be this list of all items from the iterable and the final one will be an empty list, with the intervening values the results of successive applications of init on the items.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].inits() == [[1, 2, 3, 4], [1, 2, 3], [1, 2], [1], []]
* </pre>
*
* @param self an Iterable
* @return a List of the init values from the given Iterable
* @since 2.5.0
*/
public static <T> List<List<T>> inits(Iterable<T> self) {
return GroovyCollections.inits(self);
}
/**
* Returns the items from the Iterable excluding the last item. Leaves the original Iterable unchanged.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.init() == [3, 4]
* assert list == [3, 4, 2]
* </pre>
*
* @param self an Iterable
* @return a Collection without its last element
* @throws NoSuchElementException if the iterable is empty and you try to access init()
* @since 2.4.0
*/
public static <T> Collection<T> init(Iterable<T> self) {
if (!self.iterator().hasNext()) {
throw new NoSuchElementException("Cannot access init() for an empty Iterable");
}
Collection<T> result;
if (self instanceof Collection) {
Collection<T> selfCol = (Collection<T>) self;
result = createSimilarCollection(selfCol, selfCol.size() - 1);
} else {
result = new ArrayList<T>();
}
addAll(result, init(self.iterator()));
return result;
}
/**
* Returns the items from the List excluding the last item. Leaves the original List unchanged.
* <pre class="groovyTestCase">
* def list = [3, 4, 2]
* assert list.init() == [3, 4]
* assert list == [3, 4, 2]
* </pre>
*
* @param self a List
* @return a List without its last element
* @throws NoSuchElementException if the List is empty and you try to access init()
* @since 2.4.0
*/
public static <T> List<T> init(List<T> self) {
return (List<T>) init((Iterable<T>) self);
}
/**
* Returns the items from the SortedSet excluding the last item. Leaves the original SortedSet unchanged.
* <pre class="groovyTestCase">
* def sortedSet = [3, 4, 2] as SortedSet
* assert sortedSet.init() == [2, 3] as SortedSet
* assert sortedSet == [3, 4, 2] as SortedSet
* </pre>
*
* @param self a SortedSet
* @return a SortedSet without its last element
* @throws NoSuchElementException if the SortedSet is empty and you try to access init()
* @since 2.4.0
*/
public static <T> SortedSet<T> init(SortedSet<T> self) {
return (SortedSet<T>) init((Iterable<T>) self);
}
/**
* Returns an Iterator containing all of the items from this iterator except the last one.
* <pre class="groovyTestCase">
* def iter = [3, 4, 2].listIterator()
* def result = iter.init()
* assert result.toList() == [3, 4]
* </pre>
*
* @param self an Iterator
* @return an Iterator without the last element from the original Iterator
* @throws NoSuchElementException if the iterator is empty and you try to access init()
* @since 2.4.0
*/
public static <T> Iterator<T> init(Iterator<T> self) {
if (!self.hasNext()) {
throw new NoSuchElementException("Cannot access init() for an empty Iterator");
}
return new InitIterator<T>(self);
}
private static final class InitIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private boolean exhausted;
private E next;
private InitIterator(Iterator<E> delegate) {
this.delegate = delegate;
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
advance();
}
private void advance() {
next = delegate.next();
exhausted = !delegate.hasNext();
}
}
/**
* Returns the items from the Object array excluding the last item.
* <pre class="groovyTestCase">
* String[] strings = ["a", "b", "c"]
* def result = strings.init()
* assert result.length == 2
* assert strings.class.componentType == String
* </pre>
*
* @param self an array
* @return an array without its last element
* @throws NoSuchElementException if the array is empty and you try to access the init() item.
* @since 2.4.0
*/
public static <T> T[] init(T[] self) {
if (self.length == 0) {
throw new NoSuchElementException("Cannot access init() for an empty Object array");
}
T[] result = createSimilarArray(self, self.length - 1);
System.arraycopy(self, 0, result, 0, self.length - 1);
return result;
}
/**
* Returns the first <code>num</code> elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == []
* assert strings.take( 2 ) == [ 'a', 'b' ]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ]
* </pre>
*
* @param self the original List
* @param num the number of elements to take from this List
* @return a List consisting of the first <code>num</code> elements from this List,
* or else all the elements from the List if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> List<T> take(List<T> self, int num) {
return (List<T>) take((Iterable<T>)self, num);
}
/**
* Returns the first <code>num</code> elements from the head of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.take( 0 ) == [] as SortedSet
* assert strings.take( 2 ) == [ 'a', 'b' ] as SortedSet
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to take from this SortedSet
* @return a SortedSet consisting of the first <code>num</code> elements from this List,
* or else all the elements from the SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> take(SortedSet<T> self, int num) {
return (SortedSet<T>) take((Iterable<T>) self, num);
}
/**
* Returns the first <code>num</code> elements from the head of this array.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == [] as String[]
* assert strings.take( 2 ) == [ 'a', 'b' ] as String[]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to take from this array
* @return an array consisting of the first <code>num</code> elements of this array,
* or else the whole array if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> T[] take(T[] self, int num) {
if (self.length == 0 || num <= 0) {
return createSimilarArray(self, 0);
}
if (self.length <= num) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, num);
System.arraycopy(self, 0, ret, 0, num);
return ret;
}
/**
* Returns the first <code>num</code> elements from the head of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.take( 0 ) == []
* assert strings.take( 2 ) == [ 'a', 'b' ]
* assert strings.take( 5 ) == [ 'a', 'b', 'c' ]
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.take(0) == []
* assert abc.take(1) == ['a']
* assert abc.take(3) == ['a', 'b', 'c']
* assert abc.take(5) == ['a', 'b', 'c']
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to take from this Iterable
* @return a Collection consisting of the first <code>num</code> elements from this Iterable,
* or else all the elements from the Iterable if it has less then <code>num</code> elements.
* @since 1.8.7
*/
public static <T> Collection<T> take(Iterable<T> self, int num) {
Collection<T> result = self instanceof Collection ? createSimilarCollection((Collection<T>) self, Math.max(num, 0)) : new ArrayList<T>();
addAll(result, take(self.iterator(), num));
return result;
}
/**
* Adds all items from the iterator to the Collection.
*
* @param self the collection
* @param items the items to add
* @return true if the collection changed
*/
public static <T> boolean addAll(Collection<T> self, Iterator<? extends T> items) {
boolean changed = false;
while (items.hasNext()) {
T next = items.next();
if (self.add(next)) changed = true;
}
return changed;
}
/**
* Adds all items from the iterable to the Collection.
*
* @param self the collection
* @param items the items to add
* @return true if the collection changed
*/
public static <T> boolean addAll(Collection<T> self, Iterable<? extends T> items) {
boolean changed = false;
for (T next : items) {
if (self.add(next)) changed = true;
}
return changed;
}
/**
* Returns a new map containing the first <code>num</code> elements from the head of this map.
* If the map instance does not have ordered keys, then this function could return a random <code>num</code>
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
* <pre class="groovyTestCase">
* def strings = [ 'a':10, 'b':20, 'c':30 ]
* assert strings.take( 0 ) == [:]
* assert strings.take( 2 ) == [ 'a':10, 'b':20 ]
* assert strings.take( 5 ) == [ 'a':10, 'b':20, 'c':30 ]
* </pre>
*
* @param self the original map
* @param num the number of elements to take from this map
* @return a new map consisting of the first <code>num</code> elements of this map,
* or else the whole map if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <K, V> Map<K, V> take(Map<K, V> self, int num) {
if (self.isEmpty() || num <= 0) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
for (Map.Entry<K, V> entry : self.entrySet()) {
K key = entry.getKey();
V value = entry.getValue();
ret.put(key, value);
if (--num <= 0) {
break;
}
}
return ret;
}
/**
* Returns an iterator of up to the first <code>num</code> elements from this iterator.
* The original iterator is stepped along by <code>num</code> elements.
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ true }, next:{ a++ } ] as Iterator
* def iteratorCompare( Iterator a, List b ) {
* a.collect { it } == b
* }
* assert iteratorCompare( iter.take( 0 ), [] )
* assert iteratorCompare( iter.take( 2 ), [ 0, 1 ] )
* assert iteratorCompare( iter.take( 5 ), [ 2, 3, 4, 5, 6 ] )
* </pre>
*
* @param self the Iterator
* @param num the number of elements to take from this iterator
* @return an iterator consisting of up to the first <code>num</code> elements of this iterator.
* @since 1.8.1
*/
public static <T> Iterator<T> take(Iterator<T> self, int num) {
return new TakeIterator<T>(self, num);
}
private static final class TakeIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private Integer num;
private TakeIterator(Iterator<E> delegate, Integer num) {
this.delegate = delegate;
this.num = num;
}
public boolean hasNext() {
return num > 0 && delegate.hasNext();
}
public E next() {
if (num <= 0) throw new NoSuchElementException();
num--;
return delegate.next();
}
public void remove() {
delegate.remove();
}
}
@Deprecated
public static CharSequence take(CharSequence self, int num) {
return StringGroovyMethods.take(self, num);
}
/**
* Returns the last <code>num</code> elements from the tail of this array.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == [] as String[]
* assert strings.takeRight( 2 ) == [ 'b', 'c' ] as String[]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to take from this array
* @return an array consisting of the last <code>num</code> elements of this array,
* or else the whole array if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> T[] takeRight(T[] self, int num) {
if (self.length == 0 || num <= 0) {
return createSimilarArray(self, 0);
}
if (self.length <= num) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, num);
System.arraycopy(self, self.length - num, ret, 0, num);
return ret;
}
/**
* Returns the last <code>num</code> elements from the tail of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == []
* assert strings.takeRight( 2 ) == [ 'b', 'c' ]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ]
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.takeRight(0) == []
* assert abc.takeRight(1) == ['c']
* assert abc.takeRight(3) == ['a', 'b', 'c']
* assert abc.takeRight(5) == ['a', 'b', 'c']
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to take from this Iterable
* @return a Collection consisting of the last <code>num</code> elements from this Iterable,
* or else all the elements from the Iterable if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Collection<T> takeRight(Iterable<T> self, int num) {
if (num <= 0 || !self.iterator().hasNext()) {
return self instanceof Collection ? createSimilarCollection((Collection<T>) self, 0) : new ArrayList<T>();
}
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
if (selfCol.size() <= num) {
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size());
ret.addAll(selfCol);
return ret;
}
Collection<T> ret = createSimilarCollection(selfCol, num);
ret.addAll(asList((Iterable<T>) selfCol).subList(selfCol.size() - num, selfCol.size()));
return ret;
}
/**
* Returns the last <code>num</code> elements from the tail of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.takeRight( 0 ) == []
* assert strings.takeRight( 2 ) == [ 'b', 'c' ]
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ]
* </pre>
*
* @param self the original List
* @param num the number of elements to take from this List
* @return a List consisting of the last <code>num</code> elements from this List,
* or else all the elements from the List if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> List<T> takeRight(List<T> self, int num) {
return (List<T>) takeRight((Iterable<T>) self, num);
}
/**
* Returns the last <code>num</code> elements from the tail of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.takeRight( 0 ) == [] as SortedSet
* assert strings.takeRight( 2 ) == [ 'b', 'c' ] as SortedSet
* assert strings.takeRight( 5 ) == [ 'a', 'b', 'c' ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to take from this SortedSet
* @return a SortedSet consisting of the last <code>num</code> elements from this SortedSet,
* or else all the elements from the SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> takeRight(SortedSet<T> self, int num) {
return (SortedSet<T>) takeRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ] as SortedSet
* assert strings.drop( 2 ) == [ 'c' ] as SortedSet
* assert strings.drop( 5 ) == [] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to drop from this Iterable
* @return a SortedSet consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> drop(SortedSet<T> self, int num) {
return (SortedSet<T>) drop((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.drop( 2 ) == [ 'c' ]
* assert strings.drop( 5 ) == []
* </pre>
*
* @param self the original List
* @param num the number of elements to drop from this Iterable
* @return a List consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 1.8.1
*/
public static <T> List<T> drop(List<T> self, int num) {
return (List<T>) drop((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the head of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.drop( 2 ) == [ 'c' ]
* assert strings.drop( 5 ) == []
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.drop(0) == ['a', 'b', 'c']
* assert abc.drop(1) == ['b', 'c']
* assert abc.drop(3) == []
* assert abc.drop(5) == []
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to drop from this Iterable
* @return a Collection consisting of all the elements of this Iterable minus the first <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 1.8.7
*/
public static <T> Collection<T> drop(Iterable<T> self, int num) {
Collection<T> result = createSimilarCollection(self);
addAll(result, drop(self.iterator(), num));
return result;
}
/**
* Drops the given number of elements from the head of this array
* if they are available.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.drop( 0 ) == [ 'a', 'b', 'c' ] as String[]
* assert strings.drop( 2 ) == [ 'c' ] as String[]
* assert strings.drop( 5 ) == [] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to drop from this array
* @return an array consisting of all elements of this array except the
* first <code>num</code> ones, or else the empty array, if this
* array has less than <code>num</code> elements.
* @since 1.8.1
*/
public static <T> T[] drop(T[] self, int num) {
if (self.length <= num) {
return createSimilarArray(self, 0);
}
if (num <= 0) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, self.length - num);
System.arraycopy(self, num, ret, 0, self.length - num);
return ret;
}
/**
* Drops the given number of key/value pairs from the head of this map if they are available.
* <pre class="groovyTestCase">
* def strings = [ 'a':10, 'b':20, 'c':30 ]
* assert strings.drop( 0 ) == [ 'a':10, 'b':20, 'c':30 ]
* assert strings.drop( 2 ) == [ 'c':30 ]
* assert strings.drop( 5 ) == [:]
* </pre>
* If the map instance does not have ordered keys, then this function could drop a random <code>num</code>
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self the original map
* @param num the number of elements to drop from this map
* @return a map consisting of all key/value pairs of this map except the first
* <code>num</code> ones, or else the empty map, if this map has
* less than <code>num</code> elements.
* @since 1.8.1
*/
public static <K, V> Map<K, V> drop(Map<K, V> self, int num) {
if (self.size() <= num) {
return createSimilarMap(self);
}
if (num == 0) {
return cloneSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
for (Map.Entry<K, V> entry : self.entrySet()) {
K key = entry.getKey();
V value = entry.getValue();
if (num-- <= 0) {
ret.put(key, value);
}
}
return ret;
}
/**
* Drops the given number of elements from the head of this iterator if they are available.
* The original iterator is stepped along by <code>num</code> elements.
* <pre class="groovyTestCase">
* def iteratorCompare( Iterator a, List b ) {
* a.collect { it } == b
* }
* def iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 0 ), [ 1, 2, 3, 4, 5 ] )
* iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 2 ), [ 3, 4, 5 ] )
* iter = [ 1, 2, 3, 4, 5 ].listIterator()
* assert iteratorCompare( iter.drop( 5 ), [] )
* </pre>
*
* @param self the original iterator
* @param num the number of elements to drop from this iterator
* @return The iterator stepped along by <code>num</code> elements if they exist.
* @since 1.8.1
*/
public static <T> Iterator<T> drop(Iterator<T> self, int num) {
while (num-- > 0 && self.hasNext()) {
self.next();
}
return self;
}
/**
* Drops the given number of elements from the tail of this SortedSet.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ] as SortedSet
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ] as SortedSet
* assert strings.dropRight( 2 ) == [ 'a' ] as SortedSet
* assert strings.dropRight( 5 ) == [] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param num the number of elements to drop from this SortedSet
* @return a List consisting of all the elements of this SortedSet minus the last <code>num</code> elements,
* or an empty SortedSet if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> SortedSet<T> dropRight(SortedSet<T> self, int num) {
return (SortedSet<T>) dropRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the tail of this List.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.dropRight( 2 ) == [ 'a' ]
* assert strings.dropRight( 5 ) == []
* </pre>
*
* @param self the original List
* @param num the number of elements to drop from this List
* @return a List consisting of all the elements of this List minus the last <code>num</code> elements,
* or an empty List if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> List<T> dropRight(List<T> self, int num) {
return (List<T>) dropRight((Iterable<T>) self, num);
}
/**
* Drops the given number of elements from the tail of this Iterable.
* <pre class="groovyTestCase">
* def strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ]
* assert strings.dropRight( 2 ) == [ 'a' ]
* assert strings.dropRight( 5 ) == []
*
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.dropRight(0) == ['a', 'b', 'c']
* assert abc.dropRight(1) == ['a', 'b']
* assert abc.dropRight(3) == []
* assert abc.dropRight(5) == []
* </pre>
*
* @param self the original Iterable
* @param num the number of elements to drop from this Iterable
* @return a Collection consisting of all the elements of this Iterable minus the last <code>num</code> elements,
* or an empty list if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Collection<T> dropRight(Iterable<T> self, int num) {
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
if (selfCol.size() <= num) {
return createSimilarCollection(selfCol, 0);
}
if (num <= 0) {
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size());
ret.addAll(selfCol);
return ret;
}
Collection<T> ret = createSimilarCollection(selfCol, selfCol.size() - num);
ret.addAll(asList((Iterable<T>)selfCol).subList(0, selfCol.size() - num));
return ret;
}
/**
* Drops the given number of elements from the tail of this Iterator.
* <pre class="groovyTestCase">
* def getObliterator() { "obliter8".iterator() }
* assert obliterator.dropRight(-1).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r', '8']
* assert obliterator.dropRight(0).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r', '8']
* assert obliterator.dropRight(1).toList() == ['o', 'b', 'l', 'i', 't', 'e', 'r']
* assert obliterator.dropRight(4).toList() == ['o', 'b', 'l', 'i']
* assert obliterator.dropRight(7).toList() == ['o']
* assert obliterator.dropRight(8).toList() == []
* assert obliterator.dropRight(9).toList() == []
* </pre>
*
* @param self the original Iterator
* @param num the number of elements to drop
* @return an Iterator consisting of all the elements of this Iterator minus the last <code>num</code> elements,
* or an empty Iterator if it has less then <code>num</code> elements.
* @since 2.4.0
*/
public static <T> Iterator<T> dropRight(Iterator<T> self, int num) {
if (num <= 0) {
return self;
}
return new DropRightIterator<T>(self, num);
}
private static final class DropRightIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final LinkedList<E> discards;
private boolean exhausted;
private int num;
private DropRightIterator(Iterator<E> delegate, int num) {
this.delegate = delegate;
this.num = num;
discards = new LinkedList<E>();
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = discards.removeFirst();
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
while (discards.size() <= num && !exhausted) {
exhausted = !delegate.hasNext();
if (!exhausted) {
discards.add(delegate.next());
}
}
}
}
/**
* Drops the given number of elements from the tail of this array
* if they are available.
* <pre class="groovyTestCase">
* String[] strings = [ 'a', 'b', 'c' ]
* assert strings.dropRight( 0 ) == [ 'a', 'b', 'c' ] as String[]
* assert strings.dropRight( 2 ) == [ 'a' ] as String[]
* assert strings.dropRight( 5 ) == [] as String[]
* </pre>
*
* @param self the original array
* @param num the number of elements to drop from this array
* @return an array consisting of all elements of this array except the
* last <code>num</code> ones, or else the empty array, if this
* array has less than <code>num</code> elements.
* @since 2.4.0
*/
public static <T> T[] dropRight(T[] self, int num) {
if (self.length <= num) {
return createSimilarArray(self, 0);
}
if (num <= 0) {
T[] ret = createSimilarArray(self, self.length);
System.arraycopy(self, 0, ret, 0, self.length);
return ret;
}
T[] ret = createSimilarArray(self, self.length - num);
System.arraycopy(self, 0, ret, 0, self.length - num);
return ret;
}
/**
* Returns the longest prefix of this list where each element
* passed to the given closure condition evaluates to true.
* Similar to {@link #takeWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original list.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ]
* assert nums.takeWhile{ it {@code <} 1 } == []
* assert nums.takeWhile{ it {@code <} 3 } == [ 1 ]
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 3, 2 ]
* </pre>
*
* @param self the original list
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given list where each element passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <T> List<T> takeWhile(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T value : self) {
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return take(self, num);
}
/**
* Returns a Collection containing the longest prefix of the elements from this Iterable
* where each element passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* def abc = new AbcIterable()
* assert abc.takeWhile{ it {@code <} 'b' } == ['a']
* assert abc.takeWhile{ it {@code <=} 'b' } == ['a', 'b']
* </pre>
*
* @param self an Iterable
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a Collection containing a prefix of the elements from the given Iterable where
* each element passed to the given closure evaluates to true
* @since 1.8.7
*/
public static <T> Collection<T> takeWhile(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Collection<T> result = createSimilarCollection(self);
addAll(result, takeWhile(self.iterator(), condition));
return result;
}
/**
* Returns the longest prefix of this SortedSet where each element
* passed to the given closure condition evaluates to true.
* Similar to {@link #takeWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original SortedSet.
* <pre class="groovyTestCase">
* def nums = [ 1, 2, 3 ] as SortedSet
* assert nums.takeWhile{ it {@code <} 1 } == [] as SortedSet
* assert nums.takeWhile{ it {@code <} 2 } == [ 1 ] as SortedSet
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 2, 3 ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given SortedSet where each element passed to
* the given closure evaluates to true
* @since 2.4.0
*/
public static <T> SortedSet<T> takeWhile(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return (SortedSet<T>) takeWhile((Iterable<T>) self, condition);
}
/**
* Returns the longest prefix of this Map where each entry (or key/value pair) when
* passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* def shopping = [milk:1, bread:2, chocolate:3]
* assert shopping.takeWhile{ it.key.size() {@code <} 6 } == [milk:1, bread:2]
* assert shopping.takeWhile{ it.value % 2 } == [milk:1]
* assert shopping.takeWhile{ k, v {@code ->} k.size() + v {@code <=} 7 } == [milk:1, bread:2]
* </pre>
* If the map instance does not have ordered keys, then this function could appear to take random
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self a Map
* @param condition a 1 (or 2) arg Closure that must evaluate to true for the
* entry (or key and value) to continue taking elements
* @return a prefix of the given Map where each entry (or key/value pair) passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <K, V> Map<K, V> takeWhile(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
if (self.isEmpty()) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (!bcw.callForMap(entry)) break;
ret.put(entry.getKey(), entry.getValue());
}
return ret;
}
/**
* Returns the longest prefix of this array where each element
* passed to the given closure evaluates to true.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ] as Integer[]
* assert nums.takeWhile{ it {@code <} 1 } == [] as Integer[]
* assert nums.takeWhile{ it {@code <} 3 } == [ 1 ] as Integer[]
* assert nums.takeWhile{ it {@code <} 4 } == [ 1, 3, 2 ] as Integer[]
* </pre>
*
* @param self the original array
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of the given array where each element passed to
* the given closure evaluates to true
* @since 1.8.7
*/
public static <T> T[] takeWhile(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (num < self.length) {
T value = self[num];
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return take(self, num);
}
/**
* Returns the longest prefix of elements in this iterator where
* each element passed to the given condition closure evaluates to true.
* <p>
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ true }, next:{ a++ } ] as Iterator
*
* assert [].iterator().takeWhile{ it {@code <} 3 }.toList() == []
* assert [1, 2, 3, 4, 5].iterator().takeWhile{ it {@code <} 3 }.toList() == [ 1, 2 ]
* assert iter.takeWhile{ it {@code <} 5 }.toList() == [ 0, 1, 2, 3, 4 ]
* </pre>
*
* @param self the Iterator
* @param condition the closure that must evaluate to true to
* continue taking elements
* @return a prefix of elements in the given iterator where each
* element passed to the given closure evaluates to true
* @since 1.8.7
*/
public static <T> Iterator<T> takeWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return new TakeWhileIterator<T>(self, condition);
}
private static final class TakeWhileIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final BooleanClosureWrapper condition;
private boolean exhausted;
private E next;
private TakeWhileIterator(Iterator<E> delegate, Closure condition) {
this.delegate = delegate;
this.condition = new BooleanClosureWrapper(condition);
advance();
}
public boolean hasNext() {
return !exhausted;
}
public E next() {
if (exhausted) throw new NoSuchElementException();
E result = next;
advance();
return result;
}
public void remove() {
if (exhausted) throw new NoSuchElementException();
delegate.remove();
}
private void advance() {
exhausted = !delegate.hasNext();
if (!exhausted) {
next = delegate.next();
if (!condition.call(next)) {
exhausted = true;
next = null;
}
}
}
}
/**
* Returns a suffix of this SortedSet where elements are dropped from the front
* while the given Closure evaluates to true.
* Similar to {@link #dropWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original SortedSet.
* <pre class="groovyTestCase">
* def nums = [ 1, 2, 3 ] as SortedSet
* assert nums.dropWhile{ it {@code <} 4 } == [] as SortedSet
* assert nums.dropWhile{ it {@code <} 2 } == [ 2, 3 ] as SortedSet
* assert nums.dropWhile{ it != 3 } == [ 3 ] as SortedSet
* assert nums.dropWhile{ it == 0 } == [ 1, 2, 3 ] as SortedSet
* </pre>
*
* @param self the original SortedSet
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of the given SortedSet such that the given closure condition
* evaluates to true for each element dropped from the front of the SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> dropWhile(SortedSet<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return (SortedSet<T>) dropWhile((Iterable<T>) self, condition);
}
/**
* Returns a suffix of this List where elements are dropped from the front
* while the given Closure evaluates to true.
* Similar to {@link #dropWhile(Iterable, groovy.lang.Closure)}
* except that it attempts to preserve the type of the original list.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ]
* assert nums.dropWhile{ it {@code <} 4 } == []
* assert nums.dropWhile{ it {@code <} 3 } == [ 3, 2 ]
* assert nums.dropWhile{ it != 2 } == [ 2 ]
* assert nums.dropWhile{ it == 0 } == [ 1, 3, 2 ]
* </pre>
*
* @param self the original list
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of the given List such that the given closure condition
* evaluates to true for each element dropped from the front of the List
* @since 1.8.7
*/
public static <T> List<T> dropWhile(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (T value : self) {
if (bcw.call(value)) {
num += 1;
} else {
break;
}
}
return drop(self, num);
}
/**
* Returns a suffix of this Iterable where elements are dropped from the front
* while the given closure evaluates to true.
* <pre class="groovyTestCase">
* class HorseIterable implements Iterable<String> {
* Iterator<String> iterator() { "horse".iterator() }
* }
* def horse = new HorseIterable()
* assert horse.dropWhile{ it {@code <} 'r' } == ['r', 's', 'e']
* assert horse.dropWhile{ it {@code <=} 'r' } == ['s', 'e']
* </pre>
*
* @param self an Iterable
* @param condition the closure that must evaluate to true to continue dropping elements
* @return a Collection containing the shortest suffix of the given Iterable such that the given closure condition
* evaluates to true for each element dropped from the front of the Iterable
* @since 1.8.7
*/
public static <T> Collection<T> dropWhile(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
Collection<T> result = createSimilarCollection(selfCol);
addAll(result, dropWhile(self.iterator(), condition));
return result;
}
/**
* Create a suffix of the given Map by dropping as many entries as possible from the
* front of the original Map such that calling the given closure condition evaluates to
* true when passed each of the dropped entries (or key/value pairs).
* <pre class="groovyTestCase">
* def shopping = [milk:1, bread:2, chocolate:3]
* assert shopping.dropWhile{ it.key.size() {@code <} 6 } == [chocolate:3]
* assert shopping.dropWhile{ it.value % 2 } == [bread:2, chocolate:3]
* assert shopping.dropWhile{ k, v {@code ->} k.size() + v {@code <=} 7 } == [chocolate:3]
* </pre>
* If the map instance does not have ordered keys, then this function could appear to drop random
* entries. Groovy by default uses LinkedHashMap, so this shouldn't be an issue in the main.
*
* @param self a Map
* @param condition a 1 (or 2) arg Closure that must evaluate to true for the
* entry (or key and value) to continue dropping elements
* @return the shortest suffix of the given Map such that the given closure condition
* evaluates to true for each element dropped from the front of the Map
* @since 1.8.7
*/
public static <K, V> Map<K, V> dropWhile(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure condition) {
if (self.isEmpty()) {
return createSimilarMap(self);
}
Map<K, V> ret = createSimilarMap(self);
boolean dropping = true;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
for (Map.Entry<K, V> entry : self.entrySet()) {
if (dropping && !bcw.callForMap(entry)) dropping = false;
if (!dropping) ret.put(entry.getKey(), entry.getValue());
}
return ret;
}
/**
* Create a suffix of the given array by dropping as many elements as possible from the
* front of the original array such that calling the given closure condition evaluates to
* true when passed each of the dropped elements.
* <pre class="groovyTestCase">
* def nums = [ 1, 3, 2 ] as Integer[]
* assert nums.dropWhile{ it {@code <=} 3 } == [ ] as Integer[]
* assert nums.dropWhile{ it {@code <} 3 } == [ 3, 2 ] as Integer[]
* assert nums.dropWhile{ it != 2 } == [ 2 ] as Integer[]
* assert nums.dropWhile{ it == 0 } == [ 1, 3, 2 ] as Integer[]
* </pre>
*
* @param self the original array
* @param condition the closure that must evaluate to true to
* continue dropping elements
* @return the shortest suffix of the given array such that the given closure condition
* evaluates to true for each element dropped from the front of the array
* @since 1.8.7
*/
public static <T> T[] dropWhile(T[] self, @ClosureParams(FirstParam.Component.class) Closure<?> condition) {
int num = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (num < self.length) {
if (bcw.call(self[num])) {
num += 1;
} else {
break;
}
}
return drop(self, num);
}
/**
* Creates an Iterator that returns a suffix of the elements from an original Iterator. As many elements
* as possible are dropped from the front of the original Iterator such that calling the given closure
* condition evaluates to true when passed each of the dropped elements.
* <pre class="groovyTestCase">
* def a = 0
* def iter = [ hasNext:{ a {@code <} 10 }, next:{ a++ } ] as Iterator
* assert [].iterator().dropWhile{ it {@code <} 3 }.toList() == []
* assert [1, 2, 3, 4, 5].iterator().dropWhile{ it {@code <} 3 }.toList() == [ 3, 4, 5 ]
* assert iter.dropWhile{ it {@code <} 5 }.toList() == [ 5, 6, 7, 8, 9 ]
* </pre>
*
* @param self the Iterator
* @param condition the closure that must evaluate to true to continue dropping elements
* @return the shortest suffix of elements from the given Iterator such that the given closure condition
* evaluates to true for each element dropped from the front of the Iterator
* @since 1.8.7
*/
public static <T> Iterator<T> dropWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> condition) {
return new DropWhileIterator<T>(self, condition);
}
private static final class DropWhileIterator<E> implements Iterator<E> {
private final Iterator<E> delegate;
private final Closure condition;
private boolean buffering = false;
private E buffer = null;
private DropWhileIterator(Iterator<E> delegate, Closure condition) {
this.delegate = delegate;
this.condition = condition;
prepare();
}
public boolean hasNext() {
return buffering || delegate.hasNext();
}
public E next() {
if (buffering) {
E result = buffer;
buffering = false;
buffer = null;
return result;
} else {
return delegate.next();
}
}
public void remove() {
if (buffering) {
buffering = false;
buffer = null;
} else {
delegate.remove();
}
}
private void prepare() {
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (delegate.hasNext()) {
E next = delegate.next();
if (!bcw.call(next)) {
buffer = next;
buffering = true;
break;
}
}
}
}
/**
* Converts this Iterable to a Collection. Returns the original Iterable
* if it is already a Collection.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert new HashSet().asCollection() instanceof Collection
* </pre>
*
* @param self an Iterable to be converted into a Collection
* @return a newly created List if this Iterable is not already a Collection
* @since 2.4.0
*/
public static <T> Collection<T> asCollection(Iterable<T> self) {
if (self instanceof Collection) {
return (Collection<T>) self;
} else {
return toList(self);
}
}
/**
* @deprecated Use the Iterable version of asList instead
* @see #asList(Iterable)
* @since 1.0
*/
@Deprecated
public static <T> List<T> asList(Collection<T> self) {
return asList((Iterable<T>)self);
}
/**
* Converts this Iterable to a List. Returns the original Iterable
* if it is already a List.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert new HashSet().asList() instanceof List
* </pre>
*
* @param self an Iterable to be converted into a List
* @return a newly created List if this Iterable is not already a List
* @since 2.2.0
*/
public static <T> List<T> asList(Iterable<T> self) {
if (self instanceof List) {
return (List<T>) self;
} else {
return toList(self);
}
}
/**
* Coerce an object instance to a boolean value.
* An object is coerced to true if it's not null, to false if it is null.
*
* @param object the object to coerce
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Object object) {
return object != null;
}
/**
* Coerce a Boolean instance to a boolean value.
*
* @param bool the Boolean
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Boolean bool) {
if (null == bool) {
return false;
}
return bool;
}
/**
* Coerce a collection instance to a boolean value.
* A collection is coerced to false if it's empty, and to true otherwise.
* <pre class="groovyTestCase">assert [1,2].asBoolean() == true</pre>
* <pre class="groovyTestCase">assert [].asBoolean() == false</pre>
*
* @param collection the collection
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Collection collection) {
if (null == collection) {
return false;
}
return !collection.isEmpty();
}
/**
* Coerce a map instance to a boolean value.
* A map is coerced to false if it's empty, and to true otherwise.
* <pre class="groovyTestCase">assert [:] as Boolean == false
* assert [a:2] as Boolean == true</pre>
*
* @param map the map
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Map map) {
if (null == map) {
return false;
}
return !map.isEmpty();
}
/**
* Coerce an iterator instance to a boolean value.
* An iterator is coerced to false if there are no more elements to iterate over,
* and to true otherwise.
*
* @param iterator the iterator
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Iterator iterator) {
if (null == iterator) {
return false;
}
return iterator.hasNext();
}
/**
* Coerce an enumeration instance to a boolean value.
* An enumeration is coerced to false if there are no more elements to enumerate,
* and to true otherwise.
*
* @param enumeration the enumeration
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Enumeration enumeration) {
if (null == enumeration) {
return false;
}
return enumeration.hasMoreElements();
}
/**
* Coerce an Object array to a boolean value.
* An Object array is false if the array is of length 0.
* and to true otherwise
*
* @param array the array
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Object[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a byte array to a boolean value.
* A byte array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(byte[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a short array to a boolean value.
* A short array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(short[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces an int array to a boolean value.
* An int array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(int[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a long array to a boolean value.
* A long array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(long[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a float array to a boolean value.
* A float array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(float[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a double array to a boolean value.
* A double array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(double[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a boolean array to a boolean value.
* A boolean array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(boolean[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerces a char array to a boolean value.
* A char array is false if the array is of length 0,
* and true otherwise.
*
* @param array an array
* @return the array's boolean value
* @since 1.7.4
*/
public static boolean asBoolean(char[] array) {
if (null == array) {
return false;
}
return array.length > 0;
}
/**
* Coerce a character to a boolean value.
* A character is coerced to false if it's character value is equal to 0,
* and to true otherwise.
*
* @param character the character
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Character character) {
if (null == character) {
return false;
}
return character != 0;
}
/**
* Coerce a Float instance to a boolean value.
*
* @param object the Float
* @return {@code true} for non-zero and non-NaN values, else {@code false}
* @since 2.6.0
*/
public static boolean asBoolean(Float object) {
float f = object;
return f != 0.0f && !Float.isNaN(f);
}
/**
* Coerce a Double instance to a boolean value.
*
* @param object the Double
* @return {@code true} for non-zero and non-NaN values, else {@code false}
* @since 2.6.0
*/
public static boolean asBoolean(Double object) {
double d = object;
return d != 0.0d && !Double.isNaN(d);
}
/**
* Coerce a number to a boolean value.
* A number is coerced to false if its double value is equal to 0, and to true otherwise.
*
* @param number the number
* @return the boolean value
* @since 1.7.0
*/
public static boolean asBoolean(Number number) {
if (null == number) {
return false;
}
return number.doubleValue() != 0;
}
/**
* Converts the given iterable to another type.
*
* @param iterable a Iterable
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(Collection, Class)
* @since 2.4.12
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Iterable iterable, Class<T> clazz) {
if (Collection.class.isAssignableFrom(clazz)) {
return asType((Collection) toList(iterable), clazz);
}
return asType((Object) iterable, clazz);
}
/**
* Converts the given collection to another type. A default concrete
* type is used for List, Set, or SortedSet. If the given type has
* a constructor taking a collection, that is used. Otherwise, the
* call is deferred to {@link #asType(Object,Class)}. If this
* collection is already of the given type, the same instance is
* returned.
*
* @param col a collection
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(java.lang.Object, java.lang.Class)
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Collection col, Class<T> clazz) {
if (col.getClass() == clazz) {
return (T) col;
}
if (clazz == List.class) {
return (T) asList((Iterable) col);
}
if (clazz == Set.class) {
if (col instanceof Set) return (T) col;
return (T) new LinkedHashSet(col);
}
if (clazz == SortedSet.class) {
if (col instanceof SortedSet) return (T) col;
return (T) new TreeSet(col);
}
if (clazz == Queue.class) {
if (col instanceof Queue) return (T) col;
return (T) new LinkedList(col);
}
if (clazz == Stack.class) {
if (col instanceof Stack) return (T) col;
final Stack stack = new Stack();
stack.addAll(col);
return (T) stack;
}
if (clazz!=String[].class && ReflectionCache.isArray(clazz)) {
try {
return (T) asArrayType(col, clazz);
} catch (GroovyCastException e) {
/* ignore */
}
}
Object[] args = {col};
try {
return (T) InvokerHelper.invokeConstructorOf(clazz, args);
} catch (Exception e) {
// ignore, the constructor that takes a Collection as an argument may not exist
}
if (Collection.class.isAssignableFrom(clazz)) {
try {
Collection result = (Collection) InvokerHelper.invokeConstructorOf(clazz, null);
result.addAll(col);
return (T)result;
} catch (Exception e) {
// ignore, the no arg constructor might not exist.
}
}
return asType((Object) col, clazz);
}
/**
* Converts the given array to either a List, Set, or
* SortedSet. If the given class is something else, the
* call is deferred to {@link #asType(Object,Class)}.
*
* @param ary an array
* @param clazz the desired class
* @return the object resulting from this type conversion
* @see #asType(java.lang.Object, java.lang.Class)
* @since 1.5.1
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Object[] ary, Class<T> clazz) {
if (clazz == List.class) {
return (T) new ArrayList(Arrays.asList(ary));
}
if (clazz == Set.class) {
return (T) new HashSet(Arrays.asList(ary));
}
if (clazz == SortedSet.class) {
return (T) new TreeSet(Arrays.asList(ary));
}
return asType((Object) ary, clazz);
}
/**
* Coerces the closure to an implementation of the given class. The class
* is assumed to be an interface or class with a single method definition.
* The closure is used as the implementation of that single method.
*
* @param cl the implementation of the single method
* @param clazz the target type
* @return a Proxy of the given type which wraps this closure.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Closure cl, Class<T> clazz) {
if (clazz.isInterface() && !(clazz.isInstance(cl))) {
if (Traits.isTrait(clazz)) {
Method samMethod = CachedSAMClass.getSAMMethod(clazz);
if (samMethod!=null) {
Map impl = Collections.singletonMap(samMethod.getName(),cl);
return (T) ProxyGenerator.INSTANCE.instantiateAggregate(impl, Collections.singletonList(clazz));
}
}
return (T) Proxy.newProxyInstance(
clazz.getClassLoader(),
new Class[]{clazz},
new ConvertedClosure(cl));
}
try {
return asType((Object) cl, clazz);
} catch (GroovyCastException ce) {
try {
return (T) ProxyGenerator.INSTANCE.instantiateAggregateFromBaseClass(cl, clazz);
} catch (GroovyRuntimeException cause) {
throw new GroovyCastException("Error casting closure to " + clazz.getName() +
", Reason: " + cause.getMessage());
}
}
}
/**
* Coerces this map to the given type, using the map's keys as the public
* method names, and values as the implementation. Typically the value
* would be a closure which behaves like the method implementation.
*
* @param map this map
* @param clazz the target type
* @return a Proxy of the given type, which defers calls to this map's elements.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Map map, Class<T> clazz) {
if (!(clazz.isInstance(map)) && clazz.isInterface() && !Traits.isTrait(clazz)) {
return (T) Proxy.newProxyInstance(
clazz.getClassLoader(),
new Class[]{clazz},
new ConvertedMap(map));
}
try {
return asType((Object) map, clazz);
} catch (GroovyCastException ce) {
try {
return (T) ProxyGenerator.INSTANCE.instantiateAggregateFromBaseClass(map, clazz);
} catch (GroovyRuntimeException cause) {
throw new GroovyCastException("Error casting map to " + clazz.getName() +
", Reason: " + cause.getMessage());
}
}
}
/**
* Randomly reorders the elements of the specified list.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* def origSize = list.size()
* def origCopy = new ArrayList(list)
* list.shuffle()
* assert list.size() == origSize
* assert origCopy.every{ list.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static void shuffle(List<?> self) {
Collections.shuffle(self);
}
/**
* Randomly reorders the elements of the specified list using the
* specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* def list = ["a", 4, false]
* def origSize = list.size()
* def origCopy = new ArrayList(list)
* list.shuffle(r)
* assert list.size() == origSize
* assert origCopy.every{ list.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static void shuffle(List<?> self, Random rnd) {
Collections.shuffle(self, rnd);
}
/**
* Creates a new list containing the elements of the specified list
* but in a random order.
* <pre class="groovyTestCase">
* def orig = ["a", 4, false]
* def shuffled = orig.shuffled()
* assert orig.size() == shuffled.size()
* assert orig.every{ shuffled.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static <T> List<T> shuffled(List<T> self) {
List<T> copy = new ArrayList(self);
Collections.shuffle(copy);
return copy;
}
/**
* Creates a new list containing the elements of the specified list but in a random
* order using the specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* def orig = ["a", 4, false]
* def shuffled = orig.shuffled(r)
* assert orig.size() == shuffled.size()
* assert orig.every{ shuffled.contains(it) }
* </pre>
*
* @param self a List
* @see Collections#shuffle(List)
* @since 3.0.0
*/
public static <T> List<T> shuffled(List<T> self, Random rnd) {
List<T> copy = new ArrayList(self);
Collections.shuffle(copy, rnd);
return copy;
}
/**
* Randomly reorders the elements of the specified array.
* <pre class="groovyTestCase">
* Integer[] array = [10, 5, 20]
* def origSize = array.size()
* def items = array.toList()
* array.shuffle()
* assert array.size() == origSize
* assert items.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @since 3.0.0
*/
public static <T> void shuffle(T[] self) {
Random rnd = r;
if (rnd == null)
r = rnd = new Random(); // harmless race.
shuffle(self, rnd);
}
private static Random r;
/**
* Randomly reorders the elements of the specified array using the
* specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* Integer[] array = [10, 5, 20]
* def origSize = array.size()
* def items = array.toList()
* array.shuffle(r)
* assert array.size() == origSize
* assert items.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @since 3.0.0
*/
public static <T> void shuffle(T[] self, Random rnd) {
for (int i = 0; i < self.length-1; i++) {
int nextIndex = rnd.nextInt(self.length);
T tmp = self[i];
self[i] = self[nextIndex];
self[nextIndex] = tmp;
}
}
/**
* Creates a new array containing the elements of the specified array but in a random order.
* <pre class="groovyTestCase">
* Integer[] orig = [10, 5, 20]
* def array = orig.shuffled()
* assert orig.size() == array.size()
* assert orig.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @return the shuffled array
* @since 3.0.0
*/
public static <T> T[] shuffled(T[] self) {
Random rnd = r;
if (rnd == null)
r = rnd = new Random(); // harmless race.
return shuffled(self, rnd);
}
/**
* Creates a new array containing the elements of the specified array but in a random
* order using the specified random instance as the source of randomness.
* <pre class="groovyTestCase">
* def r = new Random()
* Integer[] orig = [10, 5, 20]
* def array = orig.shuffled(r)
* assert orig.size() == array.size()
* assert orig.every{ array.contains(it) }
* </pre>
*
* @param self an array
* @return the shuffled array
* @since 3.0.0
*/
public static <T> T[] shuffled(T[] self, Random rnd) {
T[] result = self.clone();
List<T> items = Arrays.asList(self);
Collections.shuffle(items, rnd);
System.arraycopy(items.toArray(), 0, result, 0, items.size());
return result;
}
/**
* Creates a new List with the identical contents to this list
* but in reverse order.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* assert list.reverse() == [false, 4, "a"]
* assert list == ["a", 4, false]
* </pre>
*
* @param self a List
* @return a reversed List
* @see #reverse(List, boolean)
* @since 1.0
*/
public static <T> List<T> reverse(List<T> self) {
return reverse(self, false);
}
/**
* Reverses the elements in a list. If mutate is true, the original list is modified in place and returned.
* Otherwise, a new list containing the reversed items is produced.
* <pre class="groovyTestCase">
* def list = ["a", 4, false]
* assert list.reverse(false) == [false, 4, "a"]
* assert list == ["a", 4, false]
* assert list.reverse(true) == [false, 4, "a"]
* assert list == [false, 4, "a"]
* </pre>
*
* @param self a List
* @param mutate true if the list itself should be reversed in place and returned, false if a new list should be created
* @return a reversed List
* @since 1.8.1
*/
public static <T> List<T> reverse(List<T> self, boolean mutate) {
if (mutate) {
Collections.reverse(self);
return self;
}
int size = self.size();
List<T> answer = new ArrayList<T>(size);
ListIterator<T> iter = self.listIterator(size);
while (iter.hasPrevious()) {
answer.add(iter.previous());
}
return answer;
}
/**
* Creates a new array containing items which are the same as this array but in reverse order.
*
* @param self an array
* @return an array containing the reversed items
* @see #reverse(Object[], boolean)
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] reverse(T[] self) {
return reverse(self, false);
}
/**
* Reverse the items in an array. If mutate is true, the original array is modified in place and returned.
* Otherwise, a new array containing the reversed items is produced.
*
* @param self an array
* @param mutate true if the array itself should be reversed in place and returned, false if a new array should be created
* @return an array containing the reversed items
* @since 1.8.1
*/
@SuppressWarnings("unchecked")
public static <T> T[] reverse(T[] self, boolean mutate) {
if (!mutate) {
return (T[]) toList(new ReverseListIterator<T>(Arrays.asList(self))).toArray();
}
List<T> items = Arrays.asList(self);
Collections.reverse(items);
System.arraycopy(items.toArray(), 0, self, 0, items.size());
return self;
}
/**
* Reverses the iterator. The original iterator will become
* exhausted of elements after determining the reversed values.
* A new iterator for iterating through the reversed values is returned.
*
* @param self an Iterator
* @return a reversed Iterator
* @since 1.5.5
*/
public static <T> Iterator<T> reverse(Iterator<T> self) {
return new ReverseListIterator<T>(toList(self));
}
/**
* Create an array as a union of two arrays.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* Integer[] b = [4, 5, 6]
* assert a + b == [1, 2, 3, 4, 5, 6] as Integer[]
* </pre>
*
* @param left the left Array
* @param right the right Array
* @return A new array containing right appended to left.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, T[] right) {
return (T[]) plus((List<T>) toList(left), toList(right)).toArray();
}
/**
* Create an array containing elements from an original array plus an additional appended element.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* Integer[] result = a + 4
* assert result == [1, 2, 3, 4] as Integer[]
* </pre>
*
* @param left the array
* @param right the value to append
* @return A new array containing left with right appended to it.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, T right) {
return (T[]) plus(toList(left), right).toArray();
}
/**
* Create an array containing elements from an original array plus those from a Collection.
* <pre class="groovyTestCase">
* Integer[] a = [1, 2, 3]
* def additions = [7, 8]
* assert a + additions == [1, 2, 3, 7, 8] as Integer[]
* </pre>
*
* @param left the array
* @param right a Collection to be appended
* @return A new array containing left with right appended to it.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, Collection<T> right) {
return (T[]) plus((List<T>) toList(left), right).toArray();
}
/**
* Create an array containing elements from an original array plus those from an Iterable.
* <pre class="groovyTestCase">
* class AbcIterable implements Iterable<String> {
* Iterator<String> iterator() { "abc".iterator() }
* }
* String[] letters = ['x', 'y', 'z']
* def result = letters + new AbcIterable()
* assert result == ['x', 'y', 'z', 'a', 'b', 'c'] as String[]
* assert result.class.array
* </pre>
*
* @param left the array
* @param right an Iterable to be appended
* @return A new array containing elements from left with those from right appended.
* @since 1.8.7
*/
@SuppressWarnings("unchecked")
public static <T> T[] plus(T[] left, Iterable<T> right) {
return (T[]) plus((List<T>) toList(left), toList(right)).toArray();
}
/**
* Create a Collection as a union of two collections. If the left collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3,4] == [1,2] + [3,4]</pre>
*
* @param left the left Collection
* @param right the right Collection
* @return the merged Collection
* @since 1.5.0
*/
public static <T> Collection<T> plus(Collection<T> left, Collection<T> right) {
final Collection<T> answer = cloneSimilarCollection(left, left.size() + right.size());
answer.addAll(right);
return answer;
}
/**
* Create a Collection as a union of two iterables. If the left iterable
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3,4] == [1,2] + [3,4]</pre>
*
* @param left the left Iterable
* @param right the right Iterable
* @return the merged Collection
* @since 2.4.0
*/
public static <T> Collection<T> plus(Iterable<T> left, Iterable<T> right) {
return plus(asCollection(left), asCollection(right));
}
/**
* Create a Collection as a union of a Collection and an Iterable. If the left collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Collection
* @param right the right Iterable
* @return the merged Collection
* @since 1.8.7
* @see #plus(Collection, Collection)
*/
public static <T> Collection<T> plus(Collection<T> left, Iterable<T> right) {
return plus(left, asCollection(right));
}
/**
* Create a List as a union of a List and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left List
* @param right the right Iterable
* @return the merged List
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> List<T> plus(List<T> left, Iterable<T> right) {
return (List<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a List as a union of a List and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left List
* @param right the right Collection
* @return the merged List
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> List<T> plus(List<T> left, Collection<T> right) {
return (List<T>) plus((Collection<T>) left, right);
}
/**
* Create a Set as a union of a Set and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Set
* @param right the right Iterable
* @return the merged Set
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> Set<T> plus(Set<T> left, Iterable<T> right) {
return (Set<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a Set as a union of a Set and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left Set
* @param right the right Collection
* @return the merged Set
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> Set<T> plus(Set<T> left, Collection<T> right) {
return (Set<T>) plus((Collection<T>) left, right);
}
/**
* Create a SortedSet as a union of a SortedSet and an Iterable.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left SortedSet
* @param right the right Iterable
* @return the merged SortedSet
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, Iterable<T> right) {
return (SortedSet<T>) plus((Collection<T>) left, asCollection(right));
}
/**
* Create a SortedSet as a union of a SortedSet and a Collection.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @param left the left SortedSet
* @param right the right Collection
* @return the merged SortedSet
* @since 2.4.0
* @see #plus(Collection, Collection)
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, Collection<T> right) {
return (SortedSet<T>) plus((Collection<T>) left, right);
}
/**
* Creates a new List by inserting all of the elements in the specified array
* to the elements from the original List at the specified index.
* Shifts the element currently at that index (if any) and any subsequent
* elements to the right (increasing their indices).
* The new elements will appear in the resulting List in the order that
* they occur in the original array.
* The behavior of this operation is undefined if the list or
* array operands are modified while the operation is in progress.
* The original list and array operands remain unchanged.
*
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def newItems = items.plus(2, 'a'..'c' as String[])
* assert newItems == [1, 2, 'a', 'b', 'c', 3]
* assert items == [1, 2, 3]
* </pre>
*
* See also <code>addAll</code> for similar functionality with modify semantics, i.e. which performs
* the changes on the original list itself.
*
* @param self an original list
* @param items array containing elements to be merged with elements from the original list
* @param index index at which to insert the first element from the specified array
* @return the new list
* @see #plus(List, int, List)
* @since 1.8.1
*/
public static <T> List<T> plus(List<T> self, int index, T[] items) {
return plus(self, index, Arrays.asList(items));
}
/**
* Creates a new List by inserting all of the elements in the given additions List
* to the elements from the original List at the specified index.
* Shifts the element currently at that index (if any) and any subsequent
* elements to the right (increasing their indices). The new elements
* will appear in the resulting List in the order that they occur in the original lists.
* The behavior of this operation is undefined if the original lists
* are modified while the operation is in progress. The original lists remain unchanged.
*
* <pre class="groovyTestCase">
* def items = [1, 2, 3]
* def newItems = items.plus(2, 'a'..'c')
* assert newItems == [1, 2, 'a', 'b', 'c', 3]
* assert items == [1, 2, 3]
* </pre>
*
* See also <code>addAll</code> for similar functionality with modify semantics, i.e. which performs
* the changes on the original list itself.
*
* @param self an original List
* @param additions a List containing elements to be merged with elements from the original List
* @param index index at which to insert the first element from the given additions List
* @return the new list
* @since 1.8.1
*/
public static <T> List<T> plus(List<T> self, int index, List<T> additions) {
final List<T> answer = new ArrayList<T>(self);
answer.addAll(index, additions);
return answer;
}
/**
* Creates a new List by inserting all of the elements in the given Iterable
* to the elements from this List at the specified index.
*
* @param self an original list
* @param additions an Iterable containing elements to be merged with the elements from the original List
* @param index index at which to insert the first element from the given additions Iterable
* @return the new list
* @since 1.8.7
* @see #plus(List, int, List)
*/
public static <T> List<T> plus(List<T> self, int index, Iterable<T> additions) {
return plus(self, index, toList(additions));
}
/**
* Create a collection as a union of a Collection and an Object. If the collection
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a Collection
* @param right an object to add/append
* @return the resulting Collection
* @since 1.5.0
*/
public static <T> Collection<T> plus(Collection<T> left, T right) {
final Collection<T> answer = cloneSimilarCollection(left, left.size() + 1);
answer.add(right);
return answer;
}
/**
* Create a collection as a union of an Iterable and an Object. If the iterable
* is a Set, then the returned collection will be a Set otherwise a List.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left an Iterable
* @param right an object to add/append
* @return the resulting Collection
* @since 2.4.0
*/
public static <T> Collection<T> plus(Iterable<T> left, T right) {
return plus(asCollection(left), right);
}
/**
* Create a List as a union of a List and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a List
* @param right an object to add/append
* @return the resulting List
* @since 2.4.0
*/
public static <T> List<T> plus(List<T> left, T right) {
return (List<T>) plus((Collection<T>) left, right);
}
/**
* Create a Set as a union of a Set and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a Set
* @param right an object to add/append
* @return the resulting Set
* @since 2.4.0
*/
public static <T> Set<T> plus(Set<T> left, T right) {
return (Set<T>) plus((Collection<T>) left, right);
}
/**
* Create a SortedSet as a union of a SortedSet and an Object.
* This operation will always create a new object for the result,
* while the operands remain unchanged.
* <pre class="groovyTestCase">assert [1,2,3] == [1,2] + 3</pre>
*
* @param left a SortedSet
* @param right an object to add/append
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> plus(SortedSet<T> left, T right) {
return (SortedSet<T>) plus((Collection<T>) left, right);
}
/**
* @deprecated use the Iterable variant instead
* @see #multiply(Iterable, Number)
* @since 1.0
*/
@Deprecated
public static <T> Collection<T> multiply(Collection<T> self, Number factor) {
return multiply((Iterable<T>) self, factor);
}
/**
* Create a Collection composed of the elements of this Iterable, repeated
* a certain number of times. Note that for non-primitive
* elements, multiple references to the same instance will be added.
* <pre class="groovyTestCase">assert [1,2,3,1,2,3] == [1,2,3] * 2</pre>
*
* Note: if the Iterable happens to not support duplicates, e.g. a Set, then the
* method will effectively return a Collection with a single copy of the Iterable's items.
*
* @param self an Iterable
* @param factor the number of times to append
* @return the multiplied Collection
* @since 2.4.0
*/
public static <T> Collection<T> multiply(Iterable<T> self, Number factor) {
Collection<T> selfCol = asCollection(self);
int size = factor.intValue();
Collection<T> answer = createSimilarCollection(selfCol, selfCol.size() * size);
for (int i = 0; i < size; i++) {
answer.addAll(selfCol);
}
return answer;
}
/**
* Create a List composed of the elements of this Iterable, repeated
* a certain number of times. Note that for non-primitive
* elements, multiple references to the same instance will be added.
* <pre class="groovyTestCase">assert [1,2,3,1,2,3] == [1,2,3] * 2</pre>
*
* Note: if the Iterable happens to not support duplicates, e.g. a Set, then the
* method will effectively return a Collection with a single copy of the Iterable's items.
*
* @param self a List
* @param factor the number of times to append
* @return the multiplied List
* @since 2.4.0
*/
public static <T> List<T> multiply(List<T> self, Number factor) {
return (List<T>) multiply((Iterable<T>) self, factor);
}
/**
* Create a Collection composed of the intersection of both collections. Any
* elements that exist in both collections are added to the resultant collection.
* For collections of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a Collection
* @param right a Collection
* @return a Collection as an intersection of both collections
* @see #intersect(Collection, Collection, Comparator)
* @since 1.5.6
*/
public static <T> Collection<T> intersect(Collection<T> left, Collection<T> right) {
return intersect(left, right, new NumberAwareComparator<>());
}
/**
* Create a Collection composed of the intersection of both collections. Any
* elements that exist in both collections are added to the resultant collection.
* For collections of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">
* assert [3,4] == [1,2,3,4].intersect([3,4,5,6], Comparator.naturalOrder())
* </pre>
* <pre class="groovyTestCase">
* def one = ['a', 'B', 'c', 'd']
* def two = ['b', 'C', 'd', 'e']
* def compareIgnoreCase = { a, b {@code ->} a.toLowerCase() {@code <=>} b.toLowerCase() }
* assert one.intersect(two) == ['d']
* assert two.intersect(one) == ['d']
* assert one.intersect(two, compareIgnoreCase) == ['b', 'C', 'd']
* assert two.intersect(one, compareIgnoreCase) == ['B', 'c', 'd']
* </pre>
*
* @param left a Collection
* @param right a Collection
* @param comparator a Comparator
* @return a Collection as an intersection of both collections
* @since 2.5.0
*/
public static <T> Collection<T> intersect(Collection<T> left, Collection<T> right, Comparator<T> comparator) {
if (left.isEmpty() || right.isEmpty())
return createSimilarCollection(left, 0);
Collection<T> result = createSimilarCollection(left, Math.min(left.size(), right.size()));
//creates the collection to look for values.
Collection<T> pickFrom = new TreeSet<T>(comparator);
pickFrom.addAll(left);
for (final T t : right) {
if (pickFrom.contains(t))
result.add(t);
}
return result;
}
/**
* Create a Collection composed of the intersection of both iterables. Any
* elements that exist in both iterables are added to the resultant collection.
* For iterables of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left an Iterable
* @param right an Iterable
* @return a Collection as an intersection of both iterables
* @see #intersect(Iterable, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Collection<T> intersect(Iterable<T> left, Iterable<T> right) {
return intersect(asCollection(left), asCollection(right));
}
/**
* Create a Collection composed of the intersection of both iterables. Any
* elements that exist in both iterables are added to the resultant collection.
* For iterables of custom objects; the objects should implement java.lang.Comparable
* <pre class="groovyTestCase">assert [3,4] == [1,2,3,4].intersect([3,4,5,6], Comparator.naturalOrder())</pre>
*
* @param left an Iterable
* @param right an Iterable
* @param comparator a Comparator
* @return a Collection as an intersection of both iterables
* @since 2.5.0
*/
public static <T> Collection<T> intersect(Iterable<T> left, Iterable<T> right, Comparator<T> comparator) {
return intersect(asCollection(left), asCollection(right), comparator);
}
/**
* Create a List composed of the intersection of a List and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] == [1,2,3,4,5].intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a List
* @param right an Iterable
* @return a List as an intersection of a List and an Iterable
* @see #intersect(List, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> List<T> intersect(List<T> left, Iterable<T> right) {
return (List<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a List composed of the intersection of a List and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [3,4] == [1,2,3,4].intersect([3,4,5,6])</pre>
*
* @param left a List
* @param right an Iterable
* @param comparator a Comparator
* @return a List as an intersection of a List and an Iterable
* @since 2.5.0
*/
public static <T> List<T> intersect(List<T> left, Iterable<T> right, Comparator<T> comparator) {
return (List<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a Set composed of the intersection of a Set and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as Set == ([1,2,3,4,5] as Set).intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a Set
* @param right an Iterable
* @return a Set as an intersection of a Set and an Iterable
* @see #intersect(Set, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> Set<T> intersect(Set<T> left, Iterable<T> right) {
return (Set<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a Set composed of the intersection of a Set and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [3,4] as Set == ([1,2,3,4] as Set).intersect([3,4,5,6], Comparator.naturalOrder())</pre>
*
* @param left a Set
* @param right an Iterable
* @param comparator a Comparator
* @return a Set as an intersection of a Set and an Iterable
* @since 2.5.0
*/
public static <T> Set<T> intersect(Set<T> left, Iterable<T> right, Comparator<T> comparator) {
return (Set<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a SortedSet composed of the intersection of a SortedSet and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as SortedSet == ([1,2,3,4,5] as SortedSet).intersect([4,5,6,7,8])</pre>
* By default, Groovy uses a {@link NumberAwareComparator} when determining if an
* element exists in both collections.
*
* @param left a SortedSet
* @param right an Iterable
* @return a Set as an intersection of a SortedSet and an Iterable
* @see #intersect(SortedSet, Iterable, Comparator)
* @since 2.4.0
*/
public static <T> SortedSet<T> intersect(SortedSet<T> left, Iterable<T> right) {
return (SortedSet<T>) intersect((Collection<T>) left, asCollection(right));
}
/**
* Create a SortedSet composed of the intersection of a SortedSet and an Iterable. Any
* elements that exist in both iterables are added to the resultant collection.
* <pre class="groovyTestCase">assert [4,5] as SortedSet == ([1,2,3,4,5] as SortedSet).intersect([4,5,6,7,8])</pre>
*
* @param left a SortedSet
* @param right an Iterable
* @param comparator a Comparator
* @return a Set as an intersection of a SortedSet and an Iterable
* @since 2.5.0
*/
public static <T> SortedSet<T> intersect(SortedSet<T> left, Iterable<T> right, Comparator<T> comparator) {
return (SortedSet<T>) intersect((Collection<T>) left, asCollection(right), comparator);
}
/**
* Create a Map composed of the intersection of both maps.
* Any entries that exist in both maps are added to the resultant map.
* <pre class="groovyTestCase">assert [4:4,5:5] == [1:1,2:2,3:3,4:4,5:5].intersect([4:4,5:5,6:6,7:7,8:8])</pre>
* <pre class="groovyTestCase">assert [1: 1, 2: 2, 3: 3, 4: 4].intersect( [1: 1.0, 2: 2, 5: 5] ) == [1:1, 2:2]</pre>
*
* @param left a map
* @param right a map
* @return a Map as an intersection of both maps
* @since 1.7.4
*/
public static <K,V> Map<K,V> intersect(Map<K,V> left, Map<K,V> right) {
final Map<K,V> ansMap = createSimilarMap(left);
if (right != null && !right.isEmpty()) {
for (Map.Entry<K, V> e1 : left.entrySet()) {
for (Map.Entry<K, V> e2 : right.entrySet()) {
if (DefaultTypeTransformation.compareEqual(e1, e2)) {
ansMap.put(e1.getKey(), e1.getValue());
}
}
}
}
return ansMap;
}
/**
* Returns <code>true</code> if the intersection of two iterables is empty.
* <pre class="groovyTestCase">assert [1,2,3].disjoint([3,4,5]) == false</pre>
* <pre class="groovyTestCase">assert [1,2].disjoint([3,4]) == true</pre>
*
* @param left an Iterable
* @param right an Iterable
* @return boolean <code>true</code> if the intersection of two iterables
* is empty, <code>false</code> otherwise.
* @since 2.4.0
*/
public static boolean disjoint(Iterable left, Iterable right) {
Collection leftCol = asCollection(left);
Collection rightCol = asCollection(right);
if (leftCol.isEmpty() || rightCol.isEmpty())
return true;
Collection pickFrom = new TreeSet(new NumberAwareComparator());
pickFrom.addAll(rightCol);
for (final Object o : leftCol) {
if (pickFrom.contains(o))
return false;
}
return true;
}
/**
* @deprecated use the Iterable variant instead
* @see #disjoint(Iterable, Iterable)
* @since 1.0
*/
@Deprecated
public static boolean disjoint(Collection left, Collection right) {
return disjoint(left, right);
}
/**
* Chops the array into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the array isn't large enough, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the array.
*
* @param self an Array to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original array elements into pieces determined by chopSizes
* @see #collate(Object[], int) to chop a list into pieces of a fixed size
* @since 2.5.2
*/
public static <T> List<List<T>> chop(T[] self, int... chopSizes) {
return chop(Arrays.asList(self), chopSizes);
}
/**
* Chops the Iterable into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the Iterable isn't large enough, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the Iterable.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].chop(1) == [[1]]
* assert [1, 2, 3, 4].chop(1,-1) == [[1], [2, 3, 4]]
* assert ('a'..'h').chop(2, 4) == [['a', 'b'], ['c', 'd', 'e', 'f']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(3) == [['a', 'b', 'c']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(1, 2, 3) == [['a'], ['b', 'c'], ['d', 'e']]
* assert ['a', 'b', 'c', 'd', 'e'].chop(1, 2, 3, 3, 3) == [['a'], ['b', 'c'], ['d', 'e'], [], []]
* </pre>
*
* @param self an Iterable to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original iterable into pieces determined by chopSizes
* @see #collate(Iterable, int) to chop an Iterable into pieces of a fixed size
* @since 2.5.2
*/
public static <T> List<List<T>> chop(Iterable<T> self, int... chopSizes) {
return chop(self.iterator(), chopSizes);
}
/**
* Chops the iterator items into pieces, returning lists with sizes corresponding to the supplied chop sizes.
* If the iterator is exhausted early, truncated (possibly empty) pieces are returned.
* Using a chop size of -1 will cause that piece to contain all remaining items from the iterator.
*
* @param self an Iterator to be chopped
* @param chopSizes the sizes for the returned pieces
* @return a list of lists chopping the original iterator elements into pieces determined by chopSizes
* @since 2.5.2
*/
public static <T> List<List<T>> chop(Iterator<T> self, int... chopSizes) {
List<List<T>> result = new ArrayList<List<T>>();
for (int nextSize : chopSizes) {
int size = nextSize;
List<T> next = new ArrayList<T>();
while (size-- != 0 && self.hasNext()) {
next.add(self.next());
}
result.add(next);
}
return result;
}
/**
* Compare the contents of this array to the contents of the given array.
*
* @param left an int array
* @param right the array being compared
* @return true if the contents of both arrays are equal.
* @since 1.5.0
*/
public static boolean equals(int[] left, int[] right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left == right) {
return true;
}
if (left.length != right.length) {
return false;
}
for (int i = 0; i < left.length; i++) {
if (left[i] != right[i]) return false;
}
return true;
}
/**
* Determines if the contents of this array are equal to the
* contents of the given list, in the same order. This returns
* <code>false</code> if either collection is <code>null</code>.
*
* @param left an array
* @param right the List being compared
* @return true if the contents of both collections are equal
* @since 1.5.0
*/
public static boolean equals(Object[] left, List right) {
return coercedEquals(left, right);
}
/**
* Determines if the contents of this list are equal to the
* contents of the given array in the same order. This returns
* <code>false</code> if either collection is <code>null</code>.
* <pre class="groovyTestCase">assert [1, "a"].equals( [ 1, "a" ] as Object[] )</pre>
*
* @param left a List
* @param right the Object[] being compared to
* @return true if the contents of both collections are equal
* @since 1.5.0
*/
public static boolean equals(List left, Object[] right) {
return coercedEquals(right, left);
}
private static boolean coercedEquals(Object[] left, List right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left.length != right.size()) {
return false;
}
for (int i = left.length - 1; i >= 0; i--) {
final Object o1 = left[i];
final Object o2 = right.get(i);
if (o1 == null) {
if (o2 != null) return false;
} else if (!coercedEquals(o1, o2)) {
return false;
}
}
return true;
}
private static boolean coercedEquals(Object o1, Object o2) {
if (o1 instanceof Comparable) {
if (!(o2 instanceof Comparable && numberAwareCompareTo((Comparable) o1, (Comparable) o2) == 0)) {
return false;
}
}
return DefaultTypeTransformation.compareEqual(o1, o2);
}
/**
* Compare the contents of two Lists. Order matters.
* If numbers exist in the Lists, then they are compared as numbers,
* for example 2 == 2L. If both lists are <code>null</code>, the result
* is true; otherwise if either list is <code>null</code>, the result
* is <code>false</code>.
* <pre class="groovyTestCase">assert ["a", 2].equals(["a", 2])
* assert ![2, "a"].equals("a", 2)
* assert [2.0, "a"].equals(2L, "a") // number comparison at work</pre>
*
* @param left a List
* @param right the List being compared to
* @return boolean <code>true</code> if the contents of both lists are identical,
* <code>false</code> otherwise.
* @since 1.0
*/
public static boolean equals(List left, List right) {
if (left == null) {
return right == null;
}
if (right == null) {
return false;
}
if (left == right) {
return true;
}
if (left.size() != right.size()) {
return false;
}
final Iterator it1 = left.iterator(), it2 = right.iterator();
while (it1.hasNext()) {
final Object o1 = it1.next();
final Object o2 = it2.next();
if (o1 == null) {
if (o2 != null) return false;
} else if (!coercedEquals(o1, o2)) {
return false;
}
}
return true;
}
/**
* Compare the contents of two Sets for equality using Groovy's coercion rules.
* <p>
* Returns <tt>true</tt> if the two sets have the same size, and every member
* of the specified set is contained in this set (or equivalently, every member
* of this set is contained in the specified set).
* If numbers exist in the sets, then they are compared as numbers,
* for example 2 == 2L. If both sets are <code>null</code>, the result
* is true; otherwise if either set is <code>null</code>, the result
* is <code>false</code>. Example usage:
* <pre class="groovyTestCase">
* Set s1 = ["a", 2]
* def s2 = [2, 'a'] as Set
* Set s3 = [3, 'a']
* def s4 = [2.0, 'a'] as Set
* def s5 = [2L, 'a'] as Set
* assert s1.equals(s2)
* assert !s1.equals(s3)
* assert s1.equals(s4)
* assert s1.equals(s5)</pre>
*
* @param self a Set
* @param other the Set being compared to
* @return <tt>true</tt> if the contents of both sets are identical
* @since 1.8.0
*/
public static <T> boolean equals(Set<T> self, Set<T> other) {
if (self == null) {
return other == null;
}
if (other == null) {
return false;
}
if (self == other) {
return true;
}
if (self.size() != other.size()) {
return false;
}
final Iterator<T> it1 = self.iterator();
Collection<T> otherItems = new HashSet<T>(other);
while (it1.hasNext()) {
final Object o1 = it1.next();
final Iterator<T> it2 = otherItems.iterator();
T foundItem = null;
boolean found = false;
while (it2.hasNext() && foundItem == null) {
final T o2 = it2.next();
if (coercedEquals(o1, o2)) {
foundItem = o2;
found = true;
}
}
if (!found) return false;
otherItems.remove(foundItem);
}
return otherItems.isEmpty();
}
/**
* Compares two Maps treating coerced numerical values as identical.
* <p>
* Example usage:
* <pre class="groovyTestCase">assert [a:2, b:3] == [a:2L, b:3.0]</pre>
*
* @param self this Map
* @param other the Map being compared to
* @return <tt>true</tt> if the contents of both maps are identical
* @since 1.8.0
*/
public static boolean equals(Map self, Map other) {
if (self == null) {
return other == null;
}
if (other == null) {
return false;
}
if (self == other) {
return true;
}
if (self.size() != other.size()) {
return false;
}
if (!self.keySet().equals(other.keySet())) {
return false;
}
for (Object o : self.entrySet()) {
Map.Entry entry = (Map.Entry) o;
Object key = entry.getKey();
Object value = entry.getValue();
if (!coercedEquals(value, other.get(key))) {
return false;
}
}
return true;
}
/**
* Create a Set composed of the elements of the first Set minus the
* elements of the given Collection.
*
* @param self a Set object
* @param removeMe the items to remove from the Set
* @return the resulting Set
* @since 1.5.0
*/
public static <T> Set<T> minus(Set<T> self, Collection<?> removeMe) {
Comparator comparator = (self instanceof SortedSet) ? ((SortedSet) self).comparator() : null;
final Set<T> ansSet = createSimilarSet(self);
ansSet.addAll(self);
if (removeMe != null) {
for (T o1 : self) {
for (Object o2 : removeMe) {
boolean areEqual = (comparator != null) ? (comparator.compare(o1, o2) == 0) : coercedEquals(o1, o2);
if (areEqual) {
ansSet.remove(o1);
}
}
}
}
return ansSet;
}
/**
* Create a Set composed of the elements of the first Set minus the
* elements from the given Iterable.
*
* @param self a Set object
* @param removeMe the items to remove from the Set
* @return the resulting Set
* @since 1.8.7
*/
public static <T> Set<T> minus(Set<T> self, Iterable<?> removeMe) {
return minus(self, asCollection(removeMe));
}
/**
* Create a Set composed of the elements of the first Set minus the given element.
*
* @param self a Set object
* @param removeMe the element to remove from the Set
* @return the resulting Set
* @since 1.5.0
*/
public static <T> Set<T> minus(Set<T> self, Object removeMe) {
Comparator comparator = (self instanceof SortedSet) ? ((SortedSet) self).comparator() : null;
final Set<T> ansSet = createSimilarSet(self);
for (T t : self) {
boolean areEqual = (comparator != null)? (comparator.compare(t, removeMe) == 0) : coercedEquals(t, removeMe);
if (!areEqual) ansSet.add(t);
}
return ansSet;
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the
* elements of the given Collection.
*
* @param self a SortedSet object
* @param removeMe the items to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Collection<?> removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the
* elements of the given Iterable.
*
* @param self a SortedSet object
* @param removeMe the items to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Iterable<?> removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create a SortedSet composed of the elements of the first SortedSet minus the given element.
*
* @param self a SortedSet object
* @param removeMe the element to remove from the SortedSet
* @return the resulting SortedSet
* @since 2.4.0
*/
public static <T> SortedSet<T> minus(SortedSet<T> self, Object removeMe) {
return (SortedSet<T>) minus((Set<T>) self, removeMe);
}
/**
* Create an array composed of the elements of the first array minus the
* elements of the given Iterable.
*
* @param self an array
* @param removeMe a Collection of elements to remove
* @return an array with the supplied elements removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Iterable removeMe) {
return (T[]) minus(toList(self), removeMe).toArray();
}
/**
* Create an array composed of the elements of the first array minus the
* elements of the given array.
*
* @param self an array
* @param removeMe an array of elements to remove
* @return an array with the supplied elements removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Object[] removeMe) {
return (T[]) minus(toList(self), toList(removeMe)).toArray();
}
/**
* Create a List composed of the elements of the first list minus
* every occurrence of elements of the given Collection.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a List
* @param removeMe a Collection of elements to remove
* @return a List with the given elements removed
* @since 1.0
*/
public static <T> List<T> minus(List<T> self, Collection<?> removeMe) {
return (List<T>) minus((Collection<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Collection minus
* every occurrence of elements of the given Collection.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a Collection
* @param removeMe a Collection of elements to remove
* @return a Collection with the given elements removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Collection<T> self, Collection<?> removeMe) {
Collection<T> ansCollection = createSimilarCollection(self);
if (self.isEmpty())
return ansCollection;
T head = self.iterator().next();
boolean nlgnSort = sameType(new Collection[]{self, removeMe});
// We can't use the same tactic as for intersection
// since AbstractCollection only does a remove on the first
// element it encounters.
Comparator<T> numberComparator = new NumberAwareComparator<T>();
if (nlgnSort && (head instanceof Comparable)) {
//n*LOG(n) version
Set<T> answer;
if (head instanceof Number) {
answer = new TreeSet<T>(numberComparator);
answer.addAll(self);
for (T t : self) {
if (t instanceof Number) {
for (Object t2 : removeMe) {
if (t2 instanceof Number) {
if (numberComparator.compare(t, (T) t2) == 0)
answer.remove(t);
}
}
} else {
if (removeMe.contains(t))
answer.remove(t);
}
}
} else {
answer = new TreeSet<T>(numberComparator);
answer.addAll(self);
answer.removeAll(removeMe);
}
for (T o : self) {
if (answer.contains(o))
ansCollection.add(o);
}
} else {
//n*n version
List<T> tmpAnswer = new LinkedList<T>(self);
for (Iterator<T> iter = tmpAnswer.iterator(); iter.hasNext();) {
T element = iter.next();
boolean elementRemoved = false;
for (Iterator<?> iterator = removeMe.iterator(); iterator.hasNext() && !elementRemoved;) {
Object elt = iterator.next();
if (DefaultTypeTransformation.compareEqual(element, elt)) {
iter.remove();
elementRemoved = true;
}
}
}
//remove duplicates
//can't use treeset since the base classes are different
ansCollection.addAll(tmpAnswer);
}
return ansCollection;
}
/**
* Create a new List composed of the elements of the first List minus
* every occurrence of elements of the given Iterable.
* <pre class="groovyTestCase">assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]</pre>
*
* @param self a List
* @param removeMe an Iterable of elements to remove
* @return a new List with the given elements removed
* @since 1.8.7
*/
public static <T> List<T> minus(List<T> self, Iterable<?> removeMe) {
return (List<T>) minus((Iterable<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Iterable minus
* every occurrence of elements of the given Iterable.
* <pre class="groovyTestCase">
* assert [1, "a", true, true, false, 5.3] - [true, 5.3] == [1, "a", false]
* </pre>
*
* @param self an Iterable
* @param removeMe an Iterable of elements to remove
* @return a new Collection with the given elements removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Iterable<T> self, Iterable<?> removeMe) {
return minus(asCollection(self), asCollection(removeMe));
}
/**
* Create a new List composed of the elements of the first List minus every occurrence of the
* given element to remove.
* <pre class="groovyTestCase">assert ["a", 5, 5, true] - 5 == ["a", true]</pre>
*
* @param self a List object
* @param removeMe an element to remove from the List
* @return the resulting List with the given element removed
* @since 1.0
*/
public static <T> List<T> minus(List<T> self, Object removeMe) {
return (List<T>) minus((Iterable<T>) self, removeMe);
}
/**
* Create a new Collection composed of the elements of the first Iterable minus every occurrence of the
* given element to remove.
* <pre class="groovyTestCase">assert ["a", 5, 5, true] - 5 == ["a", true]</pre>
*
* @param self an Iterable object
* @param removeMe an element to remove from the Iterable
* @return the resulting Collection with the given element removed
* @since 2.4.0
*/
public static <T> Collection<T> minus(Iterable<T> self, Object removeMe) {
Collection<T> ansList = createSimilarCollection(self);
for (T t : self) {
if (!coercedEquals(t, removeMe)) ansList.add(t);
}
return ansList;
}
/**
* Create a new object array composed of the elements of the first array
* minus the element to remove.
*
* @param self an array
* @param removeMe an element to remove from the array
* @return a new array with the operand removed
* @since 1.5.5
*/
@SuppressWarnings("unchecked")
public static <T> T[] minus(T[] self, Object removeMe) {
return (T[]) minus((Iterable<T>) toList(self), removeMe).toArray();
}
/**
* Create a Map composed of the entries of the first map minus the
* entries of the given map.
*
* @param self a map object
* @param removeMe the entries to remove from the map
* @return the resulting map
* @since 1.7.4
*/
public static <K,V> Map<K,V> minus(Map<K,V> self, Map removeMe) {
final Map<K,V> ansMap = createSimilarMap(self);
ansMap.putAll(self);
if (removeMe != null && !removeMe.isEmpty()) {
for (Map.Entry<K, V> e1 : self.entrySet()) {
for (Object e2 : removeMe.entrySet()) {
if (DefaultTypeTransformation.compareEqual(e1, e2)) {
ansMap.remove(e1.getKey());
}
}
}
}
return ansMap;
}
/**
* Flatten a Collection. This Collection and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self a Collection to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection<?> flatten(Collection<?> self) {
return flatten(self, createSimilarCollection(self));
}
/**
* Flatten an Iterable. This Iterable and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self an Iterable to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection<?> flatten(Iterable<?> self) {
return flatten(self, createSimilarCollection(self));
}
/**
* Flatten a List. This List and any nested arrays or
* collections have their contents (recursively) added to the new List.
* <pre class="groovyTestCase">assert [1,2,3,4,5] == [1,[2,3],[[4]],[],5].flatten()</pre>
*
* @param self a List to flatten
* @return a flattened List
* @since 2.4.0
*/
public static List<?> flatten(List<?> self) {
return (List<?>) flatten((Collection<?>) self);
}
/**
* Flatten a Set. This Set and any nested arrays or
* collections have their contents (recursively) added to the new Set.
* <pre class="groovyTestCase">assert [1,2,3,4,5] as Set == ([1,[2,3],[[4]],[],5] as Set).flatten()</pre>
*
* @param self a Set to flatten
* @return a flattened Set
* @since 2.4.0
*/
public static Set<?> flatten(Set<?> self) {
return (Set<?>) flatten((Collection<?>) self);
}
/**
* Flatten a SortedSet. This SortedSet and any nested arrays or
* collections have their contents (recursively) added to the new SortedSet.
* <pre class="groovyTestCase">
* Set nested = [[0,1],[2],3,[4],5]
* SortedSet sorted = new TreeSet({ a, b {@code ->} (a instanceof List ? a[0] : a) {@code <=>} (b instanceof List ? b[0] : b) } as Comparator)
* sorted.addAll(nested)
* assert [0,1,2,3,4,5] as SortedSet == sorted.flatten()
* </pre>
*
* @param self a SortedSet to flatten
* @return a flattened SortedSet
* @since 2.4.0
*/
public static SortedSet<?> flatten(SortedSet<?> self) {
return (SortedSet<?>) flatten((Collection<?>) self);
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self an Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(Object[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a boolean Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(boolean[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a byte Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(byte[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a char Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(char[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a short Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(short[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self an int Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(int[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a long Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(long[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a float Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(float[] self) {
return flatten(toList(self), new ArrayList());
}
/**
* Flatten an array. This array and any nested arrays or
* collections have their contents (recursively) added to the new collection.
*
* @param self a double Array to flatten
* @return a flattened Collection
* @since 1.6.0
*/
public static Collection flatten(double[] self) {
return flatten(toList(self), new ArrayList());
}
private static Collection flatten(Iterable elements, Collection addTo) {
for (Object element : elements) {
if (element instanceof Collection) {
flatten((Collection) element, addTo);
} else if (element != null && element.getClass().isArray()) {
flatten(DefaultTypeTransformation.arrayAsCollection(element), addTo);
} else {
// found a leaf
addTo.add(element);
}
}
return addTo;
}
/**
* @deprecated Use the Iterable version of flatten instead
* @see #flatten(Iterable, Closure)
* @since 1.6.0
*/
@Deprecated
public static <T> Collection<T> flatten(Collection<T> self, Closure<? extends T> flattenUsing) {
return flatten(self, createSimilarCollection(self), flattenUsing);
}
/**
* Flatten an Iterable. This Iterable and any nested arrays or
* collections have their contents (recursively) added to the new collection.
* For any non-Array, non-Collection object which represents some sort
* of collective type, the supplied closure should yield the contained items;
* otherwise, the closure should just return any element which corresponds to a leaf.
*
* @param self an Iterable
* @param flattenUsing a closure to determine how to flatten non-Array, non-Collection elements
* @return a flattened Collection
* @since 1.6.0
*/
public static <T> Collection<T> flatten(Iterable<T> self, Closure<? extends T> flattenUsing) {
return flatten(self, createSimilarCollection(self), flattenUsing);
}
private static <T> Collection<T> flatten(Iterable elements, Collection<T> addTo, Closure<? extends T> flattenUsing) {
for (Object element : elements) {
if (element instanceof Collection) {
flatten((Collection) element, addTo, flattenUsing);
} else if (element != null && element.getClass().isArray()) {
flatten(DefaultTypeTransformation.arrayAsCollection(element), addTo, flattenUsing);
} else {
T flattened = flattenUsing.call(new Object[]{element});
boolean returnedSelf = flattened == element;
if (!returnedSelf && flattened instanceof Collection) {
List<?> list = toList((Iterable<?>) flattened);
if (list.size() == 1 && list.get(0) == element) {
returnedSelf = true;
}
}
if (flattened instanceof Collection && !returnedSelf) {
flatten((Collection) flattened, addTo, flattenUsing);
} else {
addTo.add(flattened);
}
}
}
return addTo;
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a Collection.
* <pre class="groovyTestCase">def list = [1,2]
* list << 3
* assert list == [1,2,3]</pre>
*
* @param self a Collection
* @param value an Object to be added to the collection.
* @return same collection, after the value was added to it.
* @since 1.0
*/
public static <T> Collection<T> leftShift(Collection<T> self, T value) {
self.add(value);
return self;
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a List.
* <pre class="groovyTestCase">def list = [1,2]
* list << 3
* assert list == [1,2,3]</pre>
*
* @param self a List
* @param value an Object to be added to the List.
* @return same List, after the value was added to it.
* @since 2.4.0
*/
public static <T> List<T> leftShift(List<T> self, T value) {
return (List<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a Set.
* <pre class="groovyTestCase">def set = [1,2] as Set
* set << 3
* assert set == [1,2,3] as Set</pre>
*
* @param self a Set
* @param value an Object to be added to the Set.
* @return same Set, after the value was added to it.
* @since 2.4.0
*/
public static <T> Set<T> leftShift(Set<T> self, T value) {
return (Set<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a SortedSet.
* <pre class="groovyTestCase">def set = [1,2] as SortedSet
* set << 3
* assert set == [1,2,3] as SortedSet</pre>
*
* @param self a SortedSet
* @param value an Object to be added to the SortedSet.
* @return same SortedSet, after the value was added to it.
* @since 2.4.0
*/
public static <T> SortedSet<T> leftShift(SortedSet<T> self, T value) {
return (SortedSet<T>) leftShift((Collection<T>) self, value);
}
/**
* Overloads the left shift operator to provide an easy way to append
* objects to a BlockingQueue.
* In case of bounded queue the method will block till space in the queue become available
* <pre class="groovyTestCase">def list = new java.util.concurrent.LinkedBlockingQueue ()
* list << 3 << 2 << 1
* assert list.iterator().collect{it} == [3,2,1]</pre>
*
* @param self a Collection
* @param value an Object to be added to the collection.
* @return same collection, after the value was added to it.
* @since 1.7.1
*/
public static <T> BlockingQueue<T> leftShift(BlockingQueue<T> self, T value) throws InterruptedException {
self.put(value);
return self;
}
/**
* Overloads the left shift operator to provide an easy way to append
* Map.Entry values to a Map.
*
* @param self a Map
* @param entry a Map.Entry to be added to the Map.
* @return same map, after the value has been added to it.
* @since 1.6.0
*/
public static <K, V> Map<K, V> leftShift(Map<K, V> self, Map.Entry<K, V> entry) {
self.put(entry.getKey(), entry.getValue());
return self;
}
/**
* Overloads the left shift operator to provide an easy way to put
* one maps entries into another map. This allows the compact syntax
* <code>map1 << map2</code>; otherwise it's just a synonym for
* <code>putAll</code> though it returns the original map rather than
* being a <code>void</code> method. Example usage:
* <pre class="groovyTestCase">def map = [a:1, b:2]
* map << [c:3, d:4]
* assert map == [a:1, b:2, c:3, d:4]</pre>
*
* @param self a Map
* @param other another Map whose entries should be added to the original Map.
* @return same map, after the values have been added to it.
* @since 1.7.2
*/
public static <K, V> Map<K, V> leftShift(Map<K, V> self, Map<K, V> other) {
self.putAll(other);
return self;
}
/**
* Implementation of the left shift operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to left shift the number
* @return the resulting number
* @since 1.5.0
*/
public static Number leftShift(Number self, Number operand) {
return NumberMath.leftShift(self, operand);
}
/**
* Implementation of the right shift operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to right shift the number
* @return the resulting number
* @since 1.5.0
*/
public static Number rightShift(Number self, Number operand) {
return NumberMath.rightShift(self, operand);
}
/**
* Implementation of the right shift (unsigned) operator for integral types. Non integral
* Number types throw UnsupportedOperationException.
*
* @param self a Number object
* @param operand the shift distance by which to right shift (unsigned) the number
* @return the resulting number
* @since 1.5.0
*/
public static Number rightShiftUnsigned(Number self, Number operand) {
return NumberMath.rightShiftUnsigned(self, operand);
}
// Primitive type array methods
//-------------------------------------------------------------------------
/**
* Support the subscript operator with a range for a byte array
*
* @param array a byte array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a char array
*
* @param array a char array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.5.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a short array
*
* @param array a short array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for an int array
*
* @param array an int array
* @param range a range indicating the indices for the items to retrieve
* @return list of the ints at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a long array
*
* @param array a long array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a float array
*
* @param array a float array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a double array
*
* @param array a double array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a range for a boolean array
*
* @param array a boolean array
* @param range a range indicating the indices for the items to retrieve
* @return list of the retrieved booleans
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, Range range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an IntRange for a byte array
*
* @param array a byte array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Byte> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a char array
*
* @param array a char array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Character> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a short array
*
* @param array a short array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Short> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for an int array
*
* @param array an int array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved ints
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Integer> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a long array
*
* @param array a long array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Long> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a float array
*
* @param array a float array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Float> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a double array
*
* @param array a double array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Double> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an IntRange for a boolean array
*
* @param array a boolean array
* @param range an IntRange indicating the indices for the items to retrieve
* @return list of the retrieved booleans
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, IntRange range) {
RangeInfo info = subListBorders(array.length, range);
List<Boolean> answer = primitiveArrayGet(array, new IntRange(true, info.from, info.to - 1));
return info.reverse ? reverse(answer) : answer;
}
/**
* Support the subscript operator with an ObjectRange for a byte array
*
* @param array a byte array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a char array
*
* @param array a char array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved chars
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a short array
*
* @param array a short array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved shorts
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for an int array
*
* @param array an int array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved ints
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a long array
*
* @param array a long array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved longs
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a float array
*
* @param array a float array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved floats
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a double array
*
* @param array a double array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved doubles
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with an ObjectRange for a byte array
*
* @param array a byte array
* @param range an ObjectRange indicating the indices for the items to retrieve
* @return list of the retrieved bytes
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, ObjectRange range) {
return primitiveArrayGet(array, range);
}
/**
* Support the subscript operator with a collection for a byte array
*
* @param array a byte array
* @param indices a collection of indices for the items to retrieve
* @return list of the bytes at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> getAt(byte[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a char array
*
* @param array a char array
* @param indices a collection of indices for the items to retrieve
* @return list of the chars at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> getAt(char[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a short array
*
* @param array a short array
* @param indices a collection of indices for the items to retrieve
* @return list of the shorts at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> getAt(short[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for an int array
*
* @param array an int array
* @param indices a collection of indices for the items to retrieve
* @return list of the ints at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> getAt(int[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a long array
*
* @param array a long array
* @param indices a collection of indices for the items to retrieve
* @return list of the longs at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> getAt(long[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a float array
*
* @param array a float array
* @param indices a collection of indices for the items to retrieve
* @return list of the floats at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> getAt(float[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a double array
*
* @param array a double array
* @param indices a collection of indices for the items to retrieve
* @return list of the doubles at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> getAt(double[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator with a collection for a boolean array
*
* @param array a boolean array
* @param indices a collection of indices for the items to retrieve
* @return list of the booleans at the given indices
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> getAt(boolean[] array, Collection indices) {
return primitiveArrayGet(array, indices);
}
/**
* Support the subscript operator for a Bitset
*
* @param self a BitSet
* @param index index to retrieve
* @return value of the bit at the given index
* @see java.util.BitSet
* @since 1.5.0
*/
public static boolean getAt(BitSet self, int index) {
int i = normaliseIndex(index, self.length());
return self.get(i);
}
/**
* Support retrieving a subset of a BitSet using a Range
*
* @param self a BitSet
* @param range a Range defining the desired subset
* @return a new BitSet that represents the requested subset
* @see java.util.BitSet
* @see groovy.lang.IntRange
* @since 1.5.0
*/
public static BitSet getAt(BitSet self, IntRange range) {
RangeInfo info = subListBorders(self.length(), range);
BitSet result = new BitSet();
int numberOfBits = info.to - info.from;
int adjuster = 1;
int offset = info.from;
if (info.reverse) {
adjuster = -1;
offset = info.to - 1;
}
for (int i = 0; i < numberOfBits; i++) {
result.set(i, self.get(offset + (adjuster * i)));
}
return result;
}
// public static Boolean putAt(boolean[] array, int idx, Boolean newValue) {
// return (Boolean) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Byte putAt(byte[] array, int idx, Object newValue) {
// if (!(newValue instanceof Byte)) {
// Number n = (Number) newValue;
// newValue = new Byte(n.byteValue());
// }
// return (Byte) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Character putAt(char[] array, int idx, Object newValue) {
// if (newValue instanceof String) {
// String s = (String) newValue;
// if (s.length() != 1) throw new IllegalArgumentException("String of length 1 expected but got a bigger one");
// char c = s.charAt(0);
// newValue = new Character(c);
// }
// return (Character) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Short putAt(short[] array, int idx, Object newValue) {
// if (!(newValue instanceof Short)) {
// Number n = (Number) newValue;
// newValue = new Short(n.shortValue());
// }
// return (Short) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Integer putAt(int[] array, int idx, Object newValue) {
// if (!(newValue instanceof Integer)) {
// Number n = (Number) newValue;
// newValue = Integer.valueOf(n.intValue());
// }
// array [normaliseIndex(idx,array.length)] = ((Integer)newValue).intValue();
// return (Integer) newValue;
// }
//
// public static Long putAt(long[] array, int idx, Object newValue) {
// if (!(newValue instanceof Long)) {
// Number n = (Number) newValue;
// newValue = new Long(n.longValue());
// }
// return (Long) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Float putAt(float[] array, int idx, Object newValue) {
// if (!(newValue instanceof Float)) {
// Number n = (Number) newValue;
// newValue = new Float(n.floatValue());
// }
// return (Float) primitiveArrayPut(array, idx, newValue);
// }
//
// public static Double putAt(double[] array, int idx, Object newValue) {
// if (!(newValue instanceof Double)) {
// Number n = (Number) newValue;
// newValue = new Double(n.doubleValue());
// }
// return (Double) primitiveArrayPut(array, idx, newValue);
// }
/**
* Support assigning a range of values with a single assignment statement.
*
* @param self a BitSet
* @param range the range of values to set
* @param value value
* @see java.util.BitSet
* @see groovy.lang.Range
* @since 1.5.0
*/
public static void putAt(BitSet self, IntRange range, boolean value) {
RangeInfo info = subListBorders(self.length(), range);
self.set(info.from, info.to, value);
}
/**
* Support subscript-style assignment for a BitSet.
*
* @param self a BitSet
* @param index index of the entry to set
* @param value value
* @see java.util.BitSet
* @since 1.5.0
*/
public static void putAt(BitSet self, int index, boolean value) {
self.set(index, value);
}
/**
* Allows arrays to behave similar to collections.
* @param array a boolean array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.5.0
*/
public static int size(boolean[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a byte array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(byte[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a char array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(char[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a short array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(short[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array an int array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(int[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a long array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(long[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a float array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(float[] array) {
return Array.getLength(array);
}
/**
* Allows arrays to behave similar to collections.
* @param array a double array
* @return the length of the array
* @see java.lang.reflect.Array#getLength(java.lang.Object)
* @since 1.0
*/
public static int size(double[] array) {
return Array.getLength(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a byte array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Byte> toList(byte[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a boolean array
* @return a list containing the contents of this array.
* @since 1.6.0
*/
@SuppressWarnings("unchecked")
public static List<Boolean> toList(boolean[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a char array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Character> toList(char[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a short array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Short> toList(short[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array an int array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Integer> toList(int[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a long array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Long> toList(long[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a float array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Float> toList(float[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a List of the same size, with each element
* added to the list.
*
* @param array a double array
* @return a list containing the contents of this array.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static List<Double> toList(double[] array) {
return DefaultTypeTransformation.primitiveArrayToList(array);
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a byte array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Byte> toSet(byte[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a boolean array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Boolean> toSet(boolean[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a char array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Character> toSet(char[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a short array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Short> toSet(short[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array an int array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Integer> toSet(int[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a long array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Long> toSet(long[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a float array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Float> toSet(float[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Converts this array to a Set, with each unique element
* added to the set.
*
* @param array a double array
* @return a set containing the unique contents of this array.
* @since 1.8.0
*/
@SuppressWarnings("unchecked")
public static Set<Double> toSet(double[] array) {
return toSet(DefaultTypeTransformation.primitiveArrayToList(array));
}
/**
* Convert a Collection to a Set. Always returns a new Set
* even if the Collection is already a Set.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [1, 2, 2, 2, 3].toSet()
* assert result instanceof Set
* assert result == [1, 2, 3] as Set
* </pre>
*
* @param self a collection
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Collection<T> self) {
Set<T> answer = new HashSet<T>(self.size());
answer.addAll(self);
return answer;
}
/**
* Convert an Iterable to a Set. Always returns a new Set
* even if the Iterable is already a Set.
* <p>
* Example usage:
* <pre class="groovyTestCase">
* def result = [1, 2, 2, 2, 3].toSet()
* assert result instanceof Set
* assert result == [1, 2, 3] as Set
* </pre>
*
* @param self an Iterable
* @return a Set
* @since 2.4.0
*/
public static <T> Set<T> toSet(Iterable<T> self) {
return toSet(self.iterator());
}
/**
* Convert an iterator to a Set. The iterator will become
* exhausted of elements after making this conversion.
*
* @param self an iterator
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Iterator<T> self) {
Set<T> answer = new HashSet<T>();
while (self.hasNext()) {
answer.add(self.next());
}
return answer;
}
/**
* Convert an enumeration to a Set.
*
* @param self an enumeration
* @return a Set
* @since 1.8.0
*/
public static <T> Set<T> toSet(Enumeration<T> self) {
Set<T> answer = new HashSet<T>();
while (self.hasMoreElements()) {
answer.add(self.nextElement());
}
return answer;
}
/**
* Implements the getAt(int) method for primitive type arrays.
*
* @param self an array object
* @param idx the index of interest
* @return the returned value from the array
* @since 1.5.0
*/
protected static Object primitiveArrayGet(Object self, int idx) {
return Array.get(self, normaliseIndex(idx, Array.getLength(self)));
}
/**
* Implements the getAt(Range) method for primitive type arrays.
*
* @param self an array object
* @param range the range of indices of interest
* @return the returned values from the array corresponding to the range
* @since 1.5.0
*/
protected static List primitiveArrayGet(Object self, Range range) {
List answer = new ArrayList();
for (Object next : range) {
int idx = DefaultTypeTransformation.intUnbox(next);
answer.add(primitiveArrayGet(self, idx));
}
return answer;
}
/**
* Implements the getAt(Collection) method for primitive type arrays. Each
* value in the collection argument is assumed to be a valid array index.
* The value at each index is then added to a list which is returned.
*
* @param self an array object
* @param indices the indices of interest
* @return the returned values from the array
* @since 1.0
*/
protected static List primitiveArrayGet(Object self, Collection indices) {
List answer = new ArrayList();
for (Object value : indices) {
if (value instanceof Range) {
answer.addAll(primitiveArrayGet(self, (Range) value));
} else if (value instanceof List) {
answer.addAll(primitiveArrayGet(self, (List) value));
} else {
int idx = DefaultTypeTransformation.intUnbox(value);
answer.add(primitiveArrayGet(self, idx));
}
}
return answer;
}
/**
* Implements the setAt(int idx) method for primitive type arrays.
*
* @param self an object
* @param idx the index of interest
* @param newValue the new value to be put into the index of interest
* @return the added value
* @since 1.5.0
*/
protected static Object primitiveArrayPut(Object self, int idx, Object newValue) {
Array.set(self, normaliseIndex(idx, Array.getLength(self)), newValue);
return newValue;
}
/**
* Identity conversion which returns Boolean.TRUE for a true Boolean and Boolean.FALSE for a false Boolean.
*
* @param self a Boolean
* @return the original Boolean
* @since 1.7.6
*/
public static Boolean toBoolean(Boolean self) {
return self;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(int[] self, Object value) {
for (int next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(long[] self, Object value) {
for (long next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(short[] self, Object value) {
for (short next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(char[] self, Object value) {
for (char next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array within which we count the number of occurrences
* @param value the value being searched for
* @return the number of occurrences
* @since 1.8.6
*/
public static boolean contains(boolean[] self, Object value) {
for (boolean next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(double[] self, Object value) {
for (double next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(float[] self, Object value) {
for (float next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(byte[] self, Object value) {
for (byte next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Checks whether the array contains the given value.
*
* @param self the array we are searching
* @param value the value being searched for
* @return true if the array contains the value
* @since 1.8.6
*/
public static boolean contains(Object[] self, Object value) {
for (Object next : self) {
if (DefaultTypeTransformation.compareEqual(value, next)) return true;
}
return false;
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(boolean[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(byte[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(char[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(short[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(int[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(long[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(float[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given array.
*
* @param self an array
* @return the string representation
* @since 1.6.0
*/
public static String toString(double[] self) {
return InvokerHelper.toString(self);
}
/**
* Returns the string representation of the given map.
*
* @param self a Map
* @return the string representation
* @see #toMapString(java.util.Map)
* @since 1.0
*/
public static String toString(AbstractMap self) {
return toMapString(self);
}
/**
* Returns the string representation of this map. The string displays the
* contents of the map, i.e. <code>[one:1, two:2, three:3]</code>.
*
* @param self a Map
* @return the string representation
* @since 1.0
*/
public static String toMapString(Map self) {
return toMapString(self, -1);
}
/**
* Returns the string representation of this map. The string displays the
* contents of the map, i.e. <code>[one:1, two:2, three:3]</code>.
*
* @param self a Map
* @param maxSize stop after approximately this many characters and append '...'
* @return the string representation
* @since 1.0
*/
public static String toMapString(Map self, int maxSize) {
return (self == null) ? "null" : InvokerHelper.toMapString(self, maxSize);
}
/**
* Returns the string representation of the given collection. The string
* displays the contents of the collection, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @return the string representation
* @see #toListString(java.util.Collection)
* @since 1.0
*/
public static String toString(AbstractCollection self) {
return toListString(self);
}
/**
* Returns the string representation of the given list. The string
* displays the contents of the list, similar to a list literal, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @return the string representation
* @since 1.0
*/
public static String toListString(Collection self) {
return toListString(self, -1);
}
/**
* Returns the string representation of the given list. The string
* displays the contents of the list, similar to a list literal, i.e.
* <code>[1, 2, a]</code>.
*
* @param self a Collection
* @param maxSize stop after approximately this many characters and append '...'
* @return the string representation
* @since 1.7.3
*/
public static String toListString(Collection self, int maxSize) {
return (self == null) ? "null" : InvokerHelper.toListString(self, maxSize);
}
/**
* Returns the string representation of this array's contents.
*
* @param self an Object[]
* @return the string representation
* @see #toArrayString(java.lang.Object[])
* @since 1.0
*/
public static String toString(Object[] self) {
return toArrayString(self);
}
/**
* Returns the string representation of the given array. The string
* displays the contents of the array, similar to an array literal, i.e.
* <code>{1, 2, "a"}</code>.
*
* @param self an Object[]
* @return the string representation
* @since 1.0
*/
public static String toArrayString(Object[] self) {
return (self == null) ? "null" : InvokerHelper.toArrayString(self);
}
/**
* Create a String representation of this object.
* @param value an object
* @return a string.
* @since 1.0
*/
public static String toString(Object value) {
return InvokerHelper.toString(value);
}
// Number based methods
//-------------------------------------------------------------------------
/**
* Increment a Character by one.
*
* @param self a Character
* @return an incremented Character
* @since 1.5.7
*/
public static Character next(Character self) {
return (char) (self + 1);
}
/**
* Increment a Number by one.
*
* @param self a Number
* @return an incremented Number
* @since 1.0
*/
public static Number next(Number self) {
return NumberNumberPlus.plus(self, ONE);
}
/**
* Decrement a Character by one.
*
* @param self a Character
* @return a decremented Character
* @since 1.5.7
*/
public static Character previous(Character self) {
return (char) (self - 1);
}
/**
* Decrement a Number by one.
*
* @param self a Number
* @return a decremented Number
* @since 1.0
*/
public static Number previous(Number self) {
return NumberNumberMinus.minus(self, ONE);
}
/**
* Add a Character and a Number. The ordinal value of the Character
* is used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @see java.lang.Integer#valueOf(int)
* @param left a Character
* @param right a Number
* @return the Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Character left, Number right) {
return NumberNumberPlus.plus(Integer.valueOf(left), right);
}
/**
* Add a Number and a Character. The ordinal value of the Character
* is used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @see java.lang.Integer#valueOf(int)
* @param left a Number
* @param right a Character
* @return The Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Number left, Character right) {
return NumberNumberPlus.plus(left, Integer.valueOf(right));
}
/**
* Add one Character to another. The ordinal values of the Characters
* are used in the addition (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
* This operation will always create a new object for the result,
* while the operands remain unchanged.
*
* @see #plus(java.lang.Number, java.lang.Character)
* @param left a Character
* @param right a Character
* @return the Number corresponding to the addition of left and right
* @since 1.0
*/
public static Number plus(Character left, Character right) {
return plus(Integer.valueOf(left), right);
}
/**
* Compare a Character and a Number. The ordinal value of the Character
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Character left, Number right) {
return compareTo(Integer.valueOf(left), right);
}
/**
* Compare a Number and a Character. The ordinal value of the Character
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Number left, Character right) {
return compareTo(left, Integer.valueOf(right));
}
/**
* Compare two Characters. The ordinal values of the Characters
* are compared (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Character
* @return the result of the comparison
* @since 1.0
*/
public static int compareTo(Character left, Character right) {
return compareTo(Integer.valueOf(left), right);
}
/**
* Compare two Numbers. Equality (==) for numbers dispatches to this.
*
* @param left a Number
* @param right another Number to compare to
* @return the comparison of both numbers
* @since 1.0
*/
public static int compareTo(Number left, Number right) {
/** @todo maybe a double dispatch thing to handle new large numbers? */
return NumberMath.compareTo(left, right);
}
/**
* Subtract a Number from a Character. The ordinal value of the Character
* is used in the subtraction (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Character left, Number right) {
return NumberNumberMinus.minus(Integer.valueOf(left), right);
}
/**
* Subtract a Character from a Number. The ordinal value of the Character
* is used in the subtraction (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Number left, Character right) {
return NumberNumberMinus.minus(left, Integer.valueOf(right));
}
/**
* Subtract one Character from another. The ordinal values of the Characters
* is used in the comparison (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Character
* @return the Number corresponding to the subtraction of right from left
* @since 1.0
*/
public static Number minus(Character left, Character right) {
return minus(Integer.valueOf(left), right);
}
/**
* Multiply a Character by a Number. The ordinal value of the Character
* is used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Character left, Number right) {
return NumberNumberMultiply.multiply(Integer.valueOf(left), right);
}
/**
* Multiply a Number by a Character. The ordinal value of the Character
* is used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Number left, Character right) {
return NumberNumberMultiply.multiply(Integer.valueOf(right), left);
}
/**
* Multiply two Characters. The ordinal values of the Characters
* are used in the multiplication (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return the Number corresponding to the multiplication of left by right
* @since 1.0
*/
public static Number multiply(Character left, Character right) {
return multiply(Integer.valueOf(left), right);
}
/**
* Multiply a BigDecimal and a Double.
* Note: This method was added to enforce the Groovy rule of
* BigDecimal*Double == Double. Without this method, the
* multiply(BigDecimal) method in BigDecimal would respond
* and return a BigDecimal instead. Since BigDecimal is preferred
* over Number, the Number*Number method is not chosen as in older
* versions of Groovy.
*
* @param left a BigDecimal
* @param right a Double
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(BigDecimal left, Double right) {
return NumberMath.multiply(left, right);
}
/**
* Multiply a BigDecimal and a BigInteger.
* Note: This method was added to enforce the Groovy rule of
* BigDecimal*long == long. Without this method, the
* multiply(BigDecimal) method in BigDecimal would respond
* and return a BigDecimal instead. Since BigDecimal is preferred
* over Number, the Number*Number method is not chosen as in older
* versions of Groovy. BigInteger is the fallback for all integer
* types in Groovy
*
* @param left a BigDecimal
* @param right a BigInteger
* @return the multiplication of left by right
* @since 1.0
*/
public static Number multiply(BigDecimal left, BigInteger right) {
return NumberMath.multiply(left, right);
}
/**
* Compare a BigDecimal to another.
* A fluent api style alias for {@code compareTo}.
*
* @param left a BigDecimal
* @param right a BigDecimal
* @return true if left is equal to or bigger than right
* @since 3.0.1
*/
public static Boolean isAtLeast(BigDecimal left, BigDecimal right) {
return left.compareTo(right) >= 0;
}
/**
* Compare a BigDecimal to a String representing a number.
* A fluent api style alias for {@code compareTo}.
*
* @param left a BigDecimal
* @param right a String representing a number
* @return true if left is equal to or bigger than the value represented by right
* @since 3.0.1
*/
public static Boolean isAtLeast(BigDecimal left, String right) {
return isAtLeast(left, new BigDecimal(right));
}
/**
* Power of a Number to a certain exponent. Called by the '**' operator.
*
* @param self a Number
* @param exponent a Number exponent
* @return a Number to the power of a certain exponent
* @since 1.0
*/
public static Number power(Number self, Number exponent) {
double base, exp, answer;
base = self.doubleValue();
exp = exponent.doubleValue();
answer = Math.pow(base, exp);
if ((double) ((int) answer) == answer) {
return (int) answer;
} else if ((double) ((long) answer) == answer) {
return (long) answer;
} else {
return answer;
}
}
/**
* Power of a BigDecimal to an integer certain exponent. If the
* exponent is positive, call the BigDecimal.pow(int) method to
* maintain precision. Called by the '**' operator.
*
* @param self a BigDecimal
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(BigDecimal self, Integer exponent) {
if (exponent >= 0) {
return self.pow(exponent);
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a BigInteger to an integer certain exponent. If the
* exponent is positive, call the BigInteger.pow(int) method to
* maintain precision. Called by the '**' operator.
*
* @param self a BigInteger
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(BigInteger self, Integer exponent) {
if (exponent >= 0) {
return self.pow(exponent);
} else {
return power(self, (double) exponent);
}
}
/**
* Power of an integer to an integer certain exponent. If the
* exponent is positive, convert to a BigInteger and call
* BigInteger.pow(int) method to maintain precision. Called by the
* '**' operator.
*
* @param self an Integer
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(Integer self, Integer exponent) {
if (exponent >= 0) {
BigInteger answer = BigInteger.valueOf(self).pow(exponent);
if (answer.compareTo(BI_INT_MIN) >= 0 && answer.compareTo(BI_INT_MAX) <= 0) {
return answer.intValue();
} else {
return answer;
}
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a long to an integer certain exponent. If the
* exponent is positive, convert to a BigInteger and call
* BigInteger.pow(int) method to maintain precision. Called by the
* '**' operator.
*
* @param self a Long
* @param exponent an Integer exponent
* @return a Number to the power of a the exponent
*/
public static Number power(Long self, Integer exponent) {
if (exponent >= 0) {
BigInteger answer = BigInteger.valueOf(self).pow(exponent);
if (answer.compareTo(BI_LONG_MIN) >= 0 && answer.compareTo(BI_LONG_MAX) <= 0) {
return answer.longValue();
} else {
return answer;
}
} else {
return power(self, (double) exponent);
}
}
/**
* Power of a BigInteger to a BigInteger certain exponent. Called by the '**' operator.
*
* @param self a BigInteger
* @param exponent a BigInteger exponent
* @return a BigInteger to the power of a the exponent
* @since 2.3.8
*/
public static BigInteger power(BigInteger self, BigInteger exponent) {
if ((exponent.signum() >= 0) && (exponent.compareTo(BI_INT_MAX) <= 0)) {
return self.pow(exponent.intValue());
} else {
return BigDecimal.valueOf(Math.pow(self.doubleValue(), exponent.doubleValue())).toBigInteger();
}
}
/**
* Divide a Character by a Number. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Character left, Number right) {
return NumberNumberDiv.div(Integer.valueOf(left), right);
}
/**
* Divide a Number by a Character. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Number left, Character right) {
return NumberNumberDiv.div(left, Integer.valueOf(right));
}
/**
* Divide one Character by another. The ordinal values of the Characters
* are used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return the Number corresponding to the division of left by right
* @since 1.0
*/
public static Number div(Character left, Character right) {
return div(Integer.valueOf(left), right);
}
/**
* Integer Divide a Character by a Number. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right a Number
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Character left, Number right) {
return intdiv(Integer.valueOf(left), right);
}
/**
* Integer Divide a Number by a Character. The ordinal value of the Character
* is used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Number
* @param right a Character
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Number left, Character right) {
return intdiv(left, Integer.valueOf(right));
}
/**
* Integer Divide two Characters. The ordinal values of the Characters
* are used in the division (the ordinal value is the unicode
* value which for simple character sets is the ASCII value).
*
* @param left a Character
* @param right another Character
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Character left, Character right) {
return intdiv(Integer.valueOf(left), right);
}
/**
* Integer Divide two Numbers.
*
* @param left a Number
* @param right another Number
* @return a Number (an Integer) resulting from the integer division operation
* @since 1.0
*/
public static Number intdiv(Number left, Number right) {
return NumberMath.intdiv(left, right);
}
/**
* Bitwise OR together two numbers.
*
* @param left a Number
* @param right another Number to bitwise OR
* @return the bitwise OR of both Numbers
* @since 1.0
*/
public static Number or(Number left, Number right) {
return NumberMath.or(left, right);
}
/**
* Bitwise AND together two Numbers.
*
* @param left a Number
* @param right another Number to bitwise AND
* @return the bitwise AND of both Numbers
* @since 1.0
*/
public static Number and(Number left, Number right) {
return NumberMath.and(left, right);
}
/**
* Bitwise AND together two BitSets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise AND of both BitSets
* @since 1.5.0
*/
public static BitSet and(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.and(right);
return result;
}
/**
* Bitwise XOR together two BitSets. Called when the '^' operator is used
* between two bit sets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise XOR of both BitSets
* @since 1.5.0
*/
public static BitSet xor(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.xor(right);
return result;
}
/**
* Bitwise NEGATE a BitSet.
*
* @param self a BitSet
* @return the bitwise NEGATE of the BitSet
* @since 1.5.0
*/
public static BitSet bitwiseNegate(BitSet self) {
BitSet result = (BitSet) self.clone();
result.flip(0, result.size() - 1);
return result;
}
/**
* Bitwise NEGATE a Number.
*
* @param left a Number
* @return the bitwise NEGATE of the Number
* @since 2.2.0
*/
public static Number bitwiseNegate(Number left) {
return NumberMath.bitwiseNegate(left);
}
/**
* Bitwise OR together two BitSets. Called when the '|' operator is used
* between two bit sets.
*
* @param left a BitSet
* @param right another BitSet to bitwise AND
* @return the bitwise OR of both BitSets
* @since 1.5.0
*/
public static BitSet or(BitSet left, BitSet right) {
BitSet result = (BitSet) left.clone();
result.or(right);
return result;
}
/**
* Bitwise XOR together two Numbers. Called when the '^' operator is used.
*
* @param left a Number
* @param right another Number to bitwse XOR
* @return the bitwise XOR of both Numbers
* @since 1.0
*/
public static Number xor(Number left, Number right) {
return NumberMath.xor(left, right);
}
/**
* Performs a division modulus operation. Called by the '%' operator.
*
* @param left a Number
* @param right another Number to mod
* @return the modulus result
* @since 1.0
*/
public static Number mod(Number left, Number right) {
return NumberMath.mod(left, right);
}
/**
* Negates the number. Equivalent to the '-' operator when it preceeds
* a single operand, i.e. <code>-10</code>
*
* @param left a Number
* @return the negation of the number
* @since 1.5.0
*/
public static Number unaryMinus(Number left) {
return NumberMath.unaryMinus(left);
}
/**
* Returns the number, effectively being a noop for numbers.
* Operator overloaded form of the '+' operator when it preceeds
* a single operand, i.e. <code>+10</code>
*
* @param left a Number
* @return the number
* @since 2.2.0
*/
public static Number unaryPlus(Number left) {
return NumberMath.unaryPlus(left);
}
/**
* Executes the closure this many times, starting from zero. The current
* index is passed to the closure each time.
* Example:
* <pre>10.times {
* println it
* }</pre>
* Prints the numbers 0 through 9.
*
* @param self a Number
* @param closure the closure to call a number of times
* @since 1.0
*/
public static void times(Number self, @ClosureParams(value=SimpleType.class,options="int") Closure closure) {
for (int i = 0, size = self.intValue(); i < size; i++) {
closure.call(i);
if (closure.getDirective() == Closure.DONE) {
break;
}
}
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Number
* @param to another Number to go up to
* @param closure the closure to call
* @since 1.0
*/
public static void upto(Number self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
int self1 = self.intValue();
int to1 = to.intValue();
if (self1 <= to1) {
for (int i = self1; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self <= to1) {
for (long i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self <= to1) {
for (long i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self <= to1) {
for (float i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self <= to1) {
for (float i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self <= to1) {
for (double i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
*
* @param self a Double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(Double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self <= to1) {
for (double i = self; i <= to1; i++) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time. Example:
* <pre>0.upto( 10 ) {
* println it
* }</pre>
* Prints numbers 0 to 10
*
* @param self a BigInteger
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(BigInteger self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
if (to instanceof BigDecimal) {
final BigDecimal one = BigDecimal.valueOf(10, 1);
BigDecimal self1 = new BigDecimal(self);
BigDecimal to1 = (BigDecimal) to;
if (self1.compareTo(to1) <= 0) {
for (BigDecimal i = self1; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
} else if (to instanceof BigInteger) {
final BigInteger one = BigInteger.valueOf(1);
BigInteger to1 = (BigInteger) to;
if (self.compareTo(to1) <= 0) {
for (BigInteger i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format("The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
} else {
final BigInteger one = BigInteger.valueOf(1);
BigInteger to1 = new BigInteger(to.toString());
if (self.compareTo(to1) <= 0) {
for (BigInteger i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(MessageFormat.format(
"The argument ({0}) to upto() cannot be less than the value ({1}) it''s called on.",
to, self));
}
}
/**
* Iterates from this number up to the given number, inclusive,
* incrementing by one each time.
* <pre>0.1.upto( 10 ) {
* println it
* }</pre>
* Prints numbers 0.1, 1.1, 2.1... to 9.1
*
* @param self a BigDecimal
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void upto(BigDecimal self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // That's what you get for "1.0".
if (to instanceof BigDecimal) {
BigDecimal to1 = (BigDecimal) to;
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
} else if (to instanceof BigInteger) {
BigDecimal to1 = new BigDecimal((BigInteger) to);
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
} else {
BigDecimal to1 = new BigDecimal(to.toString());
if (self.compareTo(to1) <= 0) {
for (BigDecimal i = self; i.compareTo(to1) <= 0; i = i.add(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to upto() cannot be less than the value (" + self + ") it's called on.");
}
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Number
* @param to another Number to go down to
* @param closure the closure to call
* @since 1.0
*/
public static void downto(Number self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
int self1 = self.intValue();
int to1 = to.intValue();
if (self1 >= to1) {
for (int i = self1; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self >= to1) {
for (long i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Long
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Long self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
long to1 = to.longValue();
if (self >= to1) {
for (long i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on.");
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self >= to1) {
for (float i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Float
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Float self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
float to1 = to.floatValue();
if (self >= to1) {
for (float i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self >= to1) {
for (double i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a Double
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(Double self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
double to1 = to.doubleValue();
if (self >= to1) {
for (double i = self; i >= to1; i--) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time.
*
* @param self a BigInteger
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(BigInteger self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
if (to instanceof BigDecimal) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // That's what you get for "1.0".
final BigDecimal to1 = (BigDecimal) to;
final BigDecimal selfD = new BigDecimal(self);
if (selfD.compareTo(to1) >= 0) {
for (BigDecimal i = selfD; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i.toBigInteger());
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
} else if (to instanceof BigInteger) {
final BigInteger one = BigInteger.valueOf(1);
final BigInteger to1 = (BigInteger) to;
if (self.compareTo(to1) >= 0) {
for (BigInteger i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format(
"The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
} else {
final BigInteger one = BigInteger.valueOf(1);
final BigInteger to1 = new BigInteger(to.toString());
if (self.compareTo(to1) >= 0) {
for (BigInteger i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException(
MessageFormat.format("The argument ({0}) to downto() cannot be greater than the value ({1}) it''s called on.",
to, self));
}
}
/**
* Iterates from this number down to the given number, inclusive,
* decrementing by one each time. Each number is passed to the closure.
* Example:
* <pre>
* 10.5.downto(0) {
* println it
* }
* </pre>
* Prints numbers 10.5, 9.5 ... to 0.5.
*
* @param self a BigDecimal
* @param to the end number
* @param closure the code to execute for each number
* @since 1.0
*/
public static void downto(BigDecimal self, Number to, @ClosureParams(FirstParam.class) Closure closure) {
final BigDecimal one = BigDecimal.valueOf(10, 1); // Quick way to get "1.0".
if (to instanceof BigDecimal) {
BigDecimal to1 = (BigDecimal) to;
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); } else if (to instanceof BigInteger) {
BigDecimal to1 = new BigDecimal((BigInteger) to);
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); } else {
BigDecimal to1 = new BigDecimal(to.toString());
if (self.compareTo(to1) >= 0) {
for (BigDecimal i = self; i.compareTo(to1) >= 0; i = i.subtract(one)) {
closure.call(i);
}
} else
throw new GroovyRuntimeException("The argument (" + to +
") to downto() cannot be greater than the value (" + self + ") it's called on."); }
}
/**
* Iterates from this number up to the given number using a step increment.
* Each intermediate number is passed to the given closure. Example:
* <pre>
* 0.step( 10, 2 ) {
* println it
* }
* </pre>
* Prints even numbers 0 through 8.
*
* @param self a Number to start with
* @param to a Number to go up to, exclusive
* @param stepNumber a Number representing the step increment
* @param closure the closure to call
* @since 1.0
*/
public static void step(Number self, Number to, Number stepNumber, Closure closure) {
if (self instanceof BigDecimal || to instanceof BigDecimal || stepNumber instanceof BigDecimal) {
final BigDecimal zero = BigDecimal.valueOf(0, 1); // Same as "0.0".
BigDecimal self1 = (self instanceof BigDecimal) ? (BigDecimal) self : new BigDecimal(self.toString());
BigDecimal to1 = (to instanceof BigDecimal) ? (BigDecimal) to : new BigDecimal(to.toString());
BigDecimal stepNumber1 = (stepNumber instanceof BigDecimal) ? (BigDecimal) stepNumber : new BigDecimal(stepNumber.toString());
if (stepNumber1.compareTo(zero) > 0 && to1.compareTo(self1) > 0) {
for (BigDecimal i = self1; i.compareTo(to1) < 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if (stepNumber1.compareTo(zero) < 0 && to1.compareTo(self1) < 0) {
for (BigDecimal i = self1; i.compareTo(to1) > 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if(self1.compareTo(to1) != 0)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
} else if (self instanceof BigInteger || to instanceof BigInteger || stepNumber instanceof BigInteger) {
final BigInteger zero = BigInteger.valueOf(0);
BigInteger self1 = (self instanceof BigInteger) ? (BigInteger) self : new BigInteger(self.toString());
BigInteger to1 = (to instanceof BigInteger) ? (BigInteger) to : new BigInteger(to.toString());
BigInteger stepNumber1 = (stepNumber instanceof BigInteger) ? (BigInteger) stepNumber : new BigInteger(stepNumber.toString());
if (stepNumber1.compareTo(zero) > 0 && to1.compareTo(self1) > 0) {
for (BigInteger i = self1; i.compareTo(to1) < 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if (stepNumber1.compareTo(zero) < 0 && to1.compareTo(self1) < 0) {
for (BigInteger i = self1; i.compareTo(to1) > 0; i = i.add(stepNumber1)) {
closure.call(i);
}
} else if(self1.compareTo(to1) != 0)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
} else {
int self1 = self.intValue();
int to1 = to.intValue();
int stepNumber1 = stepNumber.intValue();
if (stepNumber1 > 0 && to1 > self1) {
for (int i = self1; i < to1; i += stepNumber1) {
closure.call(i);
}
} else if (stepNumber1 < 0 && to1 < self1) {
for (int i = self1; i > to1; i += stepNumber1) {
closure.call(i);
}
} else if(self1 != to1)
throw new GroovyRuntimeException("Infinite loop in " + self1 + ".step(" + to1 + ", " + stepNumber1 + ")");
}
}
/**
* Get the absolute value
*
* @param number a Number
* @return the absolute value of that Number
* @since 1.0
*/
//Note: This method is NOT called if number is a BigInteger or BigDecimal because
//those classes implement a method with a better exact match.
public static int abs(Number number) {
return Math.abs(number.intValue());
}
/**
* Get the absolute value
*
* @param number a Long
* @return the absolute value of that Long
* @since 1.0
*/
public static long abs(Long number) {
return Math.abs(number);
}
/**
* Get the absolute value
*
* @param number a Float
* @return the absolute value of that Float
* @since 1.0
*/
public static float abs(Float number) {
return Math.abs(number);
}
/**
* Get the absolute value
*
* @param number a Double
* @return the absolute value of that Double
* @since 1.0
*/
public static double abs(Double number) {
return Math.abs(number);
}
/**
* Round the value
*
* @param number a Float
* @return the rounded value of that Float
* @since 1.0
*/
public static int round(Float number) {
return Math.round(number);
}
/**
* Round the value
*
* @param number a Float
* @param precision the number of decimal places to keep
* @return the Float rounded to the number of decimal places specified by precision
* @since 1.6.0
*/
public static float round(Float number, int precision) {
return (float)(Math.floor(number.doubleValue()*Math.pow(10,precision)+0.5)/Math.pow(10,precision));
}
/**
* Truncate the value
*
* @param number a Float
* @param precision the number of decimal places to keep
* @return the Float truncated to the number of decimal places specified by precision
* @since 1.6.0
*/
public static float trunc(Float number, int precision) {
final double p = Math.pow(10, precision);
final double n = number.doubleValue() * p;
if (number < 0f) {
return (float) (Math.ceil(n) / p);
}
return (float) (Math.floor(n) / p);
}
/**
* Truncate the value
*
* @param number a Float
* @return the Float truncated to 0 decimal places
* @since 1.6.0
*/
public static float trunc(Float number) {
if (number < 0f) {
return (float)Math.ceil(number.doubleValue());
}
return (float)Math.floor(number.doubleValue());
}
/**
* Round the value
*
* @param number a Double
* @return the rounded value of that Double
* @since 1.0
*/
public static long round(Double number) {
return Math.round(number);
}
/**
* Round the value
*
* @param number a Double
* @param precision the number of decimal places to keep
* @return the Double rounded to the number of decimal places specified by precision
* @since 1.6.4
*/
public static double round(Double number, int precision) {
return Math.floor(number *Math.pow(10,precision)+0.5)/Math.pow(10,precision);
}
/**
* Truncate the value
*
* @param number a Double
* @return the Double truncated to 0 decimal places
* @since 1.6.4
*/
public static double trunc(Double number) {
if (number < 0d) {
return Math.ceil(number);
}
return Math.floor(number);
}
/**
* Truncate the value
*
* @param number a Double
* @param precision the number of decimal places to keep
* @return the Double truncated to the number of decimal places specified by precision
* @since 1.6.4
*/
public static double trunc(Double number, int precision) {
if (number < 0d) {
return Math.ceil(number *Math.pow(10,precision))/Math.pow(10,precision);
}
return Math.floor(number *Math.pow(10,precision))/Math.pow(10,precision);
}
/**
* Round the value
* <p>
* Note that this method differs from {@link java.math.BigDecimal#round(java.math.MathContext)}
* which specifies the digits to retain starting from the leftmost nonzero
* digit. This methods rounds the integral part to the nearest whole number.
*
* @param number a BigDecimal
* @return the rounded value of that BigDecimal
* @see #round(java.math.BigDecimal, int)
* @see java.math.BigDecimal#round(java.math.MathContext)
* @since 2.5.0
*/
public static BigDecimal round(BigDecimal number) {
return round(number, 0);
}
/**
* Round the value
* <p>
* Note that this method differs from {@link java.math.BigDecimal#round(java.math.MathContext)}
* which specifies the digits to retain starting from the leftmost nonzero
* digit. This method operates on the fractional part of the number and
* the precision argument specifies the number of digits to the right of
* the decimal point to retain.
*
* @param number a BigDecimal
* @param precision the number of decimal places to keep
* @return a BigDecimal rounded to the number of decimal places specified by precision
* @see #round(java.math.BigDecimal)
* @see java.math.BigDecimal#round(java.math.MathContext)
* @since 2.5.0
*/
public static BigDecimal round(BigDecimal number, int precision) {
return number.setScale(precision, RoundingMode.HALF_UP);
}
/**
* Truncate the value
*
* @param number a BigDecimal
* @return a BigDecimal truncated to 0 decimal places
* @see #trunc(java.math.BigDecimal, int)
* @since 2.5.0
*/
public static BigDecimal trunc(BigDecimal number) {
return trunc(number, 0);
}
/**
* Truncate the value
*
* @param number a BigDecimal
* @param precision the number of decimal places to keep
* @return a BigDecimal truncated to the number of decimal places specified by precision
* @see #trunc(java.math.BigDecimal)
* @since 2.5.0
*/
public static BigDecimal trunc(BigDecimal number, int precision) {
return number.setScale(precision, RoundingMode.DOWN);
}
/**
* Determine if a Character is uppercase.
* Synonym for 'Character.isUpperCase(this)'.
*
* @param self a Character
* @return true if the character is uppercase
* @see java.lang.Character#isUpperCase(char)
* @since 1.5.7
*/
public static boolean isUpperCase(Character self) {
return Character.isUpperCase(self);
}
/**
* Determine if a Character is lowercase.
* Synonym for 'Character.isLowerCase(this)'.
*
* @param self a Character
* @return true if the character is lowercase
* @see java.lang.Character#isLowerCase(char)
* @since 1.5.7
*/
public static boolean isLowerCase(Character self) {
return Character.isLowerCase(self);
}
/**
* Determines if a character is a letter.
* Synonym for 'Character.isLetter(this)'.
*
* @param self a Character
* @return true if the character is a letter
* @see java.lang.Character#isLetter(char)
* @since 1.5.7
*/
public static boolean isLetter(Character self) {
return Character.isLetter(self);
}
/**
* Determines if a character is a digit.
* Synonym for 'Character.isDigit(this)'.
*
* @param self a Character
* @return true if the character is a digit
* @see java.lang.Character#isDigit(char)
* @since 1.5.7
*/
public static boolean isDigit(Character self) {
return Character.isDigit(self);
}
/**
* Determines if a character is a letter or digit.
* Synonym for 'Character.isLetterOrDigit(this)'.
*
* @param self a Character
* @return true if the character is a letter or digit
* @see java.lang.Character#isLetterOrDigit(char)
* @since 1.5.7
*/
public static boolean isLetterOrDigit(Character self) {
return Character.isLetterOrDigit(self);
}
/**
* Determines if a character is a whitespace character.
* Synonym for 'Character.isWhitespace(this)'.
*
* @param self a Character
* @return true if the character is a whitespace character
* @see java.lang.Character#isWhitespace(char)
* @since 1.5.7
*/
public static boolean isWhitespace(Character self) {
return Character.isWhitespace(self);
}
/**
* Converts the character to uppercase.
* Synonym for 'Character.toUpperCase(this)'.
*
* @param self a Character to convert
* @return the uppercase equivalent of the character, if any;
* otherwise, the character itself.
* @see java.lang.Character#isUpperCase(char)
* @see java.lang.String#toUpperCase()
* @since 1.5.7
*/
public static char toUpperCase(Character self) {
return Character.toUpperCase(self);
}
/**
* Converts the character to lowercase.
* Synonym for 'Character.toLowerCase(this)'.
*
* @param self a Character to convert
* @return the lowercase equivalent of the character, if any;
* otherwise, the character itself.
* @see java.lang.Character#isLowerCase(char)
* @see java.lang.String#toLowerCase()
* @since 1.5.7
*/
public static char toLowerCase(Character self) {
return Character.toLowerCase(self);
}
/**
* Transform a Number into an Integer
*
* @param self a Number
* @return an Integer
* @since 1.0
*/
public static Integer toInteger(Number self) {
return self.intValue();
}
/**
* Transform a Number into a Long
*
* @param self a Number
* @return a Long
* @since 1.0
*/
public static Long toLong(Number self) {
return self.longValue();
}
/**
* Transform a Number into a Float
*
* @param self a Number
* @return a Float
* @since 1.0
*/
public static Float toFloat(Number self) {
return self.floatValue();
}
/**
* Transform a Number into a Double
*
* @param self a Number
* @return a Double
* @since 1.0
*/
public static Double toDouble(Number self) {
// Conversions in which all decimal digits are known to be good.
if ((self instanceof Double)
|| (self instanceof Long)
|| (self instanceof Integer)
|| (self instanceof Short)
|| (self instanceof Byte))
{
return self.doubleValue();
}
// Chances are this is a Float or a Big.
// With Float we're extending binary precision and that gets ugly in decimal.
// If we used Float.doubleValue() on 0.1f we get 0.10000000149011612.
// Note that this is different than casting '(double) 0.1f' which will do the
// binary extension just like in Java.
// With Bigs and other unknowns, this is likely to be the same.
return Double.valueOf(self.toString());
}
/**
* Transform a Number into a BigDecimal
*
* @param self a Number
* @return a BigDecimal
* @since 1.0
*/
public static BigDecimal toBigDecimal(Number self) {
// Quick method for scalars.
if ((self instanceof Long)
|| (self instanceof Integer)
|| (self instanceof Short)
|| (self instanceof Byte))
{
return BigDecimal.valueOf(self.longValue());
}
return new BigDecimal(self.toString());
}
/**
* Transform this number to a the given type, using the 'as' operator. The
* following types are supported in addition to the default
* {@link #asType(java.lang.Object, java.lang.Class)}:
* <ul>
* <li>BigDecimal</li>
* <li>BigInteger</li>
* <li>Double</li>
* <li>Float</li>
* </ul>
* @param self this number
* @param c the desired type of the transformed result
* @return an instance of the given type
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Number self, Class<T> c) {
if (c == BigDecimal.class) {
return (T) toBigDecimal(self);
} else if (c == BigInteger.class) {
return (T) toBigInteger(self);
} else if (c == Double.class) {
return (T) toDouble(self);
} else if (c == Float.class) {
return (T) toFloat(self);
}
return asType((Object) self, c);
}
/**
* Transform this Number into a BigInteger.
*
* @param self a Number
* @return a BigInteger
* @since 1.0
*/
public static BigInteger toBigInteger(Number self) {
if (self instanceof BigInteger) {
return (BigInteger) self;
} else if (self instanceof BigDecimal) {
return ((BigDecimal) self).toBigInteger();
} else if (self instanceof Double) {
return new BigDecimal((Double)self).toBigInteger();
} else if (self instanceof Float) {
return new BigDecimal((Float)self).toBigInteger();
} else {
return new BigInteger(Long.toString(self.longValue()));
}
}
// Boolean based methods
//-------------------------------------------------------------------------
/**
* Logical conjunction of two boolean operators.
*
* @param left left operator
* @param right right operator
* @return result of logical conjunction
* @since 1.0
*/
public static Boolean and(Boolean left, Boolean right) {
return left && Boolean.TRUE.equals(right);
}
/**
* Logical disjunction of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of logical disjunction
* @since 1.0
*/
public static Boolean or(Boolean left, Boolean right) {
return left || Boolean.TRUE.equals(right);
}
/**
* Logical implication of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of logical implication
* @since 1.8.3
*/
public static Boolean implies(Boolean left, Boolean right) {
return !left || Boolean.TRUE.equals(right);
}
/**
* Exclusive disjunction of two boolean operators
*
* @param left left operator
* @param right right operator
* @return result of exclusive disjunction
* @since 1.0
*/
public static Boolean xor(Boolean left, Boolean right) {
return left ^ Boolean.TRUE.equals(right);
}
// public static Boolean negate(Boolean left) {
// return Boolean.valueOf(!left.booleanValue());
// }
/**
* Allows a simple syntax for using timers. This timer will execute the
* given closure after the given delay.
*
* @param timer a timer object
* @param delay the delay in milliseconds before running the closure code
* @param closure the closure to invoke
* @return The timer task which has been scheduled.
* @since 1.5.0
*/
public static TimerTask runAfter(Timer timer, int delay, final Closure closure) {
TimerTask timerTask = new TimerTask() {
public void run() {
closure.call();
}
};
timer.schedule(timerTask, delay);
return timerTask;
}
/**
* Traverse through each byte of this Byte array. Alias for each.
*
* @param self a Byte array
* @param closure a closure
* @see #each(java.lang.Object, groovy.lang.Closure)
* @since 1.5.5
*/
public static void eachByte(Byte[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(self, closure);
}
/**
* Traverse through each byte of this byte array. Alias for each.
*
* @param self a byte array
* @param closure a closure
* @see #each(java.lang.Object, groovy.lang.Closure)
* @since 1.5.5
*/
public static void eachByte(byte[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
each(self, closure);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index of the first item that matches the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 1.0
*/
public static int findIndexOf(Object self, Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting from a
* specified startIndex, and returns the index of the first item that matches the
* condition specified in the closure.
* Example (aggregate is {@code ChronoUnit} enum values):
* <pre class="groovyTestCase">
* import java.time.temporal.ChronoUnit
* def nameStartsWithM = { it.name().startsWith('M') }
* def first = ChronoUnit.findIndexOf(nameStartsWithM)
* def second = ChronoUnit.findIndexOf(first + 1, nameStartsWithM)
* def third = ChronoUnit.findIndexOf(second + 1, nameStartsWithM)
* Set units = [first, second, third]
* assert !units.contains(-1) // should have found 3 of MICROS, MILLIS, MINUTES, MONTHS, ...
* assert units.size() == 3 // just check size so as not to rely on order
* </pre>
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 1.5.0
*/
public static int findIndexOf(Object self, int startIndex, Closure condition) {
return findIndexOf(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterator<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int result = -1;
int i = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (i++ < startIndex) {
continue;
}
if (bcw.call(value)) {
result = i - 1;
break;
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(Iterable<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexOf(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Array
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Array, starting from a
* specified startIndex, and returns the index of the first item that satisfies the
* condition specified by the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the first matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexOf(new ArrayIterator<T>(self), startIndex, condition);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index of the last item that matches the condition specified in the closure.
* Example (aggregate is {@code ChronoUnit} enum values):
* <pre class="groovyTestCase">
* import java.time.temporal.ChronoUnit
* def nameStartsWithM = { it.name().startsWith('M') }
* def first = ChronoUnit.findIndexOf(nameStartsWithM)
* def last = ChronoUnit.findLastIndexOf(nameStartsWithM)
* // should have found 2 unique index values for MICROS, MILLIS, MINUTES, MONTHS, ...
* assert first != -1 && last != -1 && first != last
* </pre>
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 1.5.2
*/
public static int findLastIndexOf(Object self, Closure condition) {
return findLastIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 1.5.2
*/
public static int findLastIndexOf(Object self, int startIndex, Closure condition) {
return findLastIndexOf(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterator<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
int result = -1;
int i = 0;
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (i++ < startIndex) {
continue;
}
if (bcw.call(value)) {
result = i - 1;
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self.iterator(), 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(Iterable<T> self, int startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findLastIndexOf(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns
* the index of the last item that matches the condition specified in the closure.
*
* @param self an Array
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findLastIndexOf(new ArrayIterator<T>(self), 0, condition);
}
/**
* Iterates over the elements of an Array, starting
* from a specified startIndex, and returns the index of the last item that
* matches the condition specified in the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return an integer that is the index of the last matched object or -1 if no match was found
* @since 2.5.0
*/
public static <T> int findLastIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
// TODO could be made more efficient by using a reverse index
return findLastIndexOf(new ArrayIterator<T>(self), startIndex, condition);
}
/**
* Iterates over the elements of an aggregate of items and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 1.5.2
*/
public static List<Number> findIndexValues(Object self, Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an aggregate of items, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self the iteration object over which to iterate
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 1.5.2
*/
public static List<Number> findIndexValues(Object self, Number startIndex, Closure condition) {
return findIndexValues(InvokerHelper.asIterator(self), startIndex, condition);
}
/**
* Iterates over the elements of an Iterator and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Iterator
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Iterator, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Iterator
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterator<T> self, Number startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
List<Number> result = new ArrayList<Number>();
long count = 0;
long startCount = startIndex.longValue();
BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
while (self.hasNext()) {
Object value = self.next();
if (count++ < startCount) {
continue;
}
if (bcw.call(value)) {
result.add(count - 1);
}
}
return result;
}
/**
* Iterates over the elements of an Iterable and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Iterable
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Iterable, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Iterable
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(Iterable<T> self, Number startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
return findIndexValues(self.iterator(), startIndex, condition);
}
/**
* Iterates over the elements of an Array and returns
* the index values of the items that match the condition specified in the closure.
*
* @param self an Array
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexValues(self, 0, condition);
}
/**
* Iterates over the elements of an Array, starting from
* a specified startIndex, and returns the index values of the items that match
* the condition specified in the closure.
*
* @param self an Array
* @param startIndex start matching from this index
* @param condition the matching condition
* @return a list of numbers corresponding to the index values of all matched objects
* @since 2.5.0
*/
public static <T> List<Number> findIndexValues(T[] self, Number startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
return findIndexValues(new ArrayIterator<T>(self), startIndex, condition);
}
/**
* Iterates through the classloader parents until it finds a loader with a class
* named "org.codehaus.groovy.tools.RootLoader". If there is no such class
* <code>null</code> will be returned. The name is used for comparison because
* a direct comparison using == may fail as the class may be loaded through
* different classloaders.
*
* @param self a ClassLoader
* @return the rootLoader for the ClassLoader
* @see org.codehaus.groovy.tools.RootLoader
* @since 1.5.0
*/
public static ClassLoader getRootLoader(ClassLoader self) {
while (true) {
if (self == null) return null;
if (isRootLoaderClassOrSubClass(self)) return self;
self = self.getParent();
}
}
private static boolean isRootLoaderClassOrSubClass(ClassLoader self) {
Class current = self.getClass();
while(!current.getName().equals(Object.class.getName())) {
if(current.getName().equals(RootLoader.class.getName())) return true;
current = current.getSuperclass();
}
return false;
}
/**
* Converts a given object to a type. This method is used through
* the "as" operator and is overloadable as any other operator.
*
* @param obj the object to convert
* @param type the goal type
* @return the resulting object
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T asType(Object obj, Class<T> type) {
if (String.class == type) {
return (T) InvokerHelper.toString(obj);
}
// fall back to cast
try {
return (T) DefaultTypeTransformation.castToType(obj, type);
}
catch (GroovyCastException e) {
MetaClass mc = InvokerHelper.getMetaClass(obj);
if (mc instanceof ExpandoMetaClass) {
ExpandoMetaClass emc = (ExpandoMetaClass) mc;
Object mixedIn = emc.castToMixedType(obj, type);
if (mixedIn != null)
return (T) mixedIn;
}
if (type.isInterface()) {
try {
List<Class> interfaces = new ArrayList<Class>();
interfaces.add(type);
return (T) ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, obj);
} catch (GroovyRuntimeException cause) {
// ignore
}
}
throw e;
}
}
private static Object asArrayType(Object object, Class type) {
if (type.isAssignableFrom(object.getClass())) {
return object;
}
Collection list = DefaultTypeTransformation.asCollection(object);
int size = list.size();
Class elementType = type.getComponentType();
Object array = Array.newInstance(elementType, size);
int idx = 0;
if (boolean.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setBoolean(array, idx, (Boolean) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, boolean.class}));
}
} else if (byte.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setByte(array, idx, (Byte) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, byte.class}));
}
} else if (char.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setChar(array, idx, (Character) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, char.class}));
}
} else if (double.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setDouble(array, idx, (Double) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, double.class}));
}
} else if (float.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setFloat(array, idx, (Float) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, float.class}));
}
} else if (int.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setInt(array, idx, (Integer) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, int.class}));
}
} else if (long.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setLong(array, idx, (Long) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, long.class}));
}
} else if (short.class.equals(elementType)) {
for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.setShort(array, idx, (Short) InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, short.class}));
}
} else for (Iterator iter = list.iterator(); iter.hasNext(); idx++) {
Object element = iter.next();
Array.set(array, idx, InvokerHelper.invokeStaticMethod(DefaultGroovyMethods.class, "asType", new Object[]{element, elementType}));
}
return array;
}
/**
* Convenience method to dynamically create a new instance of this
* class. Calls the default constructor.
*
* @param c a class
* @return a new instance of this class
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> c) {
return (T) InvokerHelper.invokeConstructorOf(c, null);
}
/**
* Helper to construct a new instance from the given arguments.
* The constructor is called based on the number and types in the
* args array. Use <code>newInstance(null)</code> or simply
* <code>newInstance()</code> for the default (no-arg) constructor.
*
* @param c a class
* @param args the constructor arguments
* @return a new instance of this class.
* @since 1.0
*/
@SuppressWarnings("unchecked")
public static <T> T newInstance(Class<T> c, Object[] args) {
if (args == null) args = new Object[]{null};
return (T) InvokerHelper.invokeConstructorOf(c, args);
}
/**
* Adds a "metaClass" property to all class objects so you can use the syntax
* <code>String.metaClass.myMethod = { println "foo" }</code>
*
* @param c The java.lang.Class instance
* @return An MetaClass instance
* @since 1.5.0
*/
public static MetaClass getMetaClass(Class c) {
MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
MetaClass mc = metaClassRegistry.getMetaClass(c);
if (mc instanceof ExpandoMetaClass
|| mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee() instanceof ExpandoMetaClass)
return mc;
else {
return new HandleMetaClass(mc);
}
}
/**
* Obtains a MetaClass for an object either from the registry or in the case of
* a GroovyObject from the object itself.
*
* @param obj The object in question
* @return The MetaClass
* @since 1.5.0
*/
public static MetaClass getMetaClass(Object obj) {
MetaClass mc = InvokerHelper.getMetaClass(obj);
return new HandleMetaClass(mc, obj);
}
/**
* Obtains a MetaClass for an object either from the registry or in the case of
* a GroovyObject from the object itself.
*
* @param obj The object in question
* @return The MetaClass
* @since 1.6.0
*/
public static MetaClass getMetaClass(GroovyObject obj) {
// we need this method as trick to guarantee correct method selection
return getMetaClass((Object)obj);
}
/**
* Sets the metaclass for a given class.
*
* @param self the class whose metaclass we wish to set
* @param metaClass the new MetaClass
* @since 1.6.0
*/
public static void setMetaClass(Class self, MetaClass metaClass) {
final MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
if (metaClass == null)
metaClassRegistry.removeMetaClass(self);
else {
if (metaClass instanceof HandleMetaClass) {
metaClassRegistry.setMetaClass(self, ((HandleMetaClass)metaClass).getAdaptee());
} else {
metaClassRegistry.setMetaClass(self, metaClass);
}
if (self==NullObject.class) {
NullObject.getNullObject().setMetaClass(metaClass);
}
}
}
/**
* Set the metaclass for an object.
* @param self the object whose metaclass we want to set
* @param metaClass the new metaclass value
* @since 1.6.0
*/
public static void setMetaClass(Object self, MetaClass metaClass) {
if (metaClass instanceof HandleMetaClass)
metaClass = ((HandleMetaClass)metaClass).getAdaptee();
if (self instanceof Class) {
GroovySystem.getMetaClassRegistry().setMetaClass((Class) self, metaClass);
} else {
((MetaClassRegistryImpl)GroovySystem.getMetaClassRegistry()).setMetaClass(self, metaClass);
}
}
/**
* Set the metaclass for a GroovyObject.
* @param self the object whose metaclass we want to set
* @param metaClass the new metaclass value
* @since 2.0.0
*/
public static void setMetaClass(GroovyObject self, MetaClass metaClass) {
// this method was introduced as to prevent from a stack overflow, described in GROOVY-5285
if (metaClass instanceof HandleMetaClass)
metaClass = ((HandleMetaClass)metaClass).getAdaptee();
self.setMetaClass(metaClass);
disablePrimitiveOptimization(self);
}
private static void disablePrimitiveOptimization(Object self) {
Field sdyn;
Class c = self.getClass();
try {
sdyn = c.getDeclaredField(Verifier.STATIC_METACLASS_BOOL);
sdyn.setBoolean(null, true);
} catch (Throwable e) {
//DO NOTHING
}
}
/**
* Sets/updates the metaclass for a given class to a closure.
*
* @param self the class whose metaclass we wish to update
* @param closure the closure representing the new metaclass
* @return the new metaclass value
* @throws GroovyRuntimeException if the metaclass can't be set for this class
* @since 1.6.0
*/
public static MetaClass metaClass(Class self, @ClosureParams(value=SimpleType.class, options="java.lang.Object")
@DelegatesTo(type="groovy.lang.ExpandoMetaClass.DefiningClosure", strategy=Closure.DELEGATE_ONLY) Closure closure) {
MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
MetaClass mc = metaClassRegistry.getMetaClass(self);
if (mc instanceof ExpandoMetaClass) {
((ExpandoMetaClass) mc).define(closure);
return mc;
}
else {
if (mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee() instanceof ExpandoMetaClass) {
((ExpandoMetaClass)((DelegatingMetaClass) mc).getAdaptee()).define(closure);
return mc;
}
else {
if (mc instanceof DelegatingMetaClass && ((DelegatingMetaClass) mc).getAdaptee().getClass() == MetaClassImpl.class) {
ExpandoMetaClass emc = new ExpandoMetaClass(self, false, true);
emc.initialize();
emc.define(closure);
((DelegatingMetaClass) mc).setAdaptee(emc);
return mc;
}
else {
if (mc.getClass() == MetaClassImpl.class) {
// default case
mc = new ExpandoMetaClass(self, false, true);
mc.initialize();
((ExpandoMetaClass)mc).define(closure);
metaClassRegistry.setMetaClass(self, mc);
return mc;
}
else {
throw new GroovyRuntimeException("Can't add methods to custom meta class " + mc);
}
}
}
}
}
/**
* Sets/updates the metaclass for a given object to a closure.
*
* @param self the object whose metaclass we wish to update
* @param closure the closure representing the new metaclass
* @return the new metaclass value
* @throws GroovyRuntimeException if the metaclass can't be set for this object
* @since 1.6.0
*/
public static MetaClass metaClass(Object self, @ClosureParams(value=SimpleType.class, options="java.lang.Object")
@DelegatesTo(type="groovy.lang.ExpandoMetaClass.DefiningClosure", strategy=Closure.DELEGATE_ONLY) Closure closure) {
MetaClass emc = hasPerInstanceMetaClass(self);
if (emc == null) {
final ExpandoMetaClass metaClass = new ExpandoMetaClass(self.getClass(), false, true);
metaClass.initialize();
metaClass.define(closure);
if (self instanceof GroovyObject) {
setMetaClass((GroovyObject)self, metaClass);
} else {
setMetaClass(self, metaClass);
}
return metaClass;
}
else {
if (emc instanceof ExpandoMetaClass) {
((ExpandoMetaClass)emc).define(closure);
return emc;
}
else {
if (emc instanceof DelegatingMetaClass && ((DelegatingMetaClass)emc).getAdaptee() instanceof ExpandoMetaClass) {
((ExpandoMetaClass)((DelegatingMetaClass)emc).getAdaptee()).define(closure);
return emc;
}
else {
throw new RuntimeException("Can't add methods to non-ExpandoMetaClass " + emc);
}
}
}
}
private static MetaClass hasPerInstanceMetaClass(Object object) {
if (object instanceof GroovyObject) {
MetaClass mc = ((GroovyObject)object).getMetaClass();
if (mc == GroovySystem.getMetaClassRegistry().getMetaClass(object.getClass()) || mc.getClass() == MetaClassImpl.class)
return null;
else
return mc;
}
else {
ClassInfo info = ClassInfo.getClassInfo(object.getClass());
info.lock();
try {
return info.getPerInstanceMetaClass(object);
}
finally {
info.unlock();
}
}
}
/**
* Attempts to create an Iterator for the given object by first
* converting it to a Collection.
*
* @param a an array
* @return an Iterator for the given Array.
* @see org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation#asCollection(java.lang.Object[])
* @since 1.6.4
*/
public static <T> Iterator<T> iterator(T[] a) {
return DefaultTypeTransformation.asCollection(a).iterator();
}
/**
* Attempts to create an Iterator for the given object by first
* converting it to a Collection.
*
* @param o an object
* @return an Iterator for the given Object.
* @see org.codehaus.groovy.runtime.typehandling.DefaultTypeTransformation#asCollection(java.lang.Object)
* @since 1.0
*/
public static Iterator iterator(Object o) {
return DefaultTypeTransformation.asCollection(o).iterator();
}
/**
* Allows an Enumeration to behave like an Iterator. Note that the
* {@link java.util.Iterator#remove() remove()} method is unsupported since the
* underlying Enumeration does not provide a mechanism for removing items.
*
* @param enumeration an Enumeration object
* @return an Iterator for the given Enumeration
* @since 1.0
*/
public static <T> Iterator<T> iterator(final Enumeration<T> enumeration) {
return new Iterator<T>() {
public boolean hasNext() {
return enumeration.hasMoreElements();
}
public T next() {
return enumeration.nextElement();
}
public void remove() {
throw new UnsupportedOperationException("Cannot remove() from an Enumeration");
}
};
}
/**
* An identity function for iterators, supporting 'duck-typing' when trying to get an
* iterator for each object within a collection, some of which may already be iterators.
*
* @param self an iterator object
* @return itself
* @since 1.5.0
*/
public static <T> Iterator<T> iterator(Iterator<T> self) {
return self;
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].iterator().buffered().with { [head(), toList()] } == [1, [1, 2, 3, 4]]
* </pre>
*
* @param self an iterator object
* @return a BufferedIterator wrapping self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> buffered(Iterator<T> self) {
if (self instanceof BufferedIterator) {
return (BufferedIterator<T>) self;
} else {
return new IteratorBufferedIterator<T>(self);
}
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert new LinkedHashSet([1,2,3,4]).bufferedIterator().with { [head(), toList()] } == [1, [1,2,3,4]]
* </pre>
*
* @param self an iterable object
* @return a BufferedIterator for traversing self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> bufferedIterator(Iterable<T> self) {
return new IteratorBufferedIterator<T>(self.iterator());
}
/**
* Returns a <code>BufferedIterator</code> that allows examining the next element without
* consuming it.
* <pre class="groovyTestCase">
* assert [1, 2, 3, 4].bufferedIterator().with { [head(), toList()] } == [1, [1, 2, 3, 4]]
* </pre>
*
* @param self a list
* @return a BufferedIterator for traversing self
* @since 2.5.0
*/
public static <T> BufferedIterator<T> bufferedIterator(List<T> self) {
return new ListBufferedIterator<T>(self);
}
/**
* <p>Returns an object satisfying Groovy truth if the implementing MetaClass responds to
* a method with the given name and arguments types.
*
* <p>Note that this method's return value is based on realised methods and does not take into account
* objects or classes that implement invokeMethod or methodMissing
*
* <p>This method is "safe" in that it will always return a value and never throw an exception
*
* @param self The object to inspect
* @param name The name of the method of interest
* @param argTypes The argument types to match against
* @return A List of MetaMethods matching the argument types which will be empty if no matching methods exist
* @see groovy.lang.MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String, java.lang.Object[])
* @since 1.6.0
*/
public static List<MetaMethod> respondsTo(Object self, String name, Object[] argTypes) {
return InvokerHelper.getMetaClass(self).respondsTo(self, name, argTypes);
}
/**
* <p>Returns an object satisfying Groovy truth if the implementing MetaClass responds to
* a method with the given name regardless of the arguments.
*
* <p>Note that this method's return value is based on realised methods and does not take into account
* objects or classes that implement invokeMethod or methodMissing
*
* <p>This method is "safe" in that it will always return a value and never throw an exception
*
* @param self The object to inspect
* @param name The name of the method of interest
* @return A List of MetaMethods matching the given name or an empty list if no matching methods exist
* @see groovy.lang.MetaObjectProtocol#respondsTo(java.lang.Object, java.lang.String)
* @since 1.6.1
*/
public static List<MetaMethod> respondsTo(Object self, String name) {
return InvokerHelper.getMetaClass(self).respondsTo(self, name);
}
/**
* <p>Returns true of the implementing MetaClass has a property of the given name
*
* <p>Note that this method will only return true for realised properties and does not take into
* account implementation of getProperty or propertyMissing
*
* @param self The object to inspect
* @param name The name of the property of interest
* @return The found MetaProperty or null if it doesn't exist
* @see groovy.lang.MetaObjectProtocol#hasProperty(java.lang.Object, java.lang.String)
* @since 1.6.1
*/
public static MetaProperty hasProperty(Object self, String name) {
return InvokerHelper.getMetaClass(self).hasProperty(self, name);
}
/**
* Dynamically wraps an instance into something which implements the
* supplied trait classes. It is guaranteed that the returned object
* will implement the trait interfaces, but the original type of the
* object is lost (replaced with a proxy).
* @param self object to be wrapped
* @param traits a list of trait classes
* @return a proxy implementing the trait interfaces
*/
public static Object withTraits(Object self, Class<?>... traits) {
List<Class> interfaces = new ArrayList<Class>();
Collections.addAll(interfaces, traits);
return ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, self);
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert [1, 3, 2, 4] == [1, 2, 3, 4].swap(1, 2)
* </pre>
*
* @param self a List
* @param i a position
* @param j a position
* @return self
* @see Collections#swap(List, int, int)
* @since 2.4.0
*/
public static <T> List<T> swap(List<T> self, int i, int j) {
Collections.swap(self, i, j);
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert (["a", "c", "b", "d"] as String[]) == (["a", "b", "c", "d"] as String[]).swap(1, 2)
* </pre>
*
* @param self an array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static <T> T[] swap(T[] self, int i, int j) {
T tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([false, true, false, true] as boolean[]) == ([false, false, true, true] as boolean[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static boolean[] swap(boolean[] self, int i, int j) {
boolean tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as byte[]) == ([1, 2, 3, 4] as byte[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static byte[] swap(byte[] self, int i, int j) {
byte tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as char[]) == ([1, 2, 3, 4] as char[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static char[] swap(char[] self, int i, int j) {
char tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as double[]) == ([1, 2, 3, 4] as double[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static double[] swap(double[] self, int i, int j) {
double tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as float[]) == ([1, 2, 3, 4] as float[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static float[] swap(float[] self, int i, int j) {
float tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as int[]) == ([1, 2, 3, 4] as int[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static int[] swap(int[] self, int i, int j) {
int tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as long[]) == ([1, 2, 3, 4] as long[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static long[] swap(long[] self, int i, int j) {
long tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Swaps two elements at the specified positions.
* <p>
* Example:
* <pre class="groovyTestCase">
* assert ([1, 3, 2, 4] as short[]) == ([1, 2, 3, 4] as short[]).swap(1, 2)
* </pre>
*
* @param self a boolean array
* @param i a position
* @param j a position
* @return self
* @since 2.4.0
*/
public static short[] swap(short[] self, int i, int j) {
short tmp = self[i];
self[i] = self[j];
self[j] = tmp;
return self;
}
/**
* Modifies this list by removing the element at the specified position
* in this list. Returns the removed element. Essentially an alias for
* {@link List#remove(int)} but with no ambiguity for List<Integer>.
* <p/>
* Example:
* <pre class="groovyTestCase">
* def list = [1, 2, 3]
* list.removeAt(1)
* assert [1, 3] == list
* </pre>
*
* @param self a List
* @param index the index of the element to be removed
* @return the element previously at the specified position
* @since 2.4.0
*/
public static <E> E removeAt(List<E> self, int index) {
return self.remove(index);
}
/**
* Modifies this collection by removing a single instance of the specified
* element from this collection, if it is present. Essentially an alias for
* {@link Collection#remove(Object)} but with no ambiguity for Collection<Integer>.
* <p/>
* Example:
* <pre class="groovyTestCase">
* def list = [1, 2, 3, 2]
* list.removeElement(2)
* assert [1, 3, 2] == list
* </pre>
*
* @param self a Collection
* @param o element to be removed from this collection, if present
* @return true if an element was removed as a result of this call
* @since 2.4.0
*/
public static <E> boolean removeElement(Collection<E> self, Object o) {
return self.remove(o);
}
/**
* Get runtime groovydoc
* @param holder the groovydoc hold
* @return runtime groovydoc
* @since 2.6.0
*/
public static groovy.lang.groovydoc.Groovydoc getGroovydoc(AnnotatedElement holder) {
Groovydoc groovydocAnnotation = holder.getAnnotation(Groovydoc.class);
return null == groovydocAnnotation
? EMPTY_GROOVYDOC
: new groovy.lang.groovydoc.Groovydoc(groovydocAnnotation.value(), holder);
}
@Deprecated
public static <T> T asType(CharSequence self, Class<T> c) {
return StringGroovyMethods.asType(self, c);
}
/**
* Get the detail information of {@link Throwable} instance's stack trace
*
* @param self a Throwable instance
* @return the detail information of stack trace
* @since 2.5.3
*/
public static String asString(Throwable self) {
StringBuilderWriter sw = new StringBuilderWriter();
try (PrintWriter pw = new PrintWriter(sw)) {
self.printStackTrace(pw);
}
return sw.toString();
}
}
| Refactor DGM (add Diamond usage) (closes #1202)
| src/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java | Refactor DGM (add Diamond usage) (closes #1202) | <ide><path>rc/main/java/org/codehaus/groovy/runtime/DefaultGroovyMethods.java
<ide> // NioExtensions.class
<ide> };
<ide> private static final Object[] EMPTY_OBJECT_ARRAY = new Object[0];
<del> private static final NumberAwareComparator<Comparable> COMPARABLE_NUMBER_AWARE_COMPARATOR = new NumberAwareComparator<Comparable>();
<add> private static final NumberAwareComparator<Comparable> COMPARABLE_NUMBER_AWARE_COMPARATOR = new NumberAwareComparator<>();
<ide>
<ide> /**
<ide> * Identity check. Since == is overridden in Groovy with the meaning of equality
<ide> * <pre>
<ide> * def fullName = person.with(false){ "$firstName $lastName" }
<ide> * </pre>
<del> * Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be ommitted instead.
<add> * Alternatively, 'with' is an alias for 'with(false)', so the boolean parameter can be omitted instead.
<ide> *
<ide> * @param self the object to have a closure act upon
<ide> * @param returning if true, return the self object; otherwise, the result of calling the closure
<ide> public static List<PropertyValue> getMetaPropertyValues(Object self) {
<ide> MetaClass metaClass = InvokerHelper.getMetaClass(self);
<ide> List<MetaProperty> mps = metaClass.getProperties();
<del> List<PropertyValue> props = new ArrayList<PropertyValue>(mps.size());
<add> List<PropertyValue> props = new ArrayList<>(mps.size());
<ide> for (MetaProperty mp : mps) {
<ide> props.add(new PropertyValue(self, mp));
<ide> }
<ide> */
<ide> public static Map getProperties(Object self) {
<ide> List<PropertyValue> metaProps = getMetaPropertyValues(self);
<del> Map<String, Object> props = new LinkedHashMap<String, Object>(metaProps.size());
<add> Map<String, Object> props = new LinkedHashMap<>(metaProps.size());
<ide>
<ide> for (PropertyValue mp : metaProps) {
<ide> try {
<ide> } catch (ClassCastException e) {
<ide> throw new IllegalArgumentException("Expecting a Closure to be the last argument");
<ide> }
<del> List<Class> list = new ArrayList<Class>(array.length - 1);
<add> List<Class> list = new ArrayList<>(array.length - 1);
<ide> for (int i = 0; i < array.length - 1; ++i) {
<ide> Class categoryClass;
<ide> try {
<ide> * @since 1.5.5
<ide> */
<ide> public static <T> Iterator<T> unique(Iterator<T> self) {
<del> return uniqueItems(new IteratorIterableAdapter<T>(self)).listIterator();
<add> return uniqueItems(new IteratorIterableAdapter<>(self)).listIterator();
<ide> }
<ide>
<ide> /**
<ide> }
<ide>
<ide> private static <T> List<T> uniqueItems(Iterable<T> self) {
<del> List<T> answer = new ArrayList<T>();
<add> List<T> answer = new ArrayList<>();
<ide> for (T t : self) {
<ide> boolean duplicated = false;
<ide> for (T t2 : answer) {
<ide> */
<ide> public static <T> Iterator<T> unique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
<ide> Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
<del> ? new OrderBy<T>(condition, true)
<del> : new ClosureComparator<T>(condition);
<add> ? new OrderBy<>(condition, true)
<add> : new ClosureComparator<>(condition);
<ide> return unique(self, comparator);
<ide> }
<ide>
<ide> // use a comparator of one item or two
<ide> int params = closure.getMaximumNumberOfParameters();
<ide> if (params == 1) {
<del> self = unique(self, mutate, new OrderBy<T>(closure, true));
<add> self = unique(self, mutate, new OrderBy<>(closure, true));
<ide> } else {
<del> self = unique(self, mutate, new ClosureComparator<T>(closure));
<add> self = unique(self, mutate, new ClosureComparator<>(closure));
<ide> }
<ide> return self;
<ide> }
<ide> * @since 1.5.5
<ide> */
<ide> public static <T> Iterator<T> unique(Iterator<T> self, Comparator<T> comparator) {
<del> return uniqueItems(new IteratorIterableAdapter<T>(self), comparator).listIterator();
<add> return uniqueItems(new IteratorIterableAdapter<>(self), comparator).listIterator();
<ide> }
<ide>
<ide> private static final class IteratorIterableAdapter<T> implements Iterable<T> {
<ide> }
<ide>
<ide> private static <T> List<T> uniqueItems(Iterable<T> self, Comparator<T> comparator) {
<del> List<T> answer = new ArrayList<T>();
<add> List<T> answer = new ArrayList<>();
<ide> for (T t : self) {
<ide> boolean duplicated = false;
<ide> for (T t2 : answer) {
<ide> */
<ide> public static <T> Iterator<T> toUnique(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
<ide> return toUnique(self, condition.getMaximumNumberOfParameters() == 1
<del> ? new OrderBy<T>(condition, true)
<del> : new ClosureComparator<T>(condition));
<add> ? new OrderBy<>(condition, true)
<add> : new ClosureComparator<>(condition));
<ide> }
<ide>
<ide> private static final class ToUniqueIterator<E> implements Iterator<E> {
<ide>
<ide> private ToUniqueIterator(Iterator<E> delegate, Comparator<E> comparator) {
<ide> this.delegate = delegate;
<del> seen = new TreeSet<E>(comparator);
<add> seen = new TreeSet<>(comparator);
<ide> advance();
<ide> }
<ide>
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> Iterator<T> toUnique(Iterator<T> self, Comparator<T> comparator) {
<del> return new ToUniqueIterator<T>(self, comparator);
<add> return new ToUniqueIterator<>(self, comparator);
<ide> }
<ide>
<ide> /**
<ide> */
<ide> public static <T> Collection<T> toUnique(Iterable<T> self, @ClosureParams(value = FromString.class, options = {"T", "T,T"}) Closure condition) {
<ide> Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
<del> ? new OrderBy<T>(condition, true)
<del> : new ClosureComparator<T>(condition);
<add> ? new OrderBy<>(condition, true)
<add> : new ClosureComparator<>(condition);
<ide> return toUnique(self, comparator);
<ide> }
<ide>
<ide> * If {@code null}, the Comparable natural ordering of the elements will be used.
<ide> * @return the unique items from the array
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> T[] toUnique(T[] self, Comparator<T> comparator) {
<ide> Collection<T> items = toUnique(toList(self), comparator);
<ide> T[] result = createSimilarArray(self, items.size());
<ide> * @param condition a Closure used to determine unique items
<ide> * @return the unique items from the array
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> T[] toUnique(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
<ide> Comparator<T> comparator = condition.getMaximumNumberOfParameters() == 1
<del> ? new OrderBy<T>(condition, true)
<del> : new ClosureComparator<T>(condition);
<add> ? new OrderBy<>(condition, true)
<add> : new ClosureComparator<>(condition);
<ide> return toUnique(self, comparator);
<ide> }
<ide>
<ide> * @since 1.5.0
<ide> */
<ide> public static <T> List<T> reverseEach(List<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure closure) {
<del> each(new ReverseListIterator<T>(self), closure);
<add> each(new ReverseListIterator<>(self), closure);
<ide> return self;
<ide> }
<ide>
<ide> * @since 1.5.2
<ide> */
<ide> public static <T> T[] reverseEach(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
<del> each(new ReverseListIterator<T>(Arrays.asList(self)), closure);
<add> each(new ReverseListIterator<>(Arrays.asList(self)), closure);
<ide> return self;
<ide> }
<ide>
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> boolean every(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
<del> return every(new ArrayIterator<T>(self), predicate);
<add> return every(new ArrayIterator<>(self), predicate);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> boolean any(T[] self, @ClosureParams(FirstParam.Component.class) Closure predicate) {
<del> return any(new ArrayIterator<T>(self), predicate);
<add> return any(new ArrayIterator<>(self), predicate);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.0
<ide> */
<ide> public static <T> Collection<T> grep(T[] self, Object filter) {
<del> Collection<T> answer = new ArrayList<T>();
<add> Collection<T> answer = new ArrayList<>();
<ide> BooleanReturningMethodInvoker bmi = new BooleanReturningMethodInvoker("isCase");
<ide> for (T element : self) {
<ide> if (bmi.invoke(filter, element)) {
<ide> * @see Closure#IDENTITY
<ide> * @since 2.0
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> Collection<T> grep(T[] self) {
<ide> return grep(self, Closure.IDENTITY);
<ide> }
<ide> * @since 1.5.0
<ide> */
<ide> public static <T> List<T> toList(Iterator<T> self) {
<del> List<T> answer = new ArrayList<T>();
<add>
<add> List<T> answer = new ArrayList<>();
<ide> while (self.hasNext()) {
<ide> answer.add(self.next());
<ide> }
<ide> * @since 1.5.0
<ide> */
<ide> public static <T> List<T> toList(Enumeration<T> self) {
<del> List<T> answer = new ArrayList<T>();
<add> List<T> answer = new ArrayList<>();
<ide> while (self.hasMoreElements()) {
<ide> answer.add(self.nextElement());
<ide> }
<ide> */
<ide> public static <T> List<List<T>> collate(Iterable<T> self, int size, int step, boolean keepRemainder) {
<ide> List<T> selfList = asList(self);
<del> List<List<T>> answer = new ArrayList<List<T>>();
<add> List<List<T>> answer = new ArrayList<>();
<ide> if (size <= 0) {
<ide> answer.add(selfList);
<ide> } else {
<ide> if (!keepRemainder && pos > selfList.size() - size) {
<ide> break ;
<ide> }
<del> List<T> element = new ArrayList<T>() ;
<add> List<T> element = new ArrayList<>() ;
<ide> for (int offs = pos; offs < pos + size && offs < selfList.size(); offs++) {
<ide> element.add(selfList.get(offs));
<ide> }
<ide> * @since 1.0
<ide> */
<ide> public static <T> List<T> collect(Object self, Closure<T> transform) {
<del> return (List<T>) collect(self, new ArrayList<T>(), transform);
<add> return (List<T>) collect(self, new ArrayList<>(), transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <S,T> List<T> collect(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> transform) {
<del> return collect(new ArrayIterator<S>(self), transform);
<add> return collect(new ArrayIterator<>(self), transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <S,T> Collection<T> collect(S[] self, Collection<T> collector, @ClosureParams(FirstParam.Component.class) Closure<? extends T> transform) {
<del> return collect(new ArrayIterator<S>(self), collector, transform);
<add> return collect(new ArrayIterator<>(self), collector, transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <S,T> List<T> collect(Iterator<S> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> transform) {
<del> return (List<T>) collect(self, new ArrayList<T>(), transform);
<add> return (List<T>) collect(self, new ArrayList<>(), transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.2.0
<ide> */
<ide> public static <T,E> List<T> collectMany(Iterable<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<? extends Collection<? extends T>> projection) {
<del> return (List<T>) collectMany(self, new ArrayList<T>(), projection);
<add> return (List<T>) collectMany(self, new ArrayList<>(), projection);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.8.8
<ide> */
<ide> public static <T,K,V> Collection<T> collectMany(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<? extends Collection<? extends T>> projection) {
<del> return collectMany(self, new ArrayList<T>(), projection);
<add> return collectMany(self, new ArrayList<>(), projection);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <T,K,V> List<T> collect(Map<K,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> transform) {
<del> return (List<T>) collect(self, new ArrayList<T>(self.size()), transform);
<add> return (List<T>) collect(self, new ArrayList<>(self.size()), transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.8.7
<ide> */
<ide> public static <K, V, E> Map<K, V> collectEntries(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> transform) {
<del> return collectEntries(self, new LinkedHashMap<K, V>(), transform);
<add> return collectEntries(self, new LinkedHashMap<>(), transform);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <S, T, U extends T, V extends T> T findResult(S[] self, U defaultResult, @ClosureParams(FirstParam.Component.class) Closure<V> condition) {
<del> return findResult(new ArrayIterator<S>(self), defaultResult, condition);
<add> return findResult(new ArrayIterator<>(self), defaultResult, condition);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <S, T> T findResult(S[] self, @ClosureParams(FirstParam.Component.class) Closure<T> condition) {
<del> return findResult(new ArrayIterator<S>(self), condition);
<add> return findResult(new ArrayIterator<>(self), condition);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T, U> Collection<T> findResults(Iterator<U> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<T> filteringTransform) {
<del> List<T> result = new ArrayList<T>();
<add> List<T> result = new ArrayList<>();
<ide> while (self.hasNext()) {
<ide> U value = self.next();
<ide> T transformed = filteringTransform.call(value);
<ide> * @since 2.5.0
<ide> */
<ide> public static <T, U> Collection<T> findResults(U[] self, @ClosureParams(FirstParam.Component.class) Closure<T> filteringTransform) {
<del> return findResults(new ArrayIterator<U>(self), filteringTransform);
<add> return findResults(new ArrayIterator<>(self), filteringTransform);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.8.1
<ide> */
<ide> public static <T, K, V> Collection<T> findResults(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<T> filteringTransform) {
<del> List<T> result = new ArrayList<T>();
<add> List<T> result = new ArrayList<>();
<ide> for (Map.Entry<K, V> entry : self.entrySet()) {
<ide> T transformed = callClosureForMapEntry(filteringTransform, entry);
<ide> if (transformed != null) {
<ide> * @since 2.0
<ide> */
<ide> public static <T> Collection<T> findAll(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
<del> Collection<T> answer = new ArrayList<T>();
<del> return findAll(condition, answer, new ArrayIterator<T>(self));
<add> Collection<T> answer = new ArrayList<>();
<add> return findAll(condition, answer, new ArrayIterator<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> Collection<Collection<T>> split(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
<del> List<T> accept = new ArrayList<T>();
<del> List<T> reject = new ArrayList<T>();
<del> Iterator<T> iter = new ArrayIterator<T>(self);
<add> List<T> accept = new ArrayList<>();
<add> List<T> reject = new ArrayList<>();
<add> Iterator<T> iter = new ArrayIterator<>(self);
<ide> return split(closure, accept, reject, iter);
<ide> }
<ide>
<ide> private static <T> Collection<Collection<T>> split(Closure closure, Collection<T> accept, Collection<T> reject, Iterator<T> iter) {
<del> List<Collection<T>> answer = new ArrayList<Collection<T>>();
<add> List<Collection<T>> answer = new ArrayList<>();
<ide> BooleanClosureWrapper bcw = new BooleanClosureWrapper(closure);
<ide> while (iter.hasNext()) {
<ide> T value = iter.next();
<ide> * @since 1.7.0
<ide> */
<ide> public static <T> Set<List<T>> permutations(Iterable<T> self) {
<del> Set<List<T>> ans = new HashSet<List<T>>();
<del> PermutationGenerator<T> generator = new PermutationGenerator<T>(self);
<add> Set<List<T>> ans = new HashSet<>();
<add> PermutationGenerator<T> generator = new PermutationGenerator<>(self);
<ide> while (generator.hasNext()) {
<ide> ans.add(generator.next());
<ide> }
<ide> * @since 1.7.0
<ide> */
<ide> public static <T> Iterator<List<T>> eachPermutation(Iterable<T> self, Closure closure) {
<del> Iterator<List<T>> generator = new PermutationGenerator<T>(self);
<add> Iterator<List<T>> generator = new PermutationGenerator<>(self);
<ide> while (generator.hasNext()) {
<ide> closure.call(generator.next());
<ide> }
<ide> * @since 2.2.0
<ide> */
<ide> public static <K, T> Map<K, List<T>> groupBy(Iterable<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
<del> Map<K, List<T>> answer = new LinkedHashMap<K, List<T>>();
<add> Map<K, List<T>> answer = new LinkedHashMap<>();
<ide> for (T element : self) {
<ide> K value = closure.call(element);
<ide> groupAnswer(answer, element, value);
<ide> System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
<ide>
<ide> // inject([:]) { a,e {@code ->} a {@code <<} [(e.key): e.value.groupBy(tail)] }
<del> Map<Object, Map> acc = new LinkedHashMap<Object, Map>();
<add> Map<Object, Map> acc = new LinkedHashMap<>();
<ide> for (Map.Entry<Object, List> item : first.entrySet()) {
<ide> acc.put(item.getKey(), groupBy((Iterable)item.getValue(), tail));
<ide> }
<ide> * @since 1.8.0
<ide> */
<ide> public static <K,E> Map<K, Integer> countBy(Iterator<E> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<K> closure) {
<del> Map<K, Integer> answer = new LinkedHashMap<K, Integer>();
<add> Map<K, Integer> answer = new LinkedHashMap<>();
<ide> while (self.hasNext()) {
<ide> K value = closure.call(self.next());
<ide> countAnswer(answer, value);
<ide> * @since 1.5.2
<ide> */
<ide> public static <G, K, V> Map<G, List<Map.Entry<K, V>>> groupEntriesBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
<del> final Map<G, List<Map.Entry<K, V>>> answer = new LinkedHashMap<G, List<Map.Entry<K, V>>>();
<add> final Map<G, List<Map.Entry<K, V>>> answer = new LinkedHashMap<>();
<ide> for (Map.Entry<K, V> entry : self.entrySet()) {
<ide> G value = callClosureForMapEntry(closure, entry);
<ide> groupAnswer(answer, entry, value);
<ide> */
<ide> public static <G, K, V> Map<G, Map<K, V>> groupBy(Map<K, V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<G> closure) {
<ide> final Map<G, List<Map.Entry<K, V>>> initial = groupEntriesBy(self, closure);
<del> final Map<G, Map<K, V>> answer = new LinkedHashMap<G, Map<K, V>>();
<add> final Map<G, Map<K, V>> answer = new LinkedHashMap<>();
<ide> for (Map.Entry<G, List<Map.Entry<K, V>>> outer : initial.entrySet()) {
<ide> G key = outer.getKey();
<ide> List<Map.Entry<K, V>> entries = outer.getValue();
<ide> final Object[] tail = new Object[closures.length - 1];
<ide> System.arraycopy(closures, 1, tail, 0, closures.length - 1); // Arrays.copyOfRange only since JDK 1.6
<ide>
<del> Map<Object, Map> acc = new LinkedHashMap<Object, Map>();
<add> Map<Object, Map> acc = new LinkedHashMap<>();
<ide> for (Map.Entry<Object, Map> item: first.entrySet()) {
<ide> acc.put(item.getKey(), groupBy(item.getValue(), tail));
<ide> }
<ide> * @since 1.8.0
<ide> */
<ide> public static <K,U,V> Map<K, Integer> countBy(Map<U,V> self, @ClosureParams(MapEntryOrKeyValue.class) Closure<K> closure) {
<del> Map<K, Integer> answer = new LinkedHashMap<K, Integer>();
<add> Map<K, Integer> answer = new LinkedHashMap<>();
<ide> for (Map.Entry<U,V> entry : self.entrySet()) {
<ide> countAnswer(answer, callClosureForMapEntry(closure, entry));
<ide> }
<ide> * @since 1.5.0
<ide> */
<ide> protected static <K, T> void groupAnswer(final Map<K, List<T>> answer, T element, K value) {
<del> List<T> groupedElements = answer.computeIfAbsent(value, k -> new ArrayList<T>());
<add> List<T> groupedElements = answer.computeIfAbsent(value, k -> new ArrayList<>());
<ide>
<ide> groupedElements.add(element);
<ide> }
<ide> * @since 1.7.1
<ide> */
<ide> public static <T> Object sum(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
<del> return sum(new ArrayIterator<T>(self), null, closure, true);
<add> return sum(new ArrayIterator<>(self), null, closure, true);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.7.1
<ide> */
<ide> public static <T> Object sum(T[] self, Object initialValue, @ClosureParams(FirstParam.Component.class) Closure closure) {
<del> return sum(new ArrayIterator<T>(self), initialValue, closure, false);
<add> return sum(new ArrayIterator<>(self), initialValue, closure, false);
<ide> }
<ide>
<ide> /**
<ide> * @since 3.0.0
<ide> */
<ide> public static <T> Object average(T[] self, @ClosureParams(FirstParam.Component.class) Closure closure) {
<del> return average(new ArrayIterator<T>(self), closure);
<add> return average(new ArrayIterator<>(self), closure);
<ide> }
<ide>
<ide> /**
<ide> public static <T> T min(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
<ide> int params = closure.getMaximumNumberOfParameters();
<ide> if (params != 1) {
<del> return min(self, new ClosureComparator<T>(closure));
<add> return min(self, new ClosureComparator<>(closure));
<ide> }
<ide> boolean first = true;
<ide> T answer = null;
<ide> public static <T> T max(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
<ide> int params = closure.getMaximumNumberOfParameters();
<ide> if (params != 1) {
<del> return max(self, new ClosureComparator<T>(closure));
<add> return max(self, new ClosureComparator<>(closure));
<ide> }
<ide> boolean first = true;
<ide> T answer = null;
<ide> */
<ide> @SuppressWarnings("unchecked")
<ide> public static <T> List<T> getAt(ListWithDefault<T> self, Collection indices) {
<del> List<T> answer = ListWithDefault.newInstance(new ArrayList<T>(indices.size()), self.isLazyDefaultValues(), self.getInitClosure());
<add> List<T> answer = ListWithDefault.newInstance(new ArrayList<>(indices.size()), self.isLazyDefaultValues(), self.getInitClosure());
<ide> for (Object value : indices) {
<ide> if (value instanceof Collection) {
<ide> answer.addAll((List<T>) InvokerHelper.invokeMethod(self, "getAt", value));
<ide> answer = ListWithDefault.newInstance(reverse(answer), self.isLazyDefaultValues(), self.getInitClosure());
<ide> } else {
<ide> // instead of using the SubList backed by the parent list, a new ArrayList instance is used
<del> answer = ListWithDefault.newInstance(new ArrayList<T>(answer), self.isLazyDefaultValues(), self.getInitClosure());
<add> answer = ListWithDefault.newInstance(new ArrayList<>(answer), self.isLazyDefaultValues(), self.getInitClosure());
<ide> }
<ide>
<ide> return answer;
<ide> *
<ide> */
<ide> public static <T> List<T> getAt(ListWithDefault<T> self, EmptyRange range) {
<del> return ListWithDefault.newInstance(new ArrayList<T>(), self.isLazyDefaultValues(), self.getInitClosure());
<add> return ListWithDefault.newInstance(new ArrayList<>(), self.isLazyDefaultValues(), self.getInitClosure());
<ide> }
<ide>
<ide> /**
<ide> */
<ide> @SuppressWarnings("unchecked")
<ide> public static <T> List<T> getAt(List<T> self, Collection indices) {
<del> List<T> answer = new ArrayList<T>(indices.size());
<add> List<T> answer = new ArrayList<>(indices.size());
<ide> for (Object value : indices) {
<ide> if (value instanceof Collection) {
<ide> answer.addAll((List<T>)InvokerHelper.invokeMethod(self, "getAt", value));
<ide> * @since 1.0
<ide> */
<ide> public static <T> List<T> getAt(T[] self, Collection indices) {
<del> List<T> answer = new ArrayList<T>(indices.size());
<add> List<T> answer = new ArrayList<>(indices.size());
<ide> for (Object value : indices) {
<ide> if (value instanceof Range) {
<ide> answer.addAll(getAt(self, (Range) value));
<ide> * @since 1.0
<ide> */
<ide> public static <K, V> Map<K, V> subMap(Map<K, V> map, Collection<K> keys) {
<del> Map<K, V> answer = new LinkedHashMap<K, V>(keys.size());
<add> Map<K, V> answer = new LinkedHashMap<>(keys.size());
<ide> for (K key : keys) {
<ide> if (map.containsKey(key)) {
<ide> answer.put(key, map.get(key));
<ide> * @since 2.1.0
<ide> */
<ide> public static <K, V> Map<K, V> subMap(Map<K, V> map, K[] keys) {
<del> Map<K, V> answer = new LinkedHashMap<K, V>(keys.length);
<add> Map<K, V> answer = new LinkedHashMap<>(keys.length);
<ide> for (K key : keys) {
<ide> if (map.containsKey(key)) {
<ide> answer.put(key, map.get(key));
<ide> * @since 1.5.0
<ide> */
<ide> public static <T> List<T> getAt(T[] array, EmptyRange range) {
<del> return new ArrayList<T>();
<add> return new ArrayList<>();
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <T> List<T> toList(T[] array) {
<del> return new ArrayList<T>(Arrays.asList(array));
<add> return new ArrayList<>(Arrays.asList(array));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static List getAt(Collection coll, String property) {
<del> List<Object> answer = new ArrayList<Object>(coll.size());
<add> List<Object> answer = new ArrayList<>(coll.size());
<ide> return getAtIterable(coll, property, answer);
<ide> }
<ide>
<ide> * @since 1.0
<ide> */
<ide> public static <K, V> Map<K, V> asImmutable(Map<K, V> self) {
<del> return asUnmodifiable(new LinkedHashMap<K, V>(self));
<add> return asUnmodifiable(new LinkedHashMap<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <K, V> SortedMap<K, V> asImmutable(SortedMap<K, V> self) {
<del> return asUnmodifiable(new TreeMap<K, V>(self));
<add> return asUnmodifiable(new TreeMap<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <T> List<T> asImmutable(List<T> self) {
<del> return asUnmodifiable(new ArrayList<T>(self));
<add> return asUnmodifiable(new ArrayList<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <T> Set<T> asImmutable(Set<T> self) {
<del> return asUnmodifiable(new LinkedHashSet<T>(self));
<add> return asUnmodifiable(new LinkedHashSet<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.0
<ide> */
<ide> public static <T> SortedSet<T> asImmutable(SortedSet<T> self) {
<del> return asUnmodifiable(new TreeSet<T>(self));
<add> return asUnmodifiable(new TreeSet<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.5.0
<ide> */
<ide> public static <T> Collection<T> asImmutable(Collection<T> self) {
<del> return asUnmodifiable((Collection<T>) new ArrayList<T>(self));
<add> return asUnmodifiable((Collection<T>)new ArrayList<>(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <E> Map<Integer, E> indexed(Iterable<E> self, int offset) {
<del> Map<Integer, E> result = new LinkedHashMap<Integer, E>();
<add> Map<Integer, E> result = new LinkedHashMap<>();
<ide> Iterator<Tuple2<Integer, E>> indexed = indexed(self.iterator(), offset);
<ide> while (indexed.hasNext()) {
<ide> Tuple2<Integer, E> next = indexed.next();
<ide> * @since 2.4.0
<ide> */
<ide> public static <E> Iterator<Tuple2<E, Integer>> withIndex(Iterator<E> self, int offset) {
<del> return new ZipPostIterator<E>(self, offset);
<add> return new ZipPostIterator<>(self, offset);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <E> Iterator<Tuple2<Integer, E>> indexed(Iterator<E> self, int offset) {
<del> return new ZipPreIterator<E>(self, offset);
<add> return new ZipPreIterator<>(self, offset);
<ide> }
<ide>
<ide> private static final class ZipPostIterator<E> implements Iterator<Tuple2<E, Integer>> {
<ide>
<ide> public Tuple2<E, Integer> next() {
<ide> if (!hasNext()) throw new NoSuchElementException();
<del> return new Tuple2<E, Integer>(delegate.next(), index++);
<add> return new Tuple2<>(delegate.next(), index++);
<ide> }
<ide>
<ide> public void remove() {
<ide>
<ide> public Tuple2<Integer, E> next() {
<ide> if (!hasNext()) throw new NoSuchElementException();
<del> return new Tuple2<Integer, E>(index++, delegate.next());
<add> return new Tuple2<>(index++, delegate.next());
<ide> }
<ide>
<ide> public void remove() {
<ide> */
<ide> public static <T> List<T> sort(Iterable<T> self, boolean mutate) {
<ide> List<T> answer = mutate ? asList(self) : toList(self);
<del> answer.sort(new NumberAwareComparator<T>());
<add> answer.sort(new NumberAwareComparator<>());
<ide> return answer;
<ide> }
<ide>
<ide> * @since 1.6.0
<ide> */
<ide> public static <K, V> Map<K, V> sort(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure closure) {
<del> Map<K, V> result = new LinkedHashMap<K, V>();
<add> Map<K, V> result = new LinkedHashMap<>();
<ide> List<Map.Entry<K, V>> entries = asList((Iterable<Map.Entry<K, V>>) self.entrySet());
<ide> sort((Iterable<Map.Entry<K, V>>) entries, closure);
<ide> for (Map.Entry<K, V> entry : entries) {
<ide> * @since 1.7.2
<ide> */
<ide> public static <K, V> Map<K, V> sort(Map<K, V> self, Comparator<? super K> comparator) {
<del> Map<K, V> result = new TreeMap<K, V>(comparator);
<add> Map<K, V> result = new TreeMap<>(comparator);
<ide> result.putAll(self);
<ide> return result;
<ide> }
<ide> * @since 1.7.2
<ide> */
<ide> public static <K, V> Map<K, V> sort(Map<K, V> self) {
<del> return new TreeMap<K, V>(self);
<add> return new TreeMap<>(self);
<ide> }
<ide>
<ide> /**
<ide> * @since 1.5.5
<ide> */
<ide> public static <T> T[] sort(T[] self) {
<del> Arrays.sort(self, new NumberAwareComparator<T>());
<add> Arrays.sort(self, new NumberAwareComparator<>());
<ide> return self;
<ide> }
<ide>
<ide> */
<ide> public static <T> T[] sort(T[] self, boolean mutate) {
<ide> T[] answer = mutate ? self : self.clone();
<del> Arrays.sort(answer, new NumberAwareComparator<T>());
<add> Arrays.sort(answer, new NumberAwareComparator<>());
<ide> return answer;
<ide> }
<ide>
<ide> * @return the sorted array
<ide> * @since 1.5.5
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> T[] sort(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
<ide> return sort(self, false, closure);
<ide> }
<ide> // use a comparator of one item or two
<ide> int params = closure.getMaximumNumberOfParameters();
<ide> if (params == 1) {
<del> list.sort(new OrderBy<T>(closure));
<add> list.sort(new OrderBy<>(closure));
<ide> } else {
<del> list.sort(new ClosureComparator<T>(closure));
<add> list.sort(new ClosureComparator<>(closure));
<ide> }
<ide> return list;
<ide> }
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> List<T> toSorted(Iterable<T> self) {
<del> return toSorted(self, new NumberAwareComparator<T>());
<add> return toSorted(self, new NumberAwareComparator<>());
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> List<T> toSorted(Iterable<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
<del> Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(closure) : new ClosureComparator<T>(closure);
<add> Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(closure) : new ClosureComparator<>(
<add> closure);
<ide> return toSorted(self, comparator);
<ide> }
<ide>
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> Iterator<T> toSorted(Iterator<T> self) {
<del> return toSorted(self, new NumberAwareComparator<T>());
<add> return toSorted(self, new NumberAwareComparator<>());
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> Iterator<T> toSorted(Iterator<T> self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure closure) {
<del> Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(closure) : new ClosureComparator<T>(closure);
<add> Comparator<T> comparator = (closure.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(closure) : new ClosureComparator<>(
<add> closure);
<ide> return toSorted(self, comparator);
<ide> }
<ide>
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> T[] toSorted(T[] self) {
<del> return toSorted(self, new NumberAwareComparator<T>());
<add> return toSorted(self, new NumberAwareComparator<>());
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> T[] toSorted(T[] self, @ClosureParams(value=FromString.class, options={"T","T,T"}) Closure condition) {
<del> Comparator<T> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<T>(condition) : new ClosureComparator<T>(condition);
<add> Comparator<T> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(condition) : new ClosureComparator<>(
<add> condition);
<ide> return toSorted(self, comparator);
<ide> }
<ide>
<ide> * @since 2.4.0
<ide> */
<ide> public static <K, V> Map<K, V> toSorted(Map<K, V> self) {
<del> return toSorted(self, new NumberAwareValueComparator<K, V>());
<add> return toSorted(self, new NumberAwareValueComparator<>());
<ide> }
<ide>
<ide> private static class NumberAwareValueComparator<K, V> implements Comparator<Map.Entry<K, V>> {
<del> private final Comparator<V> delegate = new NumberAwareComparator<V>();
<add> private final Comparator<V> delegate = new NumberAwareComparator<>();
<ide>
<ide> @Override
<ide> public int compare(Map.Entry<K, V> e1, Map.Entry<K, V> e2) {
<ide> */
<ide> public static <K, V> Map<K, V> toSorted(Map<K, V> self, Comparator<Map.Entry<K, V>> comparator) {
<ide> List<Map.Entry<K, V>> sortedEntries = toSorted(self.entrySet(), comparator);
<del> Map<K, V> result = new LinkedHashMap<K, V>();
<add> Map<K, V> result = new LinkedHashMap<>();
<ide> for (Map.Entry<K, V> entry : sortedEntries) {
<ide> result.put(entry.getKey(), entry.getValue());
<ide> }
<ide> * @since 2.4.0
<ide> */
<ide> public static <K, V> Map<K, V> toSorted(Map<K, V> self, @ClosureParams(value=FromString.class, options={"Map.Entry<K,V>","Map.Entry<K,V>,Map.Entry<K,V>"}) Closure condition) {
<del> Comparator<Map.Entry<K,V>> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<Map.Entry<K,V>>(condition) : new ClosureComparator<Map.Entry<K,V>>(condition);
<add> Comparator<Map.Entry<K,V>> comparator = (condition.getMaximumNumberOfParameters() == 1) ? new OrderBy<>(
<add> condition) : new ClosureComparator<>(condition);
<ide> return toSorted(self, comparator);
<ide> }
<ide>
<ide> * @since 2.4.0
<ide> */
<ide> public static <T> Set<T> toSorted(SortedSet<T> self) {
<del> return new LinkedHashSet<T>(self);
<add> return new LinkedHashSet<>(self);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.4.0
<ide> */
<ide> public static <K, V> Map<K, V> toSorted(SortedMap<K, V> self) {
<del> return new LinkedHashMap<K, V>(self);
<add> return new LinkedHashMap<>(self);
<ide> }
<ide>
<ide> /**
<ide> * @throws NoSuchElementException if the array is empty and you try to access the tail()
<ide> * @since 1.7.3
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> T[] tail(T[] self) {
<ide> if (self.length == 0) {
<ide> throw new NoSuchElementException("Cannot access tail() for an empty array");
<ide> Collection<T> selfCol = (Collection<T>) self;
<ide> result = createSimilarCollection(selfCol, selfCol.size() - 1);
<ide> } else {
<del> result = new ArrayList<T>();
<add> result = new ArrayList<>();
<ide> }
<ide> addAll(result, init(self.iterator()));
<ide> return result;
<ide> if (!self.hasNext()) {
<ide> throw new NoSuchElementException("Cannot access init() for an empty Iterator");
<ide> }
<del> return new InitIterator<T>(self);
<add> return new InitIterator<>(self);
<ide> }
<ide>
<ide> private static final class InitIterator<E> implements Iterator<E> {
<ide> * @since 1.8.7
<ide> */
<ide> public static <T> Collection<T> take(Iterable<T> self, int num) {
<del> Collection<T> result = self instanceof Collection ? createSimilarCollection((Collection<T>) self, Math.max(num, 0)) : new ArrayList<T>();
<add> Collection<T> result = self instanceof Collection ? createSimilarCollection((Collection<T>) self, Math.max(num, 0)) : new ArrayList<>();
<ide> addAll(result, take(self.iterator(), num));
<ide> return result;
<ide> }
<ide> * @since 1.8.1
<ide> */
<ide> public static <T> Iterator<T> take(Iterator<T> self, int num) {
<del> return new TakeIterator<T>(self, num);
<add> return new TakeIterator<>(self, num);
<ide> }
<ide>
<ide> private static final class TakeIterator<E> implements Iterator<E> {
<ide> */
<ide> public static <T> Collection<T> takeRight(Iterable<T> self, int num) {
<ide> if (num <= 0 || !self.iterator().hasNext()) {
<del> return self instanceof Collection ? createSimilarCollection((Collection<T>) self, 0) : new ArrayList<T>();
<add> return self instanceof Collection ? createSimilarCollection((Collection<T>) self, 0) : new ArrayList<>();
<ide> }
<ide> Collection<T> selfCol = self instanceof Collection ? (Collection<T>) self : toList(self);
<ide> if (selfCol.size() <= num) {
<ide> if (num <= 0) {
<ide> return self;
<ide> }
<del> return new DropRightIterator<T>(self, num);
<add> return new DropRightIterator<>(self, num);
<ide> }
<ide>
<ide> private static final class DropRightIterator<E> implements Iterator<E> {
<ide> private DropRightIterator(Iterator<E> delegate, int num) {
<ide> this.delegate = delegate;
<ide> this.num = num;
<del> discards = new LinkedList<E>();
<add> discards = new LinkedList<>();
<ide> advance();
<ide> }
<ide>
<ide> * @since 1.8.7
<ide> */
<ide> public static <T> Iterator<T> takeWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
<del> return new TakeWhileIterator<T>(self, condition);
<add> return new TakeWhileIterator<>(self, condition);
<ide> }
<ide>
<ide> private static final class TakeWhileIterator<E> implements Iterator<E> {
<ide> * @since 1.8.7
<ide> */
<ide> public static <T> Iterator<T> dropWhile(Iterator<T> self, @ClosureParams(FirstParam.FirstGenericType.class) Closure<?> condition) {
<del> return new DropWhileIterator<T>(self, condition);
<add> return new DropWhileIterator<>(self, condition);
<ide> }
<ide>
<ide> private static final class DropWhileIterator<E> implements Iterator<E> {
<ide> return self;
<ide> }
<ide> int size = self.size();
<del> List<T> answer = new ArrayList<T>(size);
<add> List<T> answer = new ArrayList<>(size);
<ide> ListIterator<T> iter = self.listIterator(size);
<ide> while (iter.hasPrevious()) {
<ide> answer.add(iter.previous());
<ide> * @see #reverse(Object[], boolean)
<ide> * @since 1.5.5
<ide> */
<del> @SuppressWarnings("unchecked")
<ide> public static <T> T[] reverse(T[] self) {
<ide> return reverse(self, false);
<ide> }
<ide> @SuppressWarnings("unchecked")
<ide> public static <T> T[] reverse(T[] self, boolean mutate) {
<ide> if (!mutate) {
<del> return (T[]) toList(new ReverseListIterator<T>(Arrays.asList(self))).toArray();
<add> return (T[]) toList(new ReverseListIterator<>(Arrays.asList(self))).toArray();
<ide> }
<ide> List<T> items = Arrays.asList(self);
<ide> Collections.reverse(items);
<ide> * @since 1.5.5
<ide> */
<ide> public static <T> Iterator<T> reverse(Iterator<T> self) {
<del> return new ReverseListIterator<T>(toList(self));
<add> return new ReverseListIterator<>(toList(self));
<ide> }
<ide>
<ide> /**
<ide> * @since 1.8.1
<ide> */
<ide> public static <T> List<T> plus(List<T> self, int index, List<T> additions) {
<del> final List<T> answer = new ArrayList<T>(self);
<add> final List<T> answer = new ArrayList<>(self);
<ide> answer.addAll(index, additions);
<ide> return answer;
<ide> }
<ide>
<ide> Collection<T> result = createSimilarCollection(left, Math.min(left.size(), right.size()));
<ide> //creates the collection to look for values.
<del> Collection<T> pickFrom = new TreeSet<T>(comparator);
<add> Collection<T> pickFrom = new TreeSet<>(comparator);
<ide> pickFrom.addAll(left);
<ide>
<ide> for (final T t : right) {
<ide> * @since 2.5.2
<ide> */
<ide> public static <T> List<List<T>> chop(Iterator<T> self, int... chopSizes) {
<del> List<List<T>> result = new ArrayList<List<T>>();
<add> List<List<T>> result = new ArrayList<>();
<ide> for (int nextSize : chopSizes) {
<ide> int size = nextSize;
<del> List<T> next = new ArrayList<T>();
<add> List<T> next = new ArrayList<>();
<ide> while (size-- != 0 && self.hasNext()) {
<ide> next.add(self.next());
<ide> }
<ide> return false;
<ide> }
<ide> final Iterator<T> it1 = self.iterator();
<del> Collection<T> otherItems = new HashSet<T>(other);
<add> Collection<T> otherItems = new HashSet<>(other);
<ide> while (it1.hasNext()) {
<ide> final Object o1 = it1.next();
<ide> final Iterator<T> it2 = otherItems.iterator();
<ide> // since AbstractCollection only does a remove on the first
<ide> // element it encounters.
<ide>
<del> Comparator<T> numberComparator = new NumberAwareComparator<T>();
<add> Comparator<T> numberComparator = new NumberAwareComparator<>();
<ide>
<ide> if (nlgnSort && (head instanceof Comparable)) {
<ide> //n*LOG(n) version
<ide> Set<T> answer;
<ide> if (head instanceof Number) {
<del> answer = new TreeSet<T>(numberComparator);
<add> answer = new TreeSet<>(numberComparator);
<ide> answer.addAll(self);
<ide> for (T t : self) {
<ide> if (t instanceof Number) {
<ide> }
<ide> }
<ide> } else {
<del> answer = new TreeSet<T>(numberComparator);
<add> answer = new TreeSet<>(numberComparator);
<ide> answer.addAll(self);
<ide> answer.removeAll(removeMe);
<ide> }
<ide> }
<ide> } else {
<ide> //n*n version
<del> List<T> tmpAnswer = new LinkedList<T>(self);
<add> List<T> tmpAnswer = new LinkedList<>(self);
<ide> for (Iterator<T> iter = tmpAnswer.iterator(); iter.hasNext();) {
<ide> T element = iter.next();
<ide> boolean elementRemoved = false;
<ide> * @since 1.8.0
<ide> */
<ide> public static <T> Set<T> toSet(Collection<T> self) {
<del> Set<T> answer = new HashSet<T>(self.size());
<add> Set<T> answer = new HashSet<>(self.size());
<ide> answer.addAll(self);
<ide> return answer;
<ide> }
<ide> * @since 1.8.0
<ide> */
<ide> public static <T> Set<T> toSet(Iterator<T> self) {
<del> Set<T> answer = new HashSet<T>();
<add> Set<T> answer = new HashSet<>();
<ide> while (self.hasNext()) {
<ide> answer.add(self.next());
<ide> }
<ide> * @since 1.8.0
<ide> */
<ide> public static <T> Set<T> toSet(Enumeration<T> self) {
<del> Set<T> answer = new HashSet<T>();
<add> Set<T> answer = new HashSet<>();
<ide> while (self.hasMoreElements()) {
<ide> answer.add(self.nextElement());
<ide> }
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> int findIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
<del> return findIndexOf(new ArrayIterator<T>(self), startIndex, condition);
<add> return findIndexOf(new ArrayIterator<>(self), startIndex, condition);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> int findLastIndexOf(T[] self, @ClosureParams(FirstParam.Component.class) Closure condition) {
<del> return findLastIndexOf(new ArrayIterator<T>(self), 0, condition);
<add> return findLastIndexOf(new ArrayIterator<>(self), 0, condition);
<ide> }
<ide>
<ide> /**
<ide> */
<ide> public static <T> int findLastIndexOf(T[] self, int startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
<ide> // TODO could be made more efficient by using a reverse index
<del> return findLastIndexOf(new ArrayIterator<T>(self), startIndex, condition);
<add> return findLastIndexOf(new ArrayIterator<>(self), startIndex, condition);
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> List<Number> findIndexValues(Iterator<T> self, Number startIndex, @ClosureParams(FirstParam.FirstGenericType.class) Closure condition) {
<del> List<Number> result = new ArrayList<Number>();
<add> List<Number> result = new ArrayList<>();
<ide> long count = 0;
<ide> long startCount = startIndex.longValue();
<ide> BooleanClosureWrapper bcw = new BooleanClosureWrapper(condition);
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> List<Number> findIndexValues(T[] self, Number startIndex, @ClosureParams(FirstParam.Component.class) Closure condition) {
<del> return findIndexValues(new ArrayIterator<T>(self), startIndex, condition);
<add> return findIndexValues(new ArrayIterator<>(self), startIndex, condition);
<ide> }
<ide>
<ide> /**
<ide> }
<ide> if (type.isInterface()) {
<ide> try {
<del> List<Class> interfaces = new ArrayList<Class>();
<add> List<Class> interfaces = new ArrayList<>();
<ide> interfaces.add(type);
<ide> return (T) ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, obj);
<ide> } catch (GroovyRuntimeException cause) {
<ide> if (self instanceof BufferedIterator) {
<ide> return (BufferedIterator<T>) self;
<ide> } else {
<del> return new IteratorBufferedIterator<T>(self);
<add> return new IteratorBufferedIterator<>(self);
<ide> }
<ide> }
<ide>
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> BufferedIterator<T> bufferedIterator(Iterable<T> self) {
<del> return new IteratorBufferedIterator<T>(self.iterator());
<add> return new IteratorBufferedIterator<>(self.iterator());
<ide> }
<ide>
<ide> /**
<ide> * @since 2.5.0
<ide> */
<ide> public static <T> BufferedIterator<T> bufferedIterator(List<T> self) {
<del> return new ListBufferedIterator<T>(self);
<add> return new ListBufferedIterator<>(self);
<ide> }
<ide>
<ide> /**
<ide> * @return a proxy implementing the trait interfaces
<ide> */
<ide> public static Object withTraits(Object self, Class<?>... traits) {
<del> List<Class> interfaces = new ArrayList<Class>();
<add> List<Class> interfaces = new ArrayList<>();
<ide> Collections.addAll(interfaces, traits);
<ide> return ProxyGenerator.INSTANCE.instantiateDelegate(interfaces, self);
<ide> } |
|
JavaScript | mit | 4d439fb5b41864484d69eba6b173814e447257d0 | 0 | saul/gamevis,saul/gamevis,saul/gamevis | (function () {
"use strict";
var _ = require('lodash');
var Promise = require('bluebird');
var db = require('remote').require('./js/db');
var models = require('remote').require('./js/models');
var app = new Vue({
el: '#app',
data: {
sessionIndex: null,
sessions: [],
filters: [],
events: []
},
computed: {
session: function () {
return this.sessions[this.sessionIndex];
}
}
});
window.app = app;
var $canvas = $('canvas');
var heatmap = createWebGLHeatmap({canvas: $canvas[0], intensityToAlpha: true});
models.Session.findAll({
order: 'id',
attributes: ['id', 'level']
})
.then(sessions => {
app.sessions = sessions.map(x => _.toPlainObject(x.get({plain: true})));
console.log('Got sessions:', app.sessions);
});
$('#sessionId').change(() => {
heatmap.clear();
db.query(`SELECT DISTINCT name
FROM events
WHERE events.session_id = :sessionId
AND events.data ? 'user_entindex'
ORDER BY name`, {
type: db.QueryTypes.SELECT,
replacements: {sessionId: app.session.id}
})
.then(results => {
app.events = results.map(x => x.name);
console.log('Got events:', app.events);
});
$canvas.css('background-image', `url(overviews/${app.session.level}.png)`);
});
$('#eventForm').submit(e => {
// perform the query
var queryString = `SELECT *, ((
SELECT entity_props.value
FROM entity_props
WHERE entity_props.index = (events.data->>'user_entindex')::int
AND entity_props.tick <= events.tick
AND entity_props.prop = 'DT_CSLocalPlayerExclusive.m_vecOrigin'
AND entity_props.session_id = events.session_id
ORDER BY entity_props.tick DESC
LIMIT 1
)->>'value') AS position
FROM events
WHERE events.name = :event
AND events.session_id = :sessionId`;
app.filters.forEach(filter => {
queryString += `\nAND ((
SELECT entity_props.value
FROM entity_props
WHERE entity_props.index = (events.data->>'user_entindex')::int
AND entity_props.tick <= events.tick
AND entity_props.prop = ${db.escape(filter.prop)}
AND entity_props.session_id = events.session_id
ORDER BY entity_props.tick DESC
LIMIT 1
)->>'value')::text = ${db.escape(filter.value)}`;
});
var intensity = parseFloat($('#intensity').val());
heatmap.clear();
console.log('Querying...');
Promise.all([
db.query(queryString, {
type: db.QueryTypes.SELECT,
replacements: {
event: $('#eventName').val(),
sessionId: app.session.id
}
})
])
.spread(results => {
var overviewData = require(`./overviews/${app.session.level}.json`);
console.log('Query complete.');
var points = results.map(row => {
var position = JSON.parse(row.position);
var x = (position.x - overviewData.pos_x) / overviewData.scale;
var y = (overviewData.pos_y - position.y) / overviewData.scale;
return {x, y, overviewData.scale, intensity};
});
heatmap.addPoints(points);
console.log('Render complete.');
});
return false;
});
var uid = 0;
$('[data-action="addFilter"]').click(() => {
app.filters.push({
id: uid++,
prop: '',
constraint: '=',
value: ''
});
});
$(document).on('click', '[data-action="removeFilter"]', event => {
var $target = $(event.target);
var index = parseInt($target.closest('.filter').attr('data-index'));
console.log('removing', index);
app.filters.splice(index, 1);
});
function tick() {
heatmap.update();
heatmap.display();
window.requestAnimationFrame(tick);
}
window.requestAnimationFrame(tick);
})();
| js/web/app.js | (function () {
"use strict";
var _ = require('lodash');
var Promise = require('bluebird');
var db = require('remote').require('./js/db');
var models = require('remote').require('./js/models');
var app = new Vue({
el: '#app',
data: {
sessionIndex: null,
sessions: [],
filters: [],
events: []
},
computed: {
session: function () {
return this.sessions[this.sessionIndex];
}
}
});
window.app = app;
var $canvas = $('canvas');
var heatmap = createWebGLHeatmap({canvas: $canvas[0], intensityToAlpha: true});
models.Session.findAll({
order: 'id',
attributes: ['id', 'level']
})
.then(sessions => {
app.sessions = sessions.map(x => _.toPlainObject(x.get({plain: true})));
console.log('Got sessions:', app.sessions);
});
$('#sessionId').change(() => {
heatmap.clear();
db.query(`SELECT DISTINCT name
FROM events
WHERE events.session_id = :sessionId
AND events.data ? 'user_entindex'
ORDER BY name`, {
type: db.QueryTypes.SELECT,
replacements: {sessionId: app.session.id}
})
.then(results => {
app.events = results.map(x => x.name);
console.log('Got events:', app.events);
});
$canvas.css('background-image', `url(overviews/${app.session.level}.png)`);
});
$('#eventForm').submit(e => {
// perform the query
var queryString = `SELECT *, ((
SELECT entity_props.value
FROM entity_props
WHERE entity_props.index = (events.data->>'user_entindex')::int
AND entity_props.tick <= events.tick
AND entity_props.prop = 'DT_CSLocalPlayerExclusive.m_vecOrigin'
AND entity_props.session_id = events.session_id
ORDER BY entity_props.tick DESC
LIMIT 1
)->>'value') AS position
FROM events
WHERE events.name = :event
AND events.session_id = :sessionId`;
app.filters.forEach(filter => {
queryString += `\nAND ((
SELECT entity_props.value
FROM entity_props
WHERE entity_props.index = (events.data->>'user_entindex')::int
AND entity_props.tick <= events.tick
AND entity_props.prop = ${db.escape(filter.prop)}
AND entity_props.session_id = events.session_id
ORDER BY entity_props.tick DESC
LIMIT 1
)->>'value')::text = ${db.escape(filter.value)}`;
});
var intensity = parseFloat($('#intensity').val());
console.log('Querying...');
Promise.all([
db.query(queryString, {
type: db.QueryTypes.SELECT,
replacements: {
event: $('#eventName').val(),
sessionId: app.session.id
}
})
])
.spread(results => {
var overviewData = require(`./overviews/${app.session.level}.json`);
console.log('Query complete.');
heatmap.clear();
var points = results.map(row => {
var position = JSON.parse(row.position);
var x = (position.x - overviewData.pos_x) / overviewData.scale;
var y = (overviewData.pos_y - position.y) / overviewData.scale;
const size = 30;
return {x, y, size, intensity};
});
heatmap.addPoints(points);
console.log('Render complete.');
});
return false;
});
var uid = 0;
$('[data-action="addFilter"]').click(() => {
app.filters.push({
id: uid++,
prop: '',
constraint: '=',
value: ''
});
});
$(document).on('click', '[data-action="removeFilter"]', event => {
var $target = $(event.target);
var index = parseInt($target.closest('.filter').attr('data-index'));
console.log('removing', index);
app.filters.splice(index, 1);
});
function tick() {
heatmap.update();
heatmap.display();
window.requestAnimationFrame(tick);
}
window.requestAnimationFrame(tick);
})();
| :lipstick: Set heatmap size to be size of a world unit on the overview
| js/web/app.js | :lipstick: Set heatmap size to be size of a world unit on the overview | <ide><path>s/web/app.js
<ide>
<ide> var intensity = parseFloat($('#intensity').val());
<ide>
<add> heatmap.clear();
<ide> console.log('Querying...');
<ide>
<ide> Promise.all([
<ide> var overviewData = require(`./overviews/${app.session.level}.json`);
<ide>
<ide> console.log('Query complete.');
<del> heatmap.clear();
<ide>
<ide> var points = results.map(row => {
<ide> var position = JSON.parse(row.position);
<ide> var x = (position.x - overviewData.pos_x) / overviewData.scale;
<ide> var y = (overviewData.pos_y - position.y) / overviewData.scale;
<ide>
<del> const size = 30;
<del>
<del> return {x, y, size, intensity};
<add> return {x, y, overviewData.scale, intensity};
<ide> });
<ide>
<ide> heatmap.addPoints(points); |
|
Java | lgpl-2.1 | 8e47dfa7dcc9611e1107b0c898ddab7e473bc54f | 0 | brunobuzzi/orbeon-forms,orbeon/orbeon-forms,orbeon/orbeon-forms,brunobuzzi/orbeon-forms,orbeon/orbeon-forms,orbeon/orbeon-forms,brunobuzzi/orbeon-forms,brunobuzzi/orbeon-forms | /**
* Copyright (C) 2010 Orbeon, Inc.
*
* This program is free software; you can redistribute it and/or modify it under the terms of the
* GNU Lesser General Public License as published by the Free Software Foundation; either version
* 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* The full text of the license is available at http://www.gnu.org/copyleft/lesser.html
*/
package org.orbeon.oxf.xforms.action.actions;
import org.dom4j.Element;
import org.orbeon.oxf.util.IndentedLogger;
import org.orbeon.oxf.xforms.XFormsModel;
import org.orbeon.oxf.xforms.XFormsServerSharedInstancesCache;
import org.orbeon.oxf.xforms.action.XFormsAction;
import org.orbeon.oxf.xforms.action.XFormsActionInterpreter;
import org.orbeon.oxf.xforms.xbl.Scope;
import org.orbeon.saxon.om.Item;
/**
* Extension xxf:invalidate-instances action.
*/
public class XXFormsInvalidateInstancesAction extends XFormsAction {
public void execute(XFormsActionInterpreter actionInterpreter, Element actionElement,
Scope actionScope, boolean hasOverriddenContext, Item overriddenContext) {
// Use XFormsModel logger because it's what's used by XFormsServerSharedInstancesCache in other places
final IndentedLogger indentedLogger = actionInterpreter.containingDocument().getIndentedLogger(XFormsModel.LOGGING_CATEGORY);
XFormsServerSharedInstancesCache.removeAll(indentedLogger);
}
} | src/main/java/org/orbeon/oxf/xforms/action/actions/XXFormsInvalidateInstancesAction.java | /**
* Copyright (C) 2010 Orbeon, Inc.
*
* This program is free software; you can redistribute it and/or modify it under the terms of the
* GNU Lesser General Public License as published by the Free Software Foundation; either version
* 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* The full text of the license is available at http://www.gnu.org/copyleft/lesser.html
*/
package org.orbeon.oxf.xforms.action.actions;
import org.dom4j.Element;
import org.orbeon.oxf.util.IndentedLogger;
import org.orbeon.oxf.xforms.XFormsModel;
import org.orbeon.oxf.xforms.XFormsServerSharedInstancesCache;
import org.orbeon.oxf.xforms.action.XFormsAction;
import org.orbeon.oxf.xforms.action.XFormsActionInterpreter;
import org.orbeon.oxf.xforms.event.XFormsEvent;
import org.orbeon.oxf.xforms.event.XFormsEventObserver;
import org.orbeon.oxf.xforms.xbl.Scope;
import org.orbeon.saxon.om.Item;
/**
* Extension xxf:invalidate-instances action.
*/
public class XXFormsInvalidateInstancesAction extends XFormsAction {
public void execute(XFormsActionInterpreter actionInterpreter, Element actionElement,
Scope actionScope, boolean hasOverriddenContext, Item overriddenContext) {
// Use XFormsModel logger because it's what's used by XFormsServerSharedInstancesCache in other places
final IndentedLogger indentedLogger = actionInterpreter.containingDocument().getIndentedLogger(XFormsModel.LOGGING_CATEGORY);
XFormsServerSharedInstancesCache.removeAll(indentedLogger);
}
} | Minor: imports
| src/main/java/org/orbeon/oxf/xforms/action/actions/XXFormsInvalidateInstancesAction.java | Minor: imports | <ide><path>rc/main/java/org/orbeon/oxf/xforms/action/actions/XXFormsInvalidateInstancesAction.java
<ide> import org.orbeon.oxf.xforms.XFormsServerSharedInstancesCache;
<ide> import org.orbeon.oxf.xforms.action.XFormsAction;
<ide> import org.orbeon.oxf.xforms.action.XFormsActionInterpreter;
<del>import org.orbeon.oxf.xforms.event.XFormsEvent;
<del>import org.orbeon.oxf.xforms.event.XFormsEventObserver;
<ide> import org.orbeon.oxf.xforms.xbl.Scope;
<ide> import org.orbeon.saxon.om.Item;
<ide> |
|
Java | mpl-2.0 | d2064e1e7698e5de000a036f0c30808bb8305270 | 0 | AdamGrzybkowski/openmrs-sdk,AdamGrzybkowski/openmrs-sdk,PawelGutkowski/openmrs-sdk,PawelGutkowski/openmrs-sdk,PawelGutkowski/openmrs-sdk,PawelGutkowski/openmrs-sdk,AdamGrzybkowski/openmrs-sdk,AdamGrzybkowski/openmrs-sdk | package org.openmrs.maven.plugins.utility;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.http.client.utils.URIBuilder;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugin.logging.SystemStreamLog;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.components.interactivity.Prompter;
import org.codehaus.plexus.components.interactivity.PrompterException;
import org.openmrs.maven.plugins.model.Artifact;
import org.openmrs.maven.plugins.model.DistroProperties;
import org.openmrs.maven.plugins.model.Server;
import org.openmrs.maven.plugins.model.UpgradeDifferential;
import org.openmrs.maven.plugins.model.Version;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.InputStreamReader;
import java.net.URISyntaxException;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.*;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Class for attribute helper functions
*/
@Component(role=Wizard.class)
public class DefaultWizard implements Wizard {
private static final String EMPTY_STRING = "";
private static final String NONE = "(none)";
private static final String DEFAULT_CHOICE_TMPL = "Which one do you choose?";
private static final String DEFAULT_OPTION_TMPL = "%d) %s";
private static final String DEFAULT_CUSTOM_OPTION_TMPL = "%d) Other...";
private static final String DEFAULT_SERVER_NAME = "server";
private static final String DEFAULT_VALUE_TMPL = "Please specify '%s'";
private static final String DEFAULT_VALUE_TMPL_WITH_DEFAULT = "Please specify '%s': (default: '%s')";
private static final String DEFAULT_FAIL_MESSAGE = "Server with such serverId is not exists";
private static final String INVALID_SERVER = "Invalid server Id";
private static final String YESNO = " [Y/n]";
private static final String REFERENCEAPPLICATION_2_4 = "org.openmrs.distro:referenceapplication-package:2.4";
private static final String DEFAULT_CUSTOM_DIST_ARTIFACT = "Please specify custom distribution artifact%s (default: '%s')";
private static final String CUSTOM_JDK_PATH = "Please specify a path to JDK used for running this server (-Djdk)";
private static final String SDK_PROPERTIES_FILE = "SDK Properties file";
private static final String REFAPP_OPTION_TMPL = "Reference Application %s";
private static final String REFAPP_ARTIFACT_TMPL = "org.openmrs.distro:referenceapplication-package:%s";
private static final String JDK_ERROR_TMPL = "\nThe JDK %s is not compatible with OpenMRS Platform %s. " +
"Please use %s to run this server.\n\nIf you are running " +
"in a forked mode, correct the java.home property in %s\n";
private static final String UPGRADE_CONFIRM_TMPL = "\nThe %s %s introduces the following changes:";
private static final String UPDATE_MODULE_TMPL = "^ Updates %s %s to %s";
private static final String ADD_MODULE_TMPL = "+ Adds %s %s";
private static final String NO_DIFFERENTIAL = "\nNo modules to update or add found";
public static final String PLATFORM_VERSION_PROMPT = "You can deploy the following versions of a platform";
public static final String DISTRIBUTION_VERSION_PROMPT = "You can deploy the following versions of distribution";
@Requirement
Prompter prompter;
Log log;
private boolean interactiveMode = true;
private ArrayDeque<String> batchAnswers;
public DefaultWizard(){};
public DefaultWizard(Prompter prompter) {
this.prompter = prompter;
}
@Override
public boolean isInteractiveMode() {
return interactiveMode;
}
@Override
public void setInteractiveMode(boolean interactiveMode) {
this.interactiveMode = interactiveMode;
}
/**
* Prompt for serverId, and get default serverId which is not exists,
* if serverId is not set before
*
* @param server @return
* @throws PrompterException
*/
@Override
public void promptForNewServerIfMissing(Server server) {
String defaultServerId = DEFAULT_SERVER_NAME;
int indx = 0;
while (new File(Server.getServersPath(), defaultServerId).exists()) {
indx++;
defaultServerId = DEFAULT_SERVER_NAME + String.valueOf(indx);
}
String serverId = promptForValueIfMissingWithDefault("Specify server id (-D%s) (default: '%s')", server.getServerId(), "serverId", defaultServerId);
server.setServerId(serverId);
}
/**
* Prompt for a value if it not set, and default value is set
*
* @param message
* @param value
* @param parameterName
* @param defValue
* @return value
* @throws PrompterException
*/
@Override
public String promptForValueIfMissingWithDefault(String message, String value, String parameterName, String defValue) {
String textToShow;
if (StringUtils.isBlank(defValue)){
textToShow = String.format(message != null ? message : DEFAULT_VALUE_TMPL, parameterName);
}
else {
textToShow = String.format(message != null? message : DEFAULT_VALUE_TMPL_WITH_DEFAULT, parameterName, defValue);
}
if (value != null) {
return value;
}else if(!interactiveMode){
return getAnswer(textToShow);
}
String val = prompt(textToShow);
if (StringUtils.isBlank(val)) {
val = defValue;
}
return val;
}
@Override
public String promptForMissingValueWithOptions(String message, String value, String parameterName, List<String> options){
return promptForMissingValueWithOptions(message, value, parameterName, options, null, null);
}
@Override
public String promptForMissingValueWithOptions(String message, String value, String parameterName, List<String> options, String customMessage, String customDefault){
String defaultOption = options.isEmpty()? "" : options.get(0);
String question = String.format(message != null? message : DEFAULT_VALUE_TMPL_WITH_DEFAULT, parameterName, defaultOption);
if (value != null) {
return value;
} else if(!interactiveMode){
return getAnswer(question);
}
System.out.println("\n" + question + ":");
List<Integer> choices = new ArrayList<>();
int i = 0;
for(String option : options){
i++;
System.out.println(String.format(DEFAULT_OPTION_TMPL, i, option));
choices.add(i);
}
if(customMessage != null){
i++;
System.out.println(String.format(DEFAULT_CUSTOM_OPTION_TMPL, i));
choices.add(i);
}
String choice = prompt(DEFAULT_CHOICE_TMPL + " [" + StringUtils.join(choices.iterator(), "/") + "]");
int chosenIndex = -1;
if(!StringUtils.isBlank(choice) && StringUtils.isNumeric(choice)) {
chosenIndex = Integer.parseInt(choice) - 1;
}
if(chosenIndex >= 0) {
if (chosenIndex < options.size()){
return options.get(chosenIndex);
} else if(chosenIndex == options.size() && customMessage != null) {
return promptForValueIfMissingWithDefault(customMessage, null, parameterName, customDefault);
}
}
System.out.println("\nYou must specify " + StringUtils.join(choices.iterator(), " or ") + ".");
return promptForMissingValueWithOptions(message, value, parameterName, options, customMessage, customDefault);
}
private String prompt(String textToShow){
try {
return prompter.prompt("\n" + textToShow);
} catch (PrompterException e) {
throw new RuntimeException(e);
}
}
public void showMessage(String textToShow){
System.out.println("\n" + textToShow);
}
@Override
public void showError(String textToShow) {
System.out.println("\n[ERROR]" + textToShow);
}
/**
* Prompt for a value with list of proposed values
* @param value
* @param parameterName
* @param values
* @return value
* @throws PrompterException
*/
@Override
public String promptForValueWithDefaultList(String value, String parameterName, List<String> values) {
if (value != null) return value;
String defaultValue = values.size() > 0 ? values.get(0) : NONE;
final String text = DEFAULT_VALUE_TMPL_WITH_DEFAULT + " (possible: %s)";
String val = prompt(String.format(text, parameterName, defaultValue, StringUtils.join(values.toArray(), ", ")));
if (val.equals(EMPTY_STRING)) val = defaultValue;
return val;
}
/**
* Prompt for a value if it not set, and default value is NOT set
* @param value
* @param parameterName
* @return
* @throws PrompterException
*/
@Override
public String promptForValueIfMissing(String value, String parameterName) {
return promptForValueIfMissingWithDefault(null, value, parameterName, EMPTY_STRING);
}
/**
* Print dialog Yes/No
* @param text - text to display
* @return
*/
@Override
public boolean promptYesNo(String text) {
String yesNo = null;
if(interactiveMode){
yesNo = prompt(text.concat(YESNO));
} else {
yesNo = getAnswer(text);
}
return yesNo.equals("") || yesNo.toLowerCase().equals("y");
}
/**
* Check if value is submit
* @param value
* @return
*/
@Override
public boolean checkYes(String value) {
String val = value.toLowerCase();
return val.equals("true") || val.equals("yes");
}
/**
* Get path to server by serverId and prompt if missing
* @return
* @throws MojoFailureException
*/
@Override
public String promptForExistingServerIdIfMissing(String serverId) {
File omrsHome = new File(Server.getServersPath());
List<String> servers = getListOfServers();
serverId = promptForMissingValueWithOptions("You have the following servers:", serverId, "serverId", servers);
if (serverId.equals(NONE)) {
throw new RuntimeException(INVALID_SERVER);
}
File serverPath = new File(omrsHome, serverId);
if (!serverPath.exists()) {
throw new RuntimeException("There is no server with the given server id. Please create it first using openmrs-sdk:setup.");
}
return serverId;
}
@Override
public void promptForPlatformVersionIfMissing(Server server, List<String> versions) {
String version = promptForMissingValueWithOptions(PLATFORM_VERSION_PROMPT,
server.getVersion(), "version", versions, "Please specify platform version", null);
server.setVersion(version);
}
@Override
public String promptForPlatformVersion(List<String> versions) {
String version = promptForMissingValueWithOptions(PLATFORM_VERSION_PROMPT,
null, "version", versions, "Please specify platform version", null);
return version;
}
@Override
public void promptForJavaHomeIfMissing(Server server) {
if (!StringUtils.isBlank(server.getJavaHome())) {
if (isJavaHomeValid(server.getJavaHome())) {
addJavaHomeToSdkProperties(server.getJavaHome());
return;
} else {
throw new IllegalArgumentException("The specified -DjavaHome property is invalid");
}
}
if (interactiveMode) {
List<String> paths = new ArrayList<>();
paths.add("JAVA_HOME (currently: " + System.getProperty("java.home") + ")");
paths.addAll(getJavaHomeOptions());
String path = promptForMissingValueWithOptions(SDKConstants.OPENMRS_SDK_JDK_OPTION,
server.getJavaHome(), "path", paths, SDKConstants.OPENMRS_SDK_JDK_CUSTOM, null);
String requiredJdkVersion;
String notRecommendedJdkVersion = "Not recommended";
char platformVersionNumber = server.getPlatformVersion().charAt(0);
if (platformVersionNumber == '1') {
requiredJdkVersion = "1.7";
notRecommendedJdkVersion = "1.8";
}
else {
requiredJdkVersion = "1.8";
}
// Use default JAVA_HOME
if (path.equals(paths.get(0))) {
if (System.getProperty("java.version").startsWith(requiredJdkVersion)) {
server.setJavaHome(null);
}
else if (System.getProperty("java.version").startsWith(notRecommendedJdkVersion)) {
boolean isSelectJdk7 = promptYesNo("It is not recommended to run OpenMRS platform " + server.getPlatformVersion() + " on JDK 8. Would you like to select the recommended JDK 7 instead?");
if (isSelectJdk7) {
promptForJavaHomeIfMissing(server);
}
else {
server.setJavaHome(null);
}
}
else {
showMessage("Your JAVA_HOME version doesn't fit platform requirements:");
showMessage("JAVA_HOME version: " + System.getProperty("java.version"));
showMessage("Required: " + requiredJdkVersion);
promptForJavaHomeIfMissing(server);
}
} else if (!isJavaHomeValid(path)) {
System.out.println(SDKConstants.OPENMRS_SDK_JDK_CUSTOM_INVALID);
promptForJavaHomeIfMissing(server);
} else {
String jdkUnderSpecifiedPathVersion = extractJavaVersionFromPath(path);
if (jdkUnderSpecifiedPathVersion.startsWith(requiredJdkVersion)) {
server.setJavaHome(path);
addJavaHomeToSdkProperties(path);
}
else if (jdkUnderSpecifiedPathVersion.startsWith(notRecommendedJdkVersion)) {
boolean isSelectJdk7 = promptYesNo("It is not recommended to run OpenMRS platform " + server.getPlatformVersion() + " on JDK 8. Would you like to select the recommended JDK 7 instead?");
if (isSelectJdk7) {
promptForJavaHomeIfMissing(server);
}
else {
server.setJavaHome(null);
}
}
else {
showMessage("JDK in custom path (" + path + ") doesn't match platform requirements:");
showMessage("JDK version: " + jdkUnderSpecifiedPathVersion);
showMessage("Required: " + requiredJdkVersion);
promptForJavaHomeIfMissing(server);
}
}
}
}
private String extractJavaVersionFromPath(String path) {
List<String> commands = new ArrayList<>();
commands.add("./java");
commands.add("-version");
ProcessBuilder processBuilder = new ProcessBuilder(commands);
processBuilder.redirectErrorStream(true);
processBuilder.environment().put("JAVA_HOME", path);
processBuilder.directory(new File(path.replace("/jre","/bin")));
String result = null;
try {
final Process process = processBuilder.start();
BufferedReader stdInput = new BufferedReader(new InputStreamReader(process.getInputStream()));
result = stdInput.readLine();
} catch (IOException e) {
throw new RuntimeException("Failed to fetch Java version from \"" + path + "\"");
}
Pattern p = Pattern.compile(".*\\\"(.*)\\\".*");
Matcher m = p.matcher(result);
if (m.find()) {
return m.group(1);
}
else {
return null;
}
}
private void addJavaHomeToSdkProperties(String path) {
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
Properties sdkProperties = getSdkProperties();
List<String> jdkPaths = getJavaHomeOptions();
if (!jdkPaths.contains(path)) {
if (jdkPaths.size() == 5) {
jdkPaths.set(4, path);
}
else {
jdkPaths.add(path);
}
Collections.sort(jdkPaths);
String updatedProperty = StringUtils.join(jdkPaths.iterator(), ", ");
sdkProperties.setProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS, updatedProperty);
savePropertiesChangesToFile(sdkProperties, sdkPropertiesFile, SDK_PROPERTIES_FILE);
}
}
private Properties getSdkProperties() {
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
if (!sdkPropertiesFile.exists()) {
try {
sdkPropertiesFile.createNewFile();
} catch (IOException e) {
throw new IllegalStateException("Failed to create SDK properties file in: \"" + Server.getServersPathFile() + "/" + SDKConstants.OPENMRS_SDK_PROPERTIES + "\"");
}
}
InputStream in;
try {
in = new FileInputStream(sdkPropertiesFile);
} catch (FileNotFoundException e) {
throw new IllegalStateException("SDK properties file not found at: \"" + Server.getServersPathFile() + "/" + SDKConstants.OPENMRS_SDK_PROPERTIES + "\"");
}
Properties sdkProperties = new Properties();
try {
sdkProperties.load(in);
} catch (IOException e) {
throw new IllegalStateException("Failed to load properties from file");
}
return sdkProperties;
}
private List<String> getJavaHomeOptions() {
Properties sdkProperties = getSdkProperties();
List<String> result = new ArrayList<>();
if (interactiveMode) {
String jdkHomeProperty = sdkProperties.getProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS);
if (jdkHomeProperty != null) {
for (String path: Arrays.asList(jdkHomeProperty.split("\\s*,\\s*"))) {
if (isJavaHomeValid(path)) {
result.add(path);
}
}
// Save properties
Collections.sort(result);
String updatedProperty = StringUtils.join(result.iterator(), ", ");
sdkProperties.setProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS, updatedProperty);
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
savePropertiesChangesToFile(sdkProperties, sdkPropertiesFile, SDK_PROPERTIES_FILE);
return result;
} else {
return new ArrayList<>();
}
}else {
return new ArrayList<>();
}
}
private boolean isJavaHomeValid(String jdkPath) {
File jdk = new File(jdkPath, "bin");
if (System.getProperty("os.name").toLowerCase().contains("windows")) {
jdk = new File(jdk, "java.exe");
} else {
jdk = new File(jdk, "java");
}
return jdk.exists();
}
private void savePropertiesChangesToFile(Properties properties, File file, String message) {
OutputStream fos = null;
try {
fos = new FileOutputStream(file);
properties.store(fos, message + ":");
fos.close();
} catch (IOException e) {
throw new IllegalStateException(e);
} finally {
IOUtils.closeQuietly(fos);
}
}
@Override
public void promptForRefAppVersionIfMissing(Server server, VersionsHelper versionsHelper) throws MojoExecutionException {
if(server.getVersion()==null){
String choice = promptForRefAppVersion(versionsHelper);
Artifact distro = DistroHelper.parseDistroArtifact(choice);
if(distro != null){
server.setVersion(distro.getVersion());
server.setDistroArtifactId(distro.getArtifactId());
server.setDistroGroupId(distro.getGroupId());
} else {
server.setDistroArtifactId(SDKConstants.REFERENCEAPPLICATION_ARTIFACT_ID);
server.setDistroGroupId(Artifact.GROUP_DISTRO);
server.setVersion(choice);
}
}
}
public String promptForRefAppVersion(VersionsHelper versionsHelper) {
int maxOptionsSize = 5;
Map<String, String> optionsMap = new LinkedHashMap<>();
Set<String> versions = new LinkedHashSet<>(versionsHelper.getVersionAdvice(SDKConstants.getReferenceModule("2.3.1"), maxOptionsSize));
versions.addAll(SDKConstants.SUPPPORTED_REFAPP_VERSIONS_2_3_1_OR_LOWER);
List<ArtifactVersion> artifactVersions = new ArrayList<>();
for(String version : versions){
artifactVersions.add(new DefaultArtifactVersion(version));
}
for(String version : versionsHelper.getVersionAdvice(artifactVersions, 5)){
optionsMap.put(String.format(REFAPP_OPTION_TMPL, version), String.format(REFAPP_ARTIFACT_TMPL, version));
if(optionsMap.size()== maxOptionsSize) break;
}
String version = promptForMissingValueWithOptions(DISTRIBUTION_VERSION_PROMPT,
null, "distribution artifact", Lists.newArrayList(optionsMap.keySet()), "Please specify %s (default: '%s')", REFERENCEAPPLICATION_2_4);
String artifact = optionsMap.get(version);
if (artifact != null) {
return artifact;
} else {
return version;
}
}
@Override
public void promptForMySQLDb(Server server) {
if(server.getDbDriver() == null){
server.setDbDriver(SDKConstants.DRIVER_MYSQL);
}
String dbUri = promptForValueIfMissingWithDefault(
"The distribution requires MySQL database. Please specify database uri (-D%s) (default: '%s')",
server.getDbUri(), "dbUri", SDKConstants.URI_MYSQL);
if (dbUri.startsWith("jdbc:mysql:")) {
dbUri = addMySQLParamsIfMissing(dbUri);
}
server.setDbUri(dbUri);
promptForDbCredentialsIfMissing(server);
}
@Override
public void promptForH2Db(Server server) {
boolean h2 = promptYesNo(
"Would you like to use the h2 database (-DdbDriver) (note that some modules do not support it)?");
if(h2) {
server.setDbDriver(SDKConstants.DRIVER_H2);
if (server.getDbUri() == null) {
server.setDbUri(SDKConstants.URI_H2);
}
server.setDbUser("root");
server.setDbPassword("root");
} else {
promptForMySQLDb(server);
}
}
@Override
public void promptForDbCredentialsIfMissing(Server server) {
String defaultUser = "root";
String user = promptForValueIfMissingWithDefault(
"Please specify database username (-D%s) (default: '%s')",
server.getDbUser(), "dbUser", defaultUser);
server.setDbUser(user);
//set password
String dbPassword = promptForValueIfMissingWithDefault(
"Please specify database password (-D%s) (default: '')",
server.getDbPassword(), "dbPassword", "");
server.setDbPassword(dbPassword);
}
/**
* Get servers with recently used first
* @return
*/
@Override
public List<String> getListOfServers() {
File openMRS = new File(Server.getServersPath());
Map<Long, String> sortedMap = new TreeMap<Long, String>(Collections.reverseOrder());
File [] list = (openMRS.listFiles() == null) ? new File[0] : openMRS.listFiles();
for (File f: list) {
if (f.isDirectory()) sortedMap.put(f.lastModified(), f.getName());
}
return new ArrayList<String>(sortedMap.values());
}
@Override
public String addMySQLParamsIfMissing(String dbUri) {
String noJdbc = dbUri.substring(5);
URIBuilder uri;
try {
uri = new URIBuilder(noJdbc);
} catch (URISyntaxException e) {
throw new IllegalArgumentException(e);
}
uri.setParameter("autoReconnect", "true");
uri.setParameter("sessionVariables", "storage_engine=InnoDB");
uri.setParameter("useUnicode", "true");
uri.setParameter("characterEncoding", "UTF-8");
return "jdbc:" + uri.toString();
}
public Log getLog() {
if(log == null){
log = new SystemStreamLog();
}
return log;
}
@Override
public void showJdkErrorMessage(String jdk, String platform, String recommendedJdk, String pathToServerProperties) {
System.out.println(String.format(JDK_ERROR_TMPL, jdk, platform, recommendedJdk, pathToServerProperties));
}
/**
* Show confirmation prompt if there is any change besides updating modules with SNAPSHOT versions
* @return
*/
@Override
public boolean promptForConfirmDistroUpgrade(UpgradeDifferential upgradeDifferential, Server server, DistroProperties distroProperties){
if(upgradeDifferential.isEmpty()){
showMessage(NO_DIFFERENTIAL);
return false;
}
boolean needConfirmation = false;
if(upgradeDifferential.getPlatformArtifact() !=null){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(UPDATE_MODULE_TMPL,
upgradeDifferential.getPlatformArtifact().getArtifactId(),
server.getPlatformVersion(),
upgradeDifferential.getPlatformArtifact().getVersion()));
}
for(Entry<Artifact, Artifact> updateEntry : upgradeDifferential.getUpdateOldToNewMap().entrySet()){
//update map should contain entry with equal versions only when they are same snapshots
//(e.g. update 'appui 0.2-SNAPSHOT' to 'appui 0.2-SNAPSHOT')
//updating to same SNAPSHOT doesn't require confirmation, they are not shown
if(!updateEntry.getKey().getVersion().equals(updateEntry.getValue().getVersion())){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(UPDATE_MODULE_TMPL,
updateEntry.getKey().getArtifactId(),
updateEntry.getKey().getVersion(),
updateEntry.getValue().getVersion()));
}
}
for(Artifact addArtifact : upgradeDifferential.getModulesToAdd()){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(ADD_MODULE_TMPL,
addArtifact.getArtifactId(),
addArtifact.getVersion()));
}
if(needConfirmation){
return promptYesNo(String.format("Would you like to apply those changes to '%s'?", server.getServerId()));
}
else return true;
}
@Override
public void setAnswers(ArrayDeque<String> batchAnswers) {
this.batchAnswers = batchAnswers;
}
private String getAnswer(String question){
String answer = batchAnswers.poll();
if(answer == null){
throw new RuntimeException("Answer not provided for question: " + question);
}
return answer.trim();
}
}
| maven-plugin/src/main/java/org/openmrs/maven/plugins/utility/DefaultWizard.java | package org.openmrs.maven.plugins.utility;
import com.google.common.collect.Lists;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.http.client.utils.URIBuilder;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugin.logging.SystemStreamLog;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.codehaus.plexus.components.interactivity.Prompter;
import org.codehaus.plexus.components.interactivity.PrompterException;
import org.openmrs.maven.plugins.model.Artifact;
import org.openmrs.maven.plugins.model.DistroProperties;
import org.openmrs.maven.plugins.model.Server;
import org.openmrs.maven.plugins.model.UpgradeDifferential;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.InputStreamReader;
import java.net.URISyntaxException;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.*;
import java.util.Map.Entry;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Class for attribute helper functions
*/
@Component(role=Wizard.class)
public class DefaultWizard implements Wizard {
private static final String EMPTY_STRING = "";
private static final String NONE = "(none)";
private static final String DEFAULT_CHOICE_TMPL = "Which one do you choose?";
private static final String DEFAULT_OPTION_TMPL = "%d) %s";
private static final String DEFAULT_CUSTOM_OPTION_TMPL = "%d) Other...";
private static final String DEFAULT_SERVER_NAME = "server";
private static final String DEFAULT_VALUE_TMPL = "Please specify '%s'";
private static final String DEFAULT_VALUE_TMPL_WITH_DEFAULT = "Please specify '%s': (default: '%s')";
private static final String DEFAULT_FAIL_MESSAGE = "Server with such serverId is not exists";
private static final String INVALID_SERVER = "Invalid server Id";
private static final String YESNO = " [Y/n]";
private static final String REFERENCEAPPLICATION_2_4 = "org.openmrs.distro:referenceapplication-package:2.4";
private static final String DEFAULT_CUSTOM_DIST_ARTIFACT = "Please specify custom distribution artifact%s (default: '%s')";
private static final String CUSTOM_JDK_PATH = "Please specify a path to JDK used for running this server (-Djdk)";
private static final String SDK_PROPERTIES_FILE = "SDK Properties file";
private static final String REFAPP_OPTION_TMPL = "Reference Application %s";
private static final String REFAPP_ARTIFACT_TMPL = "org.openmrs.distro:referenceapplication-package:%s";
private static final String JDK_ERROR_TMPL = "\nThe JDK %s is not compatible with OpenMRS Platform %s. " +
"Please use %s to run this server.\n\nIf you are running " +
"in a forked mode, correct the java.home property in %s\n";
private static final String UPGRADE_CONFIRM_TMPL = "\nThe %s %s introduces the following changes:";
private static final String UPDATE_MODULE_TMPL = "^ Updates %s %s to %s";
private static final String ADD_MODULE_TMPL = "+ Adds %s %s";
private static final String NO_DIFFERENTIAL = "\nNo modules to update or add found";
public static final String PLATFORM_VERSION_PROMPT = "You can deploy the following versions of a platform";
public static final String DISTRIBUTION_VERSION_PROMPT = "You can deploy the following versions of distribution";
@Requirement
Prompter prompter;
Log log;
private boolean interactiveMode = true;
private ArrayDeque<String> batchAnswers;
public DefaultWizard(){};
public DefaultWizard(Prompter prompter) {
this.prompter = prompter;
}
@Override
public boolean isInteractiveMode() {
return interactiveMode;
}
@Override
public void setInteractiveMode(boolean interactiveMode) {
this.interactiveMode = interactiveMode;
}
/**
* Prompt for serverId, and get default serverId which is not exists,
* if serverId is not set before
*
* @param server @return
* @throws PrompterException
*/
@Override
public void promptForNewServerIfMissing(Server server) {
String defaultServerId = DEFAULT_SERVER_NAME;
int indx = 0;
while (new File(Server.getServersPath(), defaultServerId).exists()) {
indx++;
defaultServerId = DEFAULT_SERVER_NAME + String.valueOf(indx);
}
String serverId = promptForValueIfMissingWithDefault("Specify server id (-D%s) (default: '%s')", server.getServerId(), "serverId", defaultServerId);
server.setServerId(serverId);
}
/**
* Prompt for a value if it not set, and default value is set
*
* @param message
* @param value
* @param parameterName
* @param defValue
* @return value
* @throws PrompterException
*/
@Override
public String promptForValueIfMissingWithDefault(String message, String value, String parameterName, String defValue) {
String textToShow;
if (StringUtils.isBlank(defValue)){
textToShow = String.format(message != null ? message : DEFAULT_VALUE_TMPL, parameterName);
}
else {
textToShow = String.format(message != null? message : DEFAULT_VALUE_TMPL_WITH_DEFAULT, parameterName, defValue);
}
if (value != null) {
return value;
}else if(!interactiveMode){
return getAnswer(textToShow);
}
String val = prompt(textToShow);
if (StringUtils.isBlank(val)) {
val = defValue;
}
return val;
}
@Override
public String promptForMissingValueWithOptions(String message, String value, String parameterName, List<String> options){
return promptForMissingValueWithOptions(message, value, parameterName, options, null, null);
}
@Override
public String promptForMissingValueWithOptions(String message, String value, String parameterName, List<String> options, String customMessage, String customDefault){
String defaultOption = options.isEmpty()? "" : options.get(0);
String question = String.format(message != null? message : DEFAULT_VALUE_TMPL_WITH_DEFAULT, parameterName, defaultOption);
if (value != null) {
return value;
} else if(!interactiveMode){
return getAnswer(question);
}
System.out.println("\n" + question + ":");
List<Integer> choices = new ArrayList<>();
int i = 0;
for(String option : options){
i++;
System.out.println(String.format(DEFAULT_OPTION_TMPL, i, option));
choices.add(i);
}
if(customMessage != null){
i++;
System.out.println(String.format(DEFAULT_CUSTOM_OPTION_TMPL, i));
choices.add(i);
}
String choice = prompt(DEFAULT_CHOICE_TMPL + " [" + StringUtils.join(choices.iterator(), "/") + "]");
int chosenIndex = -1;
if(!StringUtils.isBlank(choice) && StringUtils.isNumeric(choice)) {
chosenIndex = Integer.parseInt(choice) - 1;
}
if(chosenIndex >= 0) {
if (chosenIndex < options.size()){
return options.get(chosenIndex);
} else if(chosenIndex == options.size() && customMessage != null) {
return promptForValueIfMissingWithDefault(customMessage, null, parameterName, customDefault);
}
}
System.out.println("\nYou must specify " + StringUtils.join(choices.iterator(), " or ") + ".");
return promptForMissingValueWithOptions(message, value, parameterName, options, customMessage, customDefault);
}
private String prompt(String textToShow){
try {
return prompter.prompt("\n" + textToShow);
} catch (PrompterException e) {
throw new RuntimeException(e);
}
}
public void showMessage(String textToShow){
System.out.println("\n" + textToShow);
}
@Override
public void showError(String textToShow) {
System.out.println("\n[ERROR]" + textToShow);
}
/**
* Prompt for a value with list of proposed values
* @param value
* @param parameterName
* @param values
* @return value
* @throws PrompterException
*/
@Override
public String promptForValueWithDefaultList(String value, String parameterName, List<String> values) {
if (value != null) return value;
String defaultValue = values.size() > 0 ? values.get(0) : NONE;
final String text = DEFAULT_VALUE_TMPL_WITH_DEFAULT + " (possible: %s)";
String val = prompt(String.format(text, parameterName, defaultValue, StringUtils.join(values.toArray(), ", ")));
if (val.equals(EMPTY_STRING)) val = defaultValue;
return val;
}
/**
* Prompt for a value if it not set, and default value is NOT set
* @param value
* @param parameterName
* @return
* @throws PrompterException
*/
@Override
public String promptForValueIfMissing(String value, String parameterName) {
return promptForValueIfMissingWithDefault(null, value, parameterName, EMPTY_STRING);
}
/**
* Print dialog Yes/No
* @param text - text to display
* @return
*/
@Override
public boolean promptYesNo(String text) {
String yesNo = null;
if(interactiveMode){
yesNo = prompt(text.concat(YESNO));
} else {
yesNo = getAnswer(text);
}
return yesNo.equals("") || yesNo.toLowerCase().equals("y");
}
/**
* Check if value is submit
* @param value
* @return
*/
@Override
public boolean checkYes(String value) {
String val = value.toLowerCase();
return val.equals("true") || val.equals("yes");
}
/**
* Get path to server by serverId and prompt if missing
* @return
* @throws MojoFailureException
*/
@Override
public String promptForExistingServerIdIfMissing(String serverId) {
File omrsHome = new File(Server.getServersPath());
List<String> servers = getListOfServers();
serverId = promptForMissingValueWithOptions("You have the following servers:", serverId, "serverId", servers);
if (serverId.equals(NONE)) {
throw new RuntimeException(INVALID_SERVER);
}
File serverPath = new File(omrsHome, serverId);
if (!serverPath.exists()) {
throw new RuntimeException("There is no server with the given server id. Please create it first using openmrs-sdk:setup.");
}
return serverId;
}
@Override
public void promptForPlatformVersionIfMissing(Server server, List<String> versions) {
String version = promptForMissingValueWithOptions(PLATFORM_VERSION_PROMPT,
server.getVersion(), "version", versions, "Please specify platform version", null);
server.setVersion(version);
}
@Override
public String promptForPlatformVersion(List<String> versions) {
String version = promptForMissingValueWithOptions(PLATFORM_VERSION_PROMPT,
null, "version", versions, "Please specify platform version", null);
return version;
}
@Override
public void promptForJavaHomeIfMissing(Server server) {
if (!StringUtils.isBlank(server.getJavaHome())) {
if (isJavaHomeValid(server.getJavaHome())) {
addJavaHomeToSdkProperties(server.getJavaHome());
return;
} else {
throw new IllegalArgumentException("The specified -DjavaHome property is invalid");
}
}
if (interactiveMode) {
List<String> paths = new ArrayList<>();
paths.add("JAVA_HOME (currently: " + System.getProperty("java.home") + ")");
paths.addAll(getJavaHomeOptions());
String path = promptForMissingValueWithOptions(SDKConstants.OPENMRS_SDK_JDK_OPTION,
server.getJavaHome(), "path", paths, SDKConstants.OPENMRS_SDK_JDK_CUSTOM, null);
String requiredJdkVersion;
String notRecommendedJdkVersion = "Not recommended";
char platformVersionNumber = server.getPlatformVersion().charAt(0);
if (platformVersionNumber == '1') {
requiredJdkVersion = "1.7";
notRecommendedJdkVersion = "1.8";
}
else {
requiredJdkVersion = "1.8";
}
// Use default JAVA_HOME
if (path.equals(paths.get(0))) {
if (System.getProperty("java.version").startsWith(requiredJdkVersion)) {
server.setJavaHome(null);
}
else if (System.getProperty("java.version").startsWith(notRecommendedJdkVersion)) {
boolean isSelectJdk7 = promptYesNo("It is not recommended to run OpenMRS platform " + server.getPlatformVersion() + " on JDK 8. Would you like to select the recommended JDK 7 instead?");
if (isSelectJdk7) {
promptForJavaHomeIfMissing(server);
}
else {
server.setJavaHome(null);
}
}
else {
showMessage("Your JAVA_HOME version doesn't fit platform requirements:");
showMessage("JAVA_HOME version: " + System.getProperty("java.version"));
showMessage("Required: " + requiredJdkVersion);
promptForJavaHomeIfMissing(server);
}
} else if (!isJavaHomeValid(path)) {
System.out.println(SDKConstants.OPENMRS_SDK_JDK_CUSTOM_INVALID);
promptForJavaHomeIfMissing(server);
} else {
String jdkUnderSpecifiedPathVersion = extractJavaVersionFromPath(path);
if (jdkUnderSpecifiedPathVersion.startsWith(requiredJdkVersion)) {
server.setJavaHome(path);
addJavaHomeToSdkProperties(path);
}
else if (jdkUnderSpecifiedPathVersion.startsWith(notRecommendedJdkVersion)) {
boolean isSelectJdk7 = promptYesNo("It is not recommended to run OpenMRS platform " + server.getPlatformVersion() + " on JDK 8. Would you like to select the recommended JDK 7 instead?");
if (isSelectJdk7) {
promptForJavaHomeIfMissing(server);
}
else {
server.setJavaHome(null);
}
}
else {
showMessage("JDK in custom path (" + path + ") doesn't match platform requirements:");
showMessage("JDK version: " + jdkUnderSpecifiedPathVersion);
showMessage("Required: " + requiredJdkVersion);
promptForJavaHomeIfMissing(server);
}
}
}
}
private String extractJavaVersionFromPath(String path) {
List<String> commands = new ArrayList<>();
commands.add("./java");
commands.add("-version");
ProcessBuilder processBuilder = new ProcessBuilder(commands);
processBuilder.redirectErrorStream(true);
processBuilder.environment().put("JAVA_HOME", path);
processBuilder.directory(new File(path.replace("/jre","/bin")));
String result = null;
try {
final Process process = processBuilder.start();
BufferedReader stdInput = new BufferedReader(new InputStreamReader(process.getInputStream()));
result = stdInput.readLine();
} catch (IOException e) {
throw new RuntimeException("Failed to fetch Java version from \"" + path + "\"");
}
Pattern p = Pattern.compile(".*\\\"(.*)\\\".*");
Matcher m = p.matcher(result);
if (m.find()) {
return m.group(1);
}
else {
return null;
}
}
private void addJavaHomeToSdkProperties(String path) {
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
Properties sdkProperties = getSdkProperties();
List<String> jdkPaths = getJavaHomeOptions();
if (!jdkPaths.contains(path)) {
if (jdkPaths.size() == 5) {
jdkPaths.set(4, path);
}
else {
jdkPaths.add(path);
}
Collections.sort(jdkPaths);
String updatedProperty = StringUtils.join(jdkPaths.iterator(), ", ");
sdkProperties.setProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS, updatedProperty);
savePropertiesChangesToFile(sdkProperties, sdkPropertiesFile, SDK_PROPERTIES_FILE);
}
}
private Properties getSdkProperties() {
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
if (!sdkPropertiesFile.exists()) {
try {
sdkPropertiesFile.createNewFile();
} catch (IOException e) {
throw new IllegalStateException("Failed to create SDK properties file in: \"" + Server.getServersPathFile() + "/" + SDKConstants.OPENMRS_SDK_PROPERTIES + "\"");
}
}
InputStream in;
try {
in = new FileInputStream(sdkPropertiesFile);
} catch (FileNotFoundException e) {
throw new IllegalStateException("SDK properties file not found at: \"" + Server.getServersPathFile() + "/" + SDKConstants.OPENMRS_SDK_PROPERTIES + "\"");
}
Properties sdkProperties = new Properties();
try {
sdkProperties.load(in);
} catch (IOException e) {
throw new IllegalStateException("Failed to load properties from file");
}
return sdkProperties;
}
private List<String> getJavaHomeOptions() {
Properties sdkProperties = getSdkProperties();
List<String> result = new ArrayList<>();
if (interactiveMode) {
String jdkHomeProperty = sdkProperties.getProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS);
if (jdkHomeProperty != null) {
for (String path: Arrays.asList(jdkHomeProperty.split("\\s*,\\s*"))) {
if (isJavaHomeValid(path)) {
result.add(path);
}
}
// Save properties
Collections.sort(result);
String updatedProperty = StringUtils.join(result.iterator(), ", ");
sdkProperties.setProperty(SDKConstants.OPENMRS_SDK_PROPERTIES_JAVA_HOME_OPTIONS, updatedProperty);
File sdkPropertiesFile = new File(Server.getServersPathFile(), SDKConstants.OPENMRS_SDK_PROPERTIES);
savePropertiesChangesToFile(sdkProperties, sdkPropertiesFile, SDK_PROPERTIES_FILE);
return result;
} else {
return new ArrayList<>();
}
}else {
return new ArrayList<>();
}
}
private boolean isJavaHomeValid(String jdkPath) {
File jdk = new File(jdkPath, "bin");
if (System.getProperty("os.name").toLowerCase().contains("windows")) {
jdk = new File(jdk, "java.exe");
} else {
jdk = new File(jdk, "java");
}
return jdk.exists();
}
private void savePropertiesChangesToFile(Properties properties, File file, String message) {
OutputStream fos = null;
try {
fos = new FileOutputStream(file);
properties.store(fos, message + ":");
fos.close();
} catch (IOException e) {
throw new IllegalStateException(e);
} finally {
IOUtils.closeQuietly(fos);
}
}
@Override
public void promptForRefAppVersionIfMissing(Server server, VersionsHelper versionsHelper) throws MojoExecutionException {
if(server.getVersion()==null){
String choice = promptForRefAppVersion(versionsHelper);
Artifact distro = DistroHelper.parseDistroArtifact(choice);
if(distro != null){
server.setVersion(distro.getVersion());
server.setDistroArtifactId(distro.getArtifactId());
server.setDistroGroupId(distro.getGroupId());
} else {
server.setDistroArtifactId(SDKConstants.REFERENCEAPPLICATION_ARTIFACT_ID);
server.setDistroGroupId(Artifact.GROUP_DISTRO);
server.setVersion(choice);
}
}
}
public String promptForRefAppVersion(VersionsHelper versionsHelper) {
int maxOptionsSize = 5;
Map<String, String> optionsMap = new LinkedHashMap<>();
Set<String> versions = new LinkedHashSet<>(versionsHelper.getVersionAdvice(SDKConstants.getReferenceModule("2.3.1"), maxOptionsSize));
versions.addAll(SDKConstants.SUPPPORTED_REFAPP_VERSIONS_2_3_1_OR_LOWER);
for(String version : versions){
optionsMap.put(String.format(REFAPP_OPTION_TMPL, version), String.format(REFAPP_ARTIFACT_TMPL, version));
if(optionsMap.size()== maxOptionsSize) break;
}
String version = promptForMissingValueWithOptions(DISTRIBUTION_VERSION_PROMPT,
null, "distribution artifact", Lists.newArrayList(optionsMap.keySet()), "Please specify %s (default: '%s')", REFERENCEAPPLICATION_2_4);
String artifact = optionsMap.get(version);
if (artifact != null) {
return artifact;
} else {
return version;
}
}
@Override
public void promptForMySQLDb(Server server) {
if(server.getDbDriver() == null){
server.setDbDriver(SDKConstants.DRIVER_MYSQL);
}
String dbUri = promptForValueIfMissingWithDefault(
"The distribution requires MySQL database. Please specify database uri (-D%s) (default: '%s')",
server.getDbUri(), "dbUri", SDKConstants.URI_MYSQL);
if (dbUri.startsWith("jdbc:mysql:")) {
dbUri = addMySQLParamsIfMissing(dbUri);
}
server.setDbUri(dbUri);
promptForDbCredentialsIfMissing(server);
}
@Override
public void promptForH2Db(Server server) {
boolean h2 = promptYesNo(
"Would you like to use the h2 database (-DdbDriver) (note that some modules do not support it)?");
if(h2) {
server.setDbDriver(SDKConstants.DRIVER_H2);
if (server.getDbUri() == null) {
server.setDbUri(SDKConstants.URI_H2);
}
server.setDbUser("root");
server.setDbPassword("root");
} else {
promptForMySQLDb(server);
}
}
@Override
public void promptForDbCredentialsIfMissing(Server server) {
String defaultUser = "root";
String user = promptForValueIfMissingWithDefault(
"Please specify database username (-D%s) (default: '%s')",
server.getDbUser(), "dbUser", defaultUser);
server.setDbUser(user);
//set password
String dbPassword = promptForValueIfMissingWithDefault(
"Please specify database password (-D%s) (default: '')",
server.getDbPassword(), "dbPassword", "");
server.setDbPassword(dbPassword);
}
/**
* Get servers with recently used first
* @return
*/
@Override
public List<String> getListOfServers() {
File openMRS = new File(Server.getServersPath());
Map<Long, String> sortedMap = new TreeMap<Long, String>(Collections.reverseOrder());
File [] list = (openMRS.listFiles() == null) ? new File[0] : openMRS.listFiles();
for (File f: list) {
if (f.isDirectory()) sortedMap.put(f.lastModified(), f.getName());
}
return new ArrayList<String>(sortedMap.values());
}
@Override
public String addMySQLParamsIfMissing(String dbUri) {
String noJdbc = dbUri.substring(5);
URIBuilder uri;
try {
uri = new URIBuilder(noJdbc);
} catch (URISyntaxException e) {
throw new IllegalArgumentException(e);
}
uri.setParameter("autoReconnect", "true");
uri.setParameter("sessionVariables", "storage_engine=InnoDB");
uri.setParameter("useUnicode", "true");
uri.setParameter("characterEncoding", "UTF-8");
return "jdbc:" + uri.toString();
}
public Log getLog() {
if(log == null){
log = new SystemStreamLog();
}
return log;
}
@Override
public void showJdkErrorMessage(String jdk, String platform, String recommendedJdk, String pathToServerProperties) {
System.out.println(String.format(JDK_ERROR_TMPL, jdk, platform, recommendedJdk, pathToServerProperties));
}
/**
* Show confirmation prompt if there is any change besides updating modules with SNAPSHOT versions
* @return
*/
@Override
public boolean promptForConfirmDistroUpgrade(UpgradeDifferential upgradeDifferential, Server server, DistroProperties distroProperties){
if(upgradeDifferential.isEmpty()){
showMessage(NO_DIFFERENTIAL);
return false;
}
boolean needConfirmation = false;
if(upgradeDifferential.getPlatformArtifact() !=null){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(UPDATE_MODULE_TMPL,
upgradeDifferential.getPlatformArtifact().getArtifactId(),
server.getPlatformVersion(),
upgradeDifferential.getPlatformArtifact().getVersion()));
}
for(Entry<Artifact, Artifact> updateEntry : upgradeDifferential.getUpdateOldToNewMap().entrySet()){
//update map should contain entry with equal versions only when they are same snapshots
//(e.g. update 'appui 0.2-SNAPSHOT' to 'appui 0.2-SNAPSHOT')
//updating to same SNAPSHOT doesn't require confirmation, they are not shown
if(!updateEntry.getKey().getVersion().equals(updateEntry.getValue().getVersion())){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(UPDATE_MODULE_TMPL,
updateEntry.getKey().getArtifactId(),
updateEntry.getKey().getVersion(),
updateEntry.getValue().getVersion()));
}
}
for(Artifact addArtifact : upgradeDifferential.getModulesToAdd()){
if(!needConfirmation){
System.out.println(String.format(UPGRADE_CONFIRM_TMPL, distroProperties.getName(), distroProperties.getServerVersion()));
needConfirmation = true;
}
System.out.println(String.format(ADD_MODULE_TMPL,
addArtifact.getArtifactId(),
addArtifact.getVersion()));
}
if(needConfirmation){
return promptYesNo(String.format("Would you like to apply those changes to '%s'?", server.getServerId()));
}
else return true;
}
@Override
public void setAnswers(ArrayDeque<String> batchAnswers) {
this.batchAnswers = batchAnswers;
}
private String getAnswer(String question){
String answer = batchAnswers.poll();
if(answer == null){
throw new RuntimeException("Answer not provided for question: " + question);
}
return answer.trim();
}
}
| SDK-126 improve resolving available distro versions logic
| maven-plugin/src/main/java/org/openmrs/maven/plugins/utility/DefaultWizard.java | SDK-126 improve resolving available distro versions logic | <ide><path>aven-plugin/src/main/java/org/openmrs/maven/plugins/utility/DefaultWizard.java
<ide> import org.apache.commons.io.IOUtils;
<ide> import org.apache.commons.lang.StringUtils;
<ide> import org.apache.http.client.utils.URIBuilder;
<add>import org.apache.maven.artifact.versioning.ArtifactVersion;
<add>import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
<ide> import org.apache.maven.plugin.MojoExecutionException;
<ide> import org.apache.maven.plugin.MojoFailureException;
<ide> import org.apache.maven.plugin.logging.Log;
<ide> import org.openmrs.maven.plugins.model.DistroProperties;
<ide> import org.openmrs.maven.plugins.model.Server;
<ide> import org.openmrs.maven.plugins.model.UpgradeDifferential;
<add>import org.openmrs.maven.plugins.model.Version;
<ide>
<ide> import java.io.BufferedReader;
<ide> import java.io.File;
<ide> Map<String, String> optionsMap = new LinkedHashMap<>();
<ide> Set<String> versions = new LinkedHashSet<>(versionsHelper.getVersionAdvice(SDKConstants.getReferenceModule("2.3.1"), maxOptionsSize));
<ide> versions.addAll(SDKConstants.SUPPPORTED_REFAPP_VERSIONS_2_3_1_OR_LOWER);
<add> List<ArtifactVersion> artifactVersions = new ArrayList<>();
<ide> for(String version : versions){
<add> artifactVersions.add(new DefaultArtifactVersion(version));
<add> }
<add> for(String version : versionsHelper.getVersionAdvice(artifactVersions, 5)){
<ide> optionsMap.put(String.format(REFAPP_OPTION_TMPL, version), String.format(REFAPP_ARTIFACT_TMPL, version));
<ide> if(optionsMap.size()== maxOptionsSize) break;
<ide> } |
|
Java | apache-2.0 | fd848c0333e265adb2314cca9be90f1cc7c4b75f | 0 | EBISPOT/goci,EBISPOT/goci,EBISPOT/goci,EBISPOT/goci,EBISPOT/goci,EBISPOT/goci | package uk.ac.ebi.spot.goci.service;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import uk.ac.ebi.spot.goci.model.Study;
import uk.ac.ebi.spot.goci.repository.StudyRepository;
import java.util.Collection;
import java.util.List;
/**
* Javadocs go here!
*
* @author Tony Burdett
* @date 16/01/15
*/
@Service
public class StudyService {
private StudyRepository studyRepository;
private final Logger log = LoggerFactory.getLogger(getClass());
@Autowired
public StudyService(StudyRepository studyRepository) {
this.studyRepository = studyRepository;
}
protected Logger getLog() {
return log;
}
/**
* A facade service around a {@link uk.ac.ebi.spot.goci.repository.SingleNucleotidePolymorphismRepository} that
* retrieves all SNPs, and then within the same datasource transaction additionally loads other objects referenced
* by this SNP (so Genes and Regions).
* <p>
* Use this when you know you will need deep information about a SNP and do not have an open session that can be
* used to lazy load extra data.
*
* @return a list of SingleNucleotidePolymorphisms
*/
@Transactional(readOnly = true)
public List<Study> deepFindAll() {
List<Study> allStudies = studyRepository.findAll();
// iterate over all studies and grab trait info
getLog().info("Obtained " + allStudies.size() + " studies, starting deep load...");
allStudies.forEach(this::loadAssociatedData);
return allStudies;
}
@Transactional(readOnly = true)
public List<Study> deepFindAll(Sort sort) {
List<Study> studies = studyRepository.findAll(sort);
// iterate over all studies and grab region info
getLog().info("Obtained " + studies.size() + " studies, starting deep load...");
studies.forEach(this::loadAssociatedData);
return studies;
}
@Transactional(readOnly = true)
public Page<Study> deepFindAll(Pageable pageable) {
Page<Study> studies = studyRepository.findAll(pageable);
// iterate over all studies and grab region info
getLog().info("Obtained " + studies.getSize() + " studies, starting deep load...");
studies.forEach(this::loadAssociatedData);
return studies;
}
@Transactional(readOnly = true)
public Study deepFetchOne(Study study) {
loadAssociatedData(study);
return study;
}
@Transactional(readOnly = true)
public Collection<Study> deepFetchAll(Collection<Study> studies) {
studies.forEach(this::loadAssociatedData);
return studies;
}
public void loadAssociatedData(Study study) {
int efoTraitCount = study.getEfoTraits().size();
getLog().info(
"Study '" + study.getId() + "' is mapped to " + efoTraitCount + " traits");
}
}
| goci-core/goci-service/src/main/java/uk/ac/ebi/spot/goci/service/StudyService.java | package uk.ac.ebi.spot.goci.service;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import uk.ac.ebi.spot.goci.model.Study;
import uk.ac.ebi.spot.goci.repository.StudyRepository;
import java.util.Collection;
import java.util.List;
/**
* Javadocs go here!
*
* @author Tony Burdett
* @date 16/01/15
*/
@Service
public class StudyService {
private StudyRepository studyRepository;
private final Logger log = LoggerFactory.getLogger(getClass());
@Autowired
public StudyService(StudyRepository studyRepository) {
this.studyRepository = studyRepository;
}
protected Logger getLog() {
return log;
}
/**
* A facade service around a {@link uk.ac.ebi.spot.goci.repository.SingleNucleotidePolymorphismRepository} that
* retrieves all SNPs, and then within the same datasource transaction additionally loads other objects referenced
* by this SNP (so Genes and Regions).
* <p>
* Use this when you know you will need deep information about a SNP and do not have an open session that can be
* used to lazy load extra data.
*
* @return a list of SingleNucleotidePolymorphisms
*/
@Transactional(readOnly = true)
public List<Study> deepFindAll() {
List<Study> allSnps = studyRepository.findAll();
// iterate over all Snps and grab region info
getLog().info("Obtained " + allSnps.size() + " SNPs, starting deep load...");
allSnps.forEach(this::loadAssociatedData);
return allSnps;
}
@Transactional(readOnly = true)
public List<Study> deepFindAll(Sort sort) {
List<Study> allSnps = studyRepository.findAll(sort);
// iterate over all Snps and grab region info
getLog().info("Obtained " + allSnps.size() + " SNPs, starting deep load...");
allSnps.forEach(this::loadAssociatedData);
return allSnps;
}
@Transactional(readOnly = true)
public Page<Study> deepFindAll(Pageable pageable) {
Page<Study> allSnps = studyRepository.findAll(pageable);
// iterate over all Snps and grab region info
getLog().info("Obtained " + allSnps.getSize() + " SNPs, starting deep load...");
allSnps.forEach(this::loadAssociatedData);
return allSnps;
}
@Transactional(readOnly = true)
public Study deepFetchOne(Study study) {
loadAssociatedData(study);
return study;
}
@Transactional(readOnly = true)
public Collection<Study> deepFetchAll(Collection<Study> studies) {
studies.forEach(this::loadAssociatedData);
return studies;
}
public void loadAssociatedData(Study study) {
int efoTraitCount = study.getEfoTraits().size();
getLog().info(
"Study '" + study.getId() + "' is mapped to " + efoTraitCount + " traits");
}
}
| renaming in study service, copy 'n' paste hangover!
| goci-core/goci-service/src/main/java/uk/ac/ebi/spot/goci/service/StudyService.java | renaming in study service, copy 'n' paste hangover! | <ide><path>oci-core/goci-service/src/main/java/uk/ac/ebi/spot/goci/service/StudyService.java
<ide> */
<ide> @Transactional(readOnly = true)
<ide> public List<Study> deepFindAll() {
<del> List<Study> allSnps = studyRepository.findAll();
<del> // iterate over all Snps and grab region info
<del> getLog().info("Obtained " + allSnps.size() + " SNPs, starting deep load...");
<del> allSnps.forEach(this::loadAssociatedData);
<del> return allSnps;
<add> List<Study> allStudies = studyRepository.findAll();
<add> // iterate over all studies and grab trait info
<add> getLog().info("Obtained " + allStudies.size() + " studies, starting deep load...");
<add> allStudies.forEach(this::loadAssociatedData);
<add> return allStudies;
<ide> }
<ide>
<ide> @Transactional(readOnly = true)
<ide> public List<Study> deepFindAll(Sort sort) {
<del> List<Study> allSnps = studyRepository.findAll(sort);
<del> // iterate over all Snps and grab region info
<del> getLog().info("Obtained " + allSnps.size() + " SNPs, starting deep load...");
<del> allSnps.forEach(this::loadAssociatedData);
<del> return allSnps;
<add> List<Study> studies = studyRepository.findAll(sort);
<add> // iterate over all studies and grab region info
<add> getLog().info("Obtained " + studies.size() + " studies, starting deep load...");
<add> studies.forEach(this::loadAssociatedData);
<add> return studies;
<ide> }
<ide>
<ide> @Transactional(readOnly = true)
<ide> public Page<Study> deepFindAll(Pageable pageable) {
<del> Page<Study> allSnps = studyRepository.findAll(pageable);
<del> // iterate over all Snps and grab region info
<del> getLog().info("Obtained " + allSnps.getSize() + " SNPs, starting deep load...");
<del> allSnps.forEach(this::loadAssociatedData);
<del> return allSnps;
<add> Page<Study> studies = studyRepository.findAll(pageable);
<add> // iterate over all studies and grab region info
<add> getLog().info("Obtained " + studies.getSize() + " studies, starting deep load...");
<add> studies.forEach(this::loadAssociatedData);
<add> return studies;
<ide> }
<ide>
<ide> @Transactional(readOnly = true) |
|
Java | apache-2.0 | 351f4caaaefc72e67cbc16f09509e4d79c04985d | 0 | nabilzhang/enunciate,nabilzhang/enunciate,nabilzhang/enunciate,nabilzhang/enunciate,nabilzhang/enunciate,nabilzhang/enunciate,nabilzhang/enunciate | /**
* Copyright © 2006-2016 Web Cohesion ([email protected])
*
* 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.webcohesion.enunciate.modules.spring_web.model;
import com.webcohesion.enunciate.facets.Facet;
import com.webcohesion.enunciate.facets.HasFacets;
import com.webcohesion.enunciate.javac.decorations.element.DecoratedTypeElement;
import com.webcohesion.enunciate.javac.decorations.type.TypeVariableContext;
import com.webcohesion.enunciate.modules.spring_web.EnunciateSpringWebContext;
import org.springframework.web.bind.annotation.RequestMethod;
import javax.annotation.security.RolesAllowed;
import javax.lang.model.element.*;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import java.lang.annotation.IncompleteAnnotationException;
import java.util.*;
/**
* A Spring web controller.
*
* @author Ryan Heaton
*/
public class SpringController extends DecoratedTypeElement implements HasFacets {
private final EnunciateSpringWebContext context;
private final Set<String> paths;
private final Set<String> consumesMime;
private final Set<String> producesMime;
private final org.springframework.web.bind.annotation.RequestMapping mappingInfo;
private final List<RequestMapping> requestMappings;
private final Set<Facet> facets = new TreeSet<Facet>();
public SpringController(TypeElement delegate, EnunciateSpringWebContext context) {
this(delegate, delegate.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class), context);
}
private SpringController(TypeElement delegate, org.springframework.web.bind.annotation.RequestMapping mappingInfo, EnunciateSpringWebContext context) {
this(delegate, loadPaths(mappingInfo), mappingInfo, context);
}
private static Set<String> loadPaths(org.springframework.web.bind.annotation.RequestMapping mappingInfo) {
TreeSet<String> paths = new TreeSet<String>();
if (mappingInfo != null) {
try {
paths.addAll(Arrays.asList(mappingInfo.path()));
}
catch (IncompleteAnnotationException e) {
//fall through; 'mappingInfo.path' was added in 4.2.
}
paths.addAll(Arrays.asList(mappingInfo.value()));
}
if (paths.isEmpty()) {
paths.add("");
}
return paths;
}
private SpringController(TypeElement delegate, Set<String> paths, org.springframework.web.bind.annotation.RequestMapping mappingInfo, EnunciateSpringWebContext context) {
super(delegate, context.getContext().getProcessingEnvironment());
this.context = context;
this.paths = paths;
this.mappingInfo = mappingInfo;
Set<String> consumes = new TreeSet<String>();
if (mappingInfo != null && mappingInfo.consumes().length > 0) {
for (String mt : mappingInfo.consumes()) {
if (mt.startsWith("!")) {
continue;
}
int colonIndex = mt.indexOf(';');
if (colonIndex > 0) {
mt = mt.substring(0, colonIndex);
}
consumes.add(mt);
}
}
else {
consumes.add("*/*");
}
this.consumesMime = Collections.unmodifiableSet(consumes);
Set<String> produces = new TreeSet<String>();
if (mappingInfo != null && mappingInfo.produces().length > 0) {
for (String mt : mappingInfo.produces()) {
if (mt.startsWith("!")) {
continue;
}
int colonIndex = mt.indexOf(';');
if (colonIndex > 0) {
mt = mt.substring(0, colonIndex);
}
produces.add(mt);
}
}
else {
produces.add("*/*");
}
this.producesMime = Collections.unmodifiableSet(produces);
this.facets.addAll(Facet.gatherFacets(delegate, context.getContext()));
this.requestMappings = Collections.unmodifiableList(getRequestMappings(delegate, new TypeVariableContext(), context));
}
/**
* Get all the resource methods for the specified type.
*
* @param delegate The type.
* @param context The context
* @return The resource methods.
*/
protected List<RequestMapping> getRequestMappings(final TypeElement delegate, TypeVariableContext variableContext, EnunciateSpringWebContext context) {
if (delegate == null || delegate.getQualifiedName().toString().equals(Object.class.getName())) {
return Collections.emptyList();
}
ArrayList<RequestMapping> requestMappings = new ArrayList<RequestMapping>();
for (ExecutableElement method : ElementFilter.methodsIn(delegate.getEnclosedElements())) {
RequestMethod[] requestMethods = findRequestMethods(method);
if (requestMethods != null) {
String[] consumes = findConsumes(method);
String[] produces = findProduces(method);
Set<String> subpaths = findSubpaths(method);
if (subpaths.isEmpty()) {
subpaths.add("");
}
for (String path : getPaths()) {
for (String subpath : subpaths) {
requestMappings.add(new RequestMapping(extractPathComponents(path + subpath), requestMethods, consumes, produces, method, this, variableContext, context));
}
}
if (requestMappings.isEmpty()) {
requestMappings.add(new RequestMapping(new ArrayList<PathSegment>(), requestMethods, consumes, produces, method, this, variableContext, context));
}
}
}
//some methods may be specified by a superclass and/or implemented interface. But the annotations on the current class take precedence.
for (TypeMirror interfaceType : delegate.getInterfaces()) {
if (interfaceType instanceof DeclaredType) {
DeclaredType declared = (DeclaredType) interfaceType;
TypeElement element = (TypeElement) declared.asElement();
List<RequestMapping> interfaceMethods = getRequestMappings(element, variableContext.push(element.getTypeParameters(), declared.getTypeArguments()), context);
for (RequestMapping interfaceMethod : interfaceMethods) {
if (!isOverridden(interfaceMethod, requestMappings)) {
requestMappings.add(interfaceMethod);
}
}
}
}
if (delegate.getKind() == ElementKind.CLASS) {
TypeMirror superclass = delegate.getSuperclass();
if (superclass instanceof DeclaredType && ((DeclaredType)superclass).asElement() != null) {
DeclaredType declared = (DeclaredType) superclass;
TypeElement element = (TypeElement) declared.asElement();
List<RequestMapping> superMethods = getRequestMappings(element, variableContext.push(element.getTypeParameters(), declared.getTypeArguments()), context);
for (RequestMapping superMethod : superMethods) {
if (!isOverridden(superMethod, requestMappings)) {
requestMappings.add(superMethod);
}
}
}
}
return requestMappings;
}
private RequestMethod[] findRequestMethods(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.method();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.method();
}
}
}
}
}
}
return null;
}
private String[] findConsumes(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.consumes();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("consumes")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
String[] consumes = new String[((List)value).size()];
for (int i = 0; i < ((List) value).size(); i++) {
Object valueItem = ((List) value).get(i);
consumes[i] = valueItem.toString();
}
return consumes;
}
}
}
}
}
}
}
}
}
return null;
}
private Set<String> findSubpaths(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Set<String> subpaths = new TreeSet<String>();
try {
subpaths.addAll(Arrays.asList(requestMapping.path()));
}
catch (IncompleteAnnotationException e) {
//fall through; 'mappingInfo.path' was added in 4.2.
}
subpaths.addAll(Arrays.asList(requestMapping.value()));
return subpaths;
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Set<String> subpaths = new TreeSet<String>();
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("value") || entry.getKey().getSimpleName().contentEquals("path")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
for (int i = 0; i < ((List) value).size(); i++) {
AnnotationValue valueItem = (AnnotationValue) ((List) value).get(i);
subpaths.add(String.valueOf(valueItem.getValue()));
}
}
}
}
return subpaths;
}
}
}
}
}
}
return null;
}
private String[] findProduces(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.produces();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("produces")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
String[] produces = new String[((List)value).size()];
for (int i = 0; i < ((List) value).size(); i++) {
Object valueItem = ((List) value).get(i);
produces[i] = valueItem.toString();
}
return produces;
}
}
}
}
}
}
}
}
}
return null;
}
/**
* Extracts out the components of a path.
*
* @param path The path.
*/
protected static List<PathSegment> extractPathComponents(String path) {
List<PathSegment> components = new ArrayList<PathSegment>();
if (path != null) {
StringBuilder value = new StringBuilder();
if (!path.startsWith("/")) {
value.append("/");//first path segment should always start with "/"
}
StringBuilder variable = new StringBuilder();
StringBuilder regexp = new StringBuilder();
int inBrace = 0;
boolean definingRegexp = false;
for (int i = 0; i < path.length(); i++) {
char ch = path.charAt(i);
if (ch == '{') {
inBrace++;
if (inBrace == 1) {
//outer brace defines new path segment
if (value.length() > 0) {
components.add(new PathSegment(value.toString(), variable.length() > 0 ? variable.toString() : null, regexp.length() > 0 ? regexp.toString() : null));
}
value = new StringBuilder();
variable = new StringBuilder();
regexp = new StringBuilder();
}
}
else if (ch == '}') {
inBrace--;
if (inBrace == 0) {
definingRegexp = false;
}
}
else if (inBrace == 1 && ch == ':') {
definingRegexp = true;
continue;
}
else if (!definingRegexp && !Character.isWhitespace(ch) && inBrace > 0) {
variable.append(ch);
}
if (definingRegexp) {
regexp.append(ch);
}
else if (!Character.isWhitespace(ch)) {
value.append(ch);
}
}
if (value.length() > 0) {
components.add(new PathSegment(value.toString(), variable.length() > 0 ? variable.toString() : null, regexp.length() > 0 ? regexp.toString() : null));
}
}
return components;
}
/**
* Whether the specified method is overridden by any of the methods in the specified list.
*
* @param method The method.
* @param resourceMethods The method list.
* @return If the methdo is overridden by any of the methods in the list.
*/
protected boolean isOverridden(ExecutableElement method, ArrayList<? extends ExecutableElement> resourceMethods) {
Elements decls = this.env.getElementUtils();
for (ExecutableElement resourceMethod : resourceMethods) {
if (decls.overrides(resourceMethod, method, (TypeElement) resourceMethod.getEnclosingElement())) {
return true;
}
}
return false;
}
public EnunciateSpringWebContext getContext() {
return context;
}
/**
* The path to this resource.
*
* @return The path to this resource.
*/
public final Set<String> getPaths() {
return this.paths;
}
/**
* The MIME types that the methods on this resource consumes (possibly overridden).
*
* @return The MIME types that the methods on this resource consumes.
*/
public Set<String> getConsumesMime() {
return consumesMime;
}
/**
* The MIME types that the methods on this resource consumes (possibly overridden).
*
* @return The MIME types that the methods on this resource consumes.
*/
public Set<String> getProducesMime() {
return producesMime;
}
/**
* The resource methods.
*
* @return The resource methods.
*/
public List<RequestMapping> getRequestMappings() {
return requestMappings;
}
/**
* The facets here applicable.
*
* @return The facets here applicable.
*/
public Set<Facet> getFacets() {
return facets;
}
/**
* Get the request methods applicable to this controller.
*
* @return The request methods applicable to this controller.
*/
public Set<RequestMethod> getApplicableMethods() {
EnumSet<RequestMethod> applicableMethods = EnumSet.allOf(RequestMethod.class);
if (this.mappingInfo != null) {
RequestMethod[] methods = this.mappingInfo.method();
if (methods.length > 0) {
applicableMethods.retainAll(Arrays.asList(methods));
}
}
return applicableMethods;
}
/**
* The security roles for this resource.
*
* @return The security roles for this resource.
*/
public Set<String> getSecurityRoles() {
TreeSet<String> roles = new TreeSet<String>();
RolesAllowed rolesAllowed = getAnnotation(RolesAllowed.class);
if (rolesAllowed != null) {
Collections.addAll(roles, rolesAllowed.value());
}
return roles;
}
}
| spring-web/src/main/java/com/webcohesion/enunciate/modules/spring_web/model/SpringController.java | /**
* Copyright © 2006-2016 Web Cohesion ([email protected])
*
* 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.webcohesion.enunciate.modules.spring_web.model;
import com.webcohesion.enunciate.facets.Facet;
import com.webcohesion.enunciate.facets.HasFacets;
import com.webcohesion.enunciate.javac.decorations.element.DecoratedTypeElement;
import com.webcohesion.enunciate.javac.decorations.type.TypeVariableContext;
import com.webcohesion.enunciate.modules.spring_web.EnunciateSpringWebContext;
import org.springframework.web.bind.annotation.RequestMethod;
import javax.annotation.security.RolesAllowed;
import javax.lang.model.element.*;
import javax.lang.model.type.DeclaredType;
import javax.lang.model.type.TypeMirror;
import javax.lang.model.util.ElementFilter;
import javax.lang.model.util.Elements;
import java.lang.annotation.IncompleteAnnotationException;
import java.util.*;
/**
* A Spring web controller.
*
* @author Ryan Heaton
*/
public class SpringController extends DecoratedTypeElement implements HasFacets {
private final EnunciateSpringWebContext context;
private final Set<String> paths;
private final Set<String> consumesMime;
private final Set<String> producesMime;
private final org.springframework.web.bind.annotation.RequestMapping mappingInfo;
private final List<RequestMapping> requestMappings;
private final Set<Facet> facets = new TreeSet<Facet>();
public SpringController(TypeElement delegate, EnunciateSpringWebContext context) {
this(delegate, delegate.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class), context);
}
private SpringController(TypeElement delegate, org.springframework.web.bind.annotation.RequestMapping mappingInfo, EnunciateSpringWebContext context) {
this(delegate, loadPaths(mappingInfo), mappingInfo, context);
}
private static Set<String> loadPaths(org.springframework.web.bind.annotation.RequestMapping mappingInfo) {
TreeSet<String> paths = new TreeSet<String>();
if (mappingInfo != null) {
try {
paths.addAll(Arrays.asList(mappingInfo.path()));
}
catch (IncompleteAnnotationException e) {
//fall through; 'mappingInfo.path' was added in 4.2.
}
paths.addAll(Arrays.asList(mappingInfo.value()));
}
if (paths.isEmpty()) {
paths.add("");
}
return paths;
}
private SpringController(TypeElement delegate, Set<String> paths, org.springframework.web.bind.annotation.RequestMapping mappingInfo, EnunciateSpringWebContext context) {
super(delegate, context.getContext().getProcessingEnvironment());
this.context = context;
this.paths = paths;
this.mappingInfo = mappingInfo;
Set<String> consumes = new TreeSet<String>();
if (mappingInfo != null && mappingInfo.consumes().length > 0) {
for (String mt : mappingInfo.consumes()) {
if (mt.startsWith("!")) {
continue;
}
int colonIndex = mt.indexOf(';');
if (colonIndex > 0) {
mt = mt.substring(0, colonIndex);
}
consumes.add(mt);
}
}
else {
consumes.add("*/*");
}
this.consumesMime = Collections.unmodifiableSet(consumes);
Set<String> produces = new TreeSet<String>();
if (mappingInfo != null && mappingInfo.produces().length > 0) {
for (String mt : mappingInfo.produces()) {
if (mt.startsWith("!")) {
continue;
}
int colonIndex = mt.indexOf(';');
if (colonIndex > 0) {
mt = mt.substring(0, colonIndex);
}
produces.add(mt);
}
}
else {
produces.add("*/*");
}
this.producesMime = Collections.unmodifiableSet(produces);
this.facets.addAll(Facet.gatherFacets(delegate, context.getContext()));
this.requestMappings = Collections.unmodifiableList(getRequestMappings(delegate, new TypeVariableContext(), context));
}
/**
* Get all the resource methods for the specified type.
*
* @param delegate The type.
* @param context The context
* @return The resource methods.
*/
protected List<RequestMapping> getRequestMappings(final TypeElement delegate, TypeVariableContext variableContext, EnunciateSpringWebContext context) {
if (delegate == null || delegate.getQualifiedName().toString().equals(Object.class.getName())) {
return Collections.emptyList();
}
ArrayList<RequestMapping> requestMappings = new ArrayList<RequestMapping>();
for (ExecutableElement method : ElementFilter.methodsIn(delegate.getEnclosedElements())) {
RequestMethod[] requestMethods = findRequestMethods(method);
if (requestMethods != null) {
String[] consumes = findConsumes(method);
String[] produces = findProduces(method);
Set<String> subpaths = findSubpaths(method);
if (subpaths.isEmpty()) {
subpaths.add("");
}
for (String path : getPaths()) {
for (String subpath : subpaths) {
requestMappings.add(new RequestMapping(extractPathComponents(path + subpath), requestMethods, consumes, produces, method, this, variableContext, context));
}
}
if (requestMappings.isEmpty()) {
requestMappings.add(new RequestMapping(new ArrayList<PathSegment>(), requestMethods, consumes, produces, method, this, variableContext, context));
}
}
}
//some methods may be specified by a superclass and/or implemented interface. But the annotations on the current class take precedence.
for (TypeMirror interfaceType : delegate.getInterfaces()) {
if (interfaceType instanceof DeclaredType) {
DeclaredType declared = (DeclaredType) interfaceType;
TypeElement element = (TypeElement) declared.asElement();
List<RequestMapping> interfaceMethods = getRequestMappings(element, variableContext.push(element.getTypeParameters(), declared.getTypeArguments()), context);
for (RequestMapping interfaceMethod : interfaceMethods) {
if (!isOverridden(interfaceMethod, requestMappings)) {
requestMappings.add(interfaceMethod);
}
}
}
}
if (delegate.getKind() == ElementKind.CLASS) {
TypeMirror superclass = delegate.getSuperclass();
if (superclass instanceof DeclaredType && ((DeclaredType)superclass).asElement() != null) {
DeclaredType declared = (DeclaredType) superclass;
TypeElement element = (TypeElement) declared.asElement();
List<RequestMapping> superMethods = getRequestMappings(element, variableContext.push(element.getTypeParameters(), declared.getTypeArguments()), context);
for (RequestMapping superMethod : superMethods) {
if (!isOverridden(superMethod, requestMappings)) {
requestMappings.add(superMethod);
}
}
}
}
return requestMappings;
}
private RequestMethod[] findRequestMethods(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.method();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.method();
}
}
}
}
}
}
return null;
}
private String[] findConsumes(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.consumes();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("consumes")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
String[] consumes = new String[((List)value).size()];
for (int i = 0; i < ((List) value).size(); i++) {
Object valueItem = ((List) value).get(i);
consumes[i] = valueItem.toString();
}
return consumes;
}
}
}
}
}
}
}
}
}
return null;
}
private Set<String> findSubpaths(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Set<String> subpaths = new TreeSet<String>();
try {
subpaths.addAll(Arrays.asList(requestMapping.path()));
}
catch (IncompleteAnnotationException e) {
//fall through; 'mappingInfo.path' was added in 4.2.
}
subpaths.addAll(Arrays.asList(requestMapping.value()));
return subpaths;
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Set<String> subpaths = new TreeSet<String>();
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("value") || entry.getKey().getSimpleName().contentEquals("path")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
for (int i = 0; i < ((List) value).size(); i++) {
Object valueItem = ((List) value).get(i);
subpaths.add(valueItem.toString());
}
}
}
}
return subpaths;
}
}
}
}
}
}
return null;
}
private String[] findProduces(ExecutableElement method) {
org.springframework.web.bind.annotation.RequestMapping requestMapping = method.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
return requestMapping.produces();
}
else {
List<? extends AnnotationMirror> annotations = method.getAnnotationMirrors();
if (annotations != null) {
for (AnnotationMirror annotation : annotations) {
DeclaredType annotationType = annotation.getAnnotationType();
if (annotationType != null) {
Element annotationElement = annotationType.asElement();
if (annotationElement != null) {
requestMapping = annotationElement.getAnnotation(org.springframework.web.bind.annotation.RequestMapping.class);
if (requestMapping != null) {
Map<? extends ExecutableElement, ? extends AnnotationValue> elementValues = annotation.getElementValues();
for (Map.Entry<? extends ExecutableElement, ? extends AnnotationValue> entry : elementValues.entrySet()) {
if (entry.getKey().getSimpleName().contentEquals("produces")) {
Object value = entry.getValue().getValue();
if (value instanceof List) {
String[] produces = new String[((List)value).size()];
for (int i = 0; i < ((List) value).size(); i++) {
Object valueItem = ((List) value).get(i);
produces[i] = valueItem.toString();
}
return produces;
}
}
}
}
}
}
}
}
}
return null;
}
/**
* Extracts out the components of a path.
*
* @param path The path.
*/
protected static List<PathSegment> extractPathComponents(String path) {
List<PathSegment> components = new ArrayList<PathSegment>();
if (path != null) {
StringBuilder value = new StringBuilder();
if (!path.startsWith("/")) {
value.append("/");//first path segment should always start with "/"
}
StringBuilder variable = new StringBuilder();
StringBuilder regexp = new StringBuilder();
int inBrace = 0;
boolean definingRegexp = false;
for (int i = 0; i < path.length(); i++) {
char ch = path.charAt(i);
if (ch == '{') {
inBrace++;
if (inBrace == 1) {
//outer brace defines new path segment
if (value.length() > 0) {
components.add(new PathSegment(value.toString(), variable.length() > 0 ? variable.toString() : null, regexp.length() > 0 ? regexp.toString() : null));
}
value = new StringBuilder();
variable = new StringBuilder();
regexp = new StringBuilder();
}
}
else if (ch == '}') {
inBrace--;
if (inBrace == 0) {
definingRegexp = false;
}
}
else if (inBrace == 1 && ch == ':') {
definingRegexp = true;
continue;
}
else if (!definingRegexp && !Character.isWhitespace(ch) && inBrace > 0) {
variable.append(ch);
}
if (definingRegexp) {
regexp.append(ch);
}
else if (!Character.isWhitespace(ch)) {
value.append(ch);
}
}
if (value.length() > 0) {
components.add(new PathSegment(value.toString(), variable.length() > 0 ? variable.toString() : null, regexp.length() > 0 ? regexp.toString() : null));
}
}
return components;
}
/**
* Whether the specified method is overridden by any of the methods in the specified list.
*
* @param method The method.
* @param resourceMethods The method list.
* @return If the methdo is overridden by any of the methods in the list.
*/
protected boolean isOverridden(ExecutableElement method, ArrayList<? extends ExecutableElement> resourceMethods) {
Elements decls = this.env.getElementUtils();
for (ExecutableElement resourceMethod : resourceMethods) {
if (decls.overrides(resourceMethod, method, (TypeElement) resourceMethod.getEnclosingElement())) {
return true;
}
}
return false;
}
public EnunciateSpringWebContext getContext() {
return context;
}
/**
* The path to this resource.
*
* @return The path to this resource.
*/
public final Set<String> getPaths() {
return this.paths;
}
/**
* The MIME types that the methods on this resource consumes (possibly overridden).
*
* @return The MIME types that the methods on this resource consumes.
*/
public Set<String> getConsumesMime() {
return consumesMime;
}
/**
* The MIME types that the methods on this resource consumes (possibly overridden).
*
* @return The MIME types that the methods on this resource consumes.
*/
public Set<String> getProducesMime() {
return producesMime;
}
/**
* The resource methods.
*
* @return The resource methods.
*/
public List<RequestMapping> getRequestMappings() {
return requestMappings;
}
/**
* The facets here applicable.
*
* @return The facets here applicable.
*/
public Set<Facet> getFacets() {
return facets;
}
/**
* Get the request methods applicable to this controller.
*
* @return The request methods applicable to this controller.
*/
public Set<RequestMethod> getApplicableMethods() {
EnumSet<RequestMethod> applicableMethods = EnumSet.allOf(RequestMethod.class);
if (this.mappingInfo != null) {
RequestMethod[] methods = this.mappingInfo.method();
if (methods.length > 0) {
applicableMethods.retainAll(Arrays.asList(methods));
}
}
return applicableMethods;
}
/**
* The security roles for this resource.
*
* @return The security roles for this resource.
*/
public Set<String> getSecurityRoles() {
TreeSet<String> roles = new TreeSet<String>();
RolesAllowed rolesAllowed = getAnnotation(RolesAllowed.class);
if (rolesAllowed != null) {
Collections.addAll(roles, rolesAllowed.value());
}
return roles;
}
}
| Strip quotes in path segments when using spring shortcut annotations. Fixes #533.
| spring-web/src/main/java/com/webcohesion/enunciate/modules/spring_web/model/SpringController.java | Strip quotes in path segments when using spring shortcut annotations. Fixes #533. | <ide><path>pring-web/src/main/java/com/webcohesion/enunciate/modules/spring_web/model/SpringController.java
<ide> Object value = entry.getValue().getValue();
<ide> if (value instanceof List) {
<ide> for (int i = 0; i < ((List) value).size(); i++) {
<del> Object valueItem = ((List) value).get(i);
<del> subpaths.add(valueItem.toString());
<add> AnnotationValue valueItem = (AnnotationValue) ((List) value).get(i);
<add> subpaths.add(String.valueOf(valueItem.getValue()));
<ide> }
<ide> }
<ide> } |
|
Java | agpl-3.0 | 43cd60f97ffa5c6ca600bb0c83736b5f541be3fc | 0 | mnip91/proactive-component-monitoring,acontes/programming,acontes/programming,fviale/programming,lpellegr/programming,paraita/programming,paraita/programming,PaulKh/scale-proactive,ow2-proactive/programming,acontes/programming,mnip91/proactive-component-monitoring,jrochas/scale-proactive,fviale/programming,jrochas/scale-proactive,fviale/programming,PaulKh/scale-proactive,lpellegr/programming,paraita/programming,mnip91/proactive-component-monitoring,lpellegr/programming,paraita/programming,mnip91/programming-multiactivities,jrochas/scale-proactive,mnip91/proactive-component-monitoring,acontes/programming,acontes/programming,acontes/programming,jrochas/scale-proactive,fviale/programming,PaulKh/scale-proactive,PaulKh/scale-proactive,mnip91/programming-multiactivities,ow2-proactive/programming,PaulKh/scale-proactive,lpellegr/programming,mnip91/programming-multiactivities,jrochas/scale-proactive,mnip91/programming-multiactivities,jrochas/scale-proactive,ow2-proactive/programming,fviale/programming,mnip91/programming-multiactivities,PaulKh/scale-proactive,mnip91/proactive-component-monitoring,mnip91/proactive-component-monitoring,paraita/programming,ow2-proactive/programming,ow2-proactive/programming,lpellegr/programming,fviale/programming,lpellegr/programming,jrochas/scale-proactive,acontes/programming,ow2-proactive/programming,paraita/programming,mnip91/programming-multiactivities,PaulKh/scale-proactive | /*
* ################################################################
*
* ProActive: The Java(TM) library for Parallel, Distributed,
* Concurrent computing with Security and Mobility
*
* Copyright (C) 1997-2009 INRIA/University of Nice-Sophia Antipolis
* Contact: [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version
* 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*
* Initial developer(s): The ProActive Team
* http://proactive.inria.fr/team_members.htm
* Contributor(s):
*
* ################################################################
* $$PROACTIVE_INITIAL_DEV$$
*/
package org.objectweb.proactive.ic2d.jmxmonitoring.dialog;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.InetAddress;
import java.net.URI;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.layout.FormLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.objectweb.proactive.core.Constants;
import org.objectweb.proactive.core.config.PAProperties;
import org.objectweb.proactive.core.config.ProActiveConfiguration;
import org.objectweb.proactive.core.remoteobject.RemoteObjectHelper;
import org.objectweb.proactive.core.util.ProActiveInet;
import org.objectweb.proactive.core.util.URIBuilder;
import org.objectweb.proactive.ic2d.console.Console;
import org.objectweb.proactive.ic2d.jmxmonitoring.Activator;
import org.objectweb.proactive.ic2d.jmxmonitoring.data.WorldObject;
import org.objectweb.proactive.ic2d.jmxmonitoring.util.IC2DThreadPool;
public class MonitorNewHostDialog extends Dialog {
private Shell shell = null;
//private Shell parent = null;
private Combo hostCombo;
private Text portText;
private Combo protocolCombo;
private Text depthText;
private Button okButton;
private Button cancelButton;
/** The World */
private WorldObject world;
/** Host name */
String initialHostValue = "localhost";
// Name of the file
String file = ".urls";
// <hostName,url>
Map<String, String> urls = new HashMap<String, String>();
//
// -- CONSTRUCTORS -----------------------------------------------
//
public MonitorNewHostDialog(Shell parent, WorldObject world) {
// Pass the default styles here
super(parent, SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL);
//this.parent = parent;
this.world = world;
String port = "";
/* Get the machine's name */
initialHostValue = ProActiveInet.getInstance().getHostname();
/* Load the proactive default configuration */
ProActiveConfiguration.load();
/* Get the machine's port */
port = PAProperties.PA_RMI_PORT.getValue();
/* Init the display */
Display display = getParent().getDisplay();
/* Init the shell */
shell = new Shell(getParent(), SWT.BORDER | SWT.CLOSE);
shell.setText("Adding host and depth to monitor");
FormLayout layout = new FormLayout();
layout.marginHeight = 5;
layout.marginWidth = 5;
shell.setLayout(layout);
////// group "Host to monitor"
Group hostGroup = new Group(shell, SWT.NONE);
hostGroup.setText("Host to monitor");
FormLayout hostLayout = new FormLayout();
hostLayout.marginHeight = 5;
hostLayout.marginWidth = 5;
hostGroup.setLayout(hostLayout);
FormData hostFormData1 = new FormData();
hostFormData1.left = new FormAttachment(0, 0);
hostFormData1.right = new FormAttachment(100, 0);
hostGroup.setLayoutData(hostFormData1);
// label "Name or IP"
Label hostLabel = new Label(hostGroup, SWT.NONE);
hostLabel.setText("Name or IP :");
// text hostname or IP
hostCombo = new Combo(hostGroup, SWT.BORDER);
FormData hostFormData = new FormData();
hostFormData.top = new FormAttachment(0, -1);
hostFormData.left = new FormAttachment(hostLabel, 5);
hostFormData.right = new FormAttachment(50, -5);
hostCombo.setLayoutData(hostFormData);
hostCombo.addSelectionListener(new SelectionListener() {
public void widgetSelected(SelectionEvent e) {
String hostName = hostCombo.getText();
String url = urls.get(hostName);
Integer port = URIBuilder.getPortNumber(url);
String protocol = URIBuilder.getProtocol(url);
portText.setText(port.toString());
protocolCombo.setText(protocol);
}
public void widgetDefaultSelected(SelectionEvent e) {
String text = hostCombo.getText();
if (hostCombo.indexOf(text) < 0) { // Not in the list yet.
hostCombo.add(text);
// Re-sort
String[] items = hostCombo.getItems();
Arrays.sort(items);
hostCombo.setItems(items);
hostCombo.setText(text);
}
}
});
// label "Port"
Label portLabel = new Label(hostGroup, SWT.NONE);
portLabel.setText("Port :");
FormData portFormData = new FormData();
portFormData.left = new FormAttachment(50, 5);
portLabel.setLayoutData(portFormData);
// text port
this.portText = new Text(hostGroup, SWT.BORDER);
if (port != null) {
portText.setText(port);
}
FormData portFormData2 = new FormData();
portFormData2.top = new FormAttachment(0, -1);
portFormData2.left = new FormAttachment(portLabel, 5);
portFormData2.right = new FormAttachment(70, 0);
portText.setLayoutData(portFormData2);
// label "Protocol"
Label protocolLabel = new Label(hostGroup, SWT.NONE);
protocolLabel.setText("Protocol :");
FormData protocolFormData1 = new FormData();
protocolFormData1.left = new FormAttachment(70, 5);
protocolLabel.setLayoutData(protocolFormData1);
// combo protocols
protocolCombo = new Combo(hostGroup, SWT.DROP_DOWN);
protocolCombo.add(Constants.RMI_PROTOCOL_IDENTIFIER);
protocolCombo.add(Constants.XMLHTTP_PROTOCOL_IDENTIFIER);
protocolCombo.add(Constants.IBIS_PROTOCOL_IDENTIFIER);
protocolCombo.setText(Constants.RMI_PROTOCOL_IDENTIFIER);
FormData protocolFormData = new FormData();
protocolFormData.top = new FormAttachment(0, -1);
protocolFormData.left = new FormAttachment(protocolLabel, 5);
protocolFormData.right = new FormAttachment(100, 0);
protocolCombo.setLayoutData(protocolFormData);
// Load Urls
loadUrls();
// label depth
Label depthLabel = new Label(shell, SWT.NONE);
depthLabel.setText("Hosts will be recursively searched up to a depth of :");
FormData depthFormData = new FormData();
depthFormData.top = new FormAttachment(hostGroup, 20);
depthFormData.left = new FormAttachment(15, 0);
depthLabel.setLayoutData(depthFormData);
// text depth
this.depthText = new Text(shell, SWT.BORDER);
depthText.setText(Integer.toString(world.getDepth()));
FormData depthFormData2 = new FormData();
depthFormData2.top = new FormAttachment(hostGroup, 17);
depthFormData2.left = new FormAttachment(depthLabel, 5);
depthFormData2.right = new FormAttachment(85, 0);
depthText.setLayoutData(depthFormData2);
// label set depth control
/*Label depthLabel2 = new Label(shell, SWT.CENTER);
depthLabel2.setText("You can change it there or from menu \"Control -> Set depth control\"");
FormData depthFormData3 = new FormData();
depthFormData3.top = new FormAttachment(depthLabel, 5);
depthFormData3.left = new FormAttachment(8, 0);
//depthFormData3.right = new FormAttachment(85, 0);
depthLabel2.setLayoutData(depthFormData3);*/
// button "OK"
this.okButton = new Button(shell, SWT.NONE);
okButton.setText("OK");
okButton.addSelectionListener(new MonitorNewHostListener());
FormData okFormData = new FormData();
okFormData.top = new FormAttachment( /*depthLabel2*/
depthLabel, 20);
okFormData.left = new FormAttachment(25, 20);
okFormData.right = new FormAttachment(50, -10);
okButton.setLayoutData(okFormData);
shell.setDefaultButton(okButton);
// button "CANCEL"
this.cancelButton = new Button(shell, SWT.NONE);
cancelButton.setText("Cancel");
cancelButton.addSelectionListener(new MonitorNewHostListener());
FormData cancelFormData = new FormData();
cancelFormData.top = new FormAttachment( /*depthLabel2*/
depthLabel, 20);
cancelFormData.left = new FormAttachment(50, 10);
cancelFormData.right = new FormAttachment(75, -20);
cancelButton.setLayoutData(cancelFormData);
shell.pack();
shell.open();
while (!shell.isDisposed()) {
if (!display.readAndDispatch()) {
display.sleep();
}
}
//display.dispose(); TODO ???
}
//
// -- PRIVATE METHODS -----------------------------------------------
//
/**
* Logs in the IC2D's console, and show a pop-up.
* @param message
*/
// private void displayMessage(final String message) {
// System.out.println("MonitorNewHostDialog.displayMessage()");
// // Print the message in the UI Thread in async mode
// Display.getDefault().asyncExec(new Runnable() {
// public void run() {
// Console.getInstance("IC2D").warn(message);
// MessageBox mb = new MessageBox(parent);
// mb.setMessage(message);
// mb.open();
// }
// });
// }
/**
* Load Urls
*/
@SuppressWarnings("unchecked")
private void loadUrls() {
try {
BufferedReader reader = null;
String url = null;
reader = new BufferedReader(new FileReader(file));
try {
Set<String> hostNames = new TreeSet<String>();
String lastNameUsed = null;
Integer lastPortUsed = null;
String lastProtocolUsed = null;
while ((url = reader.readLine()) != null) {
if ((url == null) || url.equals("")) {
url = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
}
lastNameUsed = URIBuilder.getHostNameFromUrl(url);
lastPortUsed = URIBuilder.getPortNumber(url);
lastProtocolUsed = URIBuilder.getProtocol(url);
hostNames.add(lastNameUsed);
urls.put(lastNameUsed, url);
}
String[] t = { "" };
String[] hosts = null;
if (hostNames.isEmpty()) {
url = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
lastNameUsed = URIBuilder.getHostNameFromUrl(url);
lastPortUsed = URIBuilder.getPortNumber(url);
lastProtocolUsed = URIBuilder.getProtocol(url);
hostNames.add(lastNameUsed);
}
hosts = (new ArrayList<String>(hostNames)).toArray(t);
Arrays.sort(hosts);
hostCombo.setItems(hosts);
hostCombo.setText(lastNameUsed);
portText.setText(lastPortUsed.toString());
protocolCombo.setText(lastProtocolUsed);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
reader.close();
} catch (IOException e) {
e.printStackTrace();
Console.getInstance(Activator.CONSOLE_NAME).logException(e);
}
}
} catch (FileNotFoundException e) {
hostCombo.add(initialHostValue);
hostCombo.setText(initialHostValue);
String defaultURL = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
urls.put(initialHostValue, defaultURL);
recordUrl(defaultURL);
}
}
/**
* Record an url
* @param url
*/
private void recordUrl(String url) {
BufferedWriter bw = null;
try {
bw = new BufferedWriter(new FileWriter(file, false));
PrintWriter pw = new PrintWriter(bw, true);
String host = URIBuilder.getHostNameFromUrl(url);
if (urls.size() > 1) {
urls.remove(host);
}
// Record urls
Iterator<String> it = urls.values().iterator();
while (it.hasNext()) {
pw.println(it.next());
}
// Record the last URL used at the end of the file
// in order to find it easily for the next time
pw.println(url);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
bw.close();
} catch (IOException e) {
e.printStackTrace();
Console.getInstance(Activator.CONSOLE_NAME).logException(e);
}
}
}
//
// -- INNER CLASS -----------------------------------------------
//
private class MonitorNewHostListener extends SelectionAdapter {
String hostname;
int port;
String protocol;
@Override
public void widgetSelected(SelectionEvent e) {
if (e.widget == okButton) {
hostname = hostCombo.getText();
try {
hostname = InetAddress.getByName(hostname).getCanonicalHostName();
} catch (UnknownHostException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
port = Integer.parseInt(portText.getText());
protocol = protocolCombo.getText();
URI uri = URIBuilder.buildURI(hostname, "", protocol, port);
final String url = RemoteObjectHelper.expandURI(uri).toString();
recordUrl(url);
world.setDepth(Integer.parseInt(depthText.getText()));
IC2DThreadPool.execute(new Runnable() {
public void run() {
world.addHost(url);
}
});
}
shell.close();
}
}
}
| ic2d-plugins-src/org.objectweb.proactive.ic2d.JMXmonitoring/src/org/objectweb/proactive/ic2d/jmxmonitoring/dialog/MonitorNewHostDialog.java | /*
* ################################################################
*
* ProActive: The Java(TM) library for Parallel, Distributed,
* Concurrent computing with Security and Mobility
*
* Copyright (C) 1997-2009 INRIA/University of Nice-Sophia Antipolis
* Contact: [email protected]
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version
* 2 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*
* Initial developer(s): The ProActive Team
* http://proactive.inria.fr/team_members.htm
* Contributor(s):
*
* ################################################################
* $$PROACTIVE_INITIAL_DEV$$
*/
package org.objectweb.proactive.ic2d.jmxmonitoring.dialog;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.InetAddress;
import java.net.URI;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.events.SelectionListener;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.layout.FormLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Dialog;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.Text;
import org.objectweb.proactive.core.Constants;
import org.objectweb.proactive.core.config.PAProperties;
import org.objectweb.proactive.core.config.ProActiveConfiguration;
import org.objectweb.proactive.core.remoteobject.RemoteObjectHelper;
import org.objectweb.proactive.core.util.ProActiveInet;
import org.objectweb.proactive.core.util.URIBuilder;
import org.objectweb.proactive.ic2d.console.Console;
import org.objectweb.proactive.ic2d.jmxmonitoring.Activator;
import org.objectweb.proactive.ic2d.jmxmonitoring.data.WorldObject;
public class MonitorNewHostDialog extends Dialog {
private Shell shell = null;
//private Shell parent = null;
private Combo hostCombo;
private Text portText;
private Combo protocolCombo;
private Text depthText;
private Button okButton;
private Button cancelButton;
/** The World */
private WorldObject world;
/** Host name */
String initialHostValue = "localhost";
// Name of the file
String file = ".urls";
// <hostName,url>
Map<String, String> urls = new HashMap<String, String>();
//
// -- CONSTRUCTORS -----------------------------------------------
//
public MonitorNewHostDialog(Shell parent, WorldObject world) {
// Pass the default styles here
super(parent, SWT.DIALOG_TRIM | SWT.APPLICATION_MODAL);
//this.parent = parent;
this.world = world;
String port = "";
/* Get the machine's name */
initialHostValue = ProActiveInet.getInstance().getHostname();
/* Load the proactive default configuration */
ProActiveConfiguration.load();
/* Get the machine's port */
port = PAProperties.PA_RMI_PORT.getValue();
/* Init the display */
Display display = getParent().getDisplay();
/* Init the shell */
shell = new Shell(getParent(), SWT.BORDER | SWT.CLOSE);
shell.setText("Adding host and depth to monitor");
FormLayout layout = new FormLayout();
layout.marginHeight = 5;
layout.marginWidth = 5;
shell.setLayout(layout);
////// group "Host to monitor"
Group hostGroup = new Group(shell, SWT.NONE);
hostGroup.setText("Host to monitor");
FormLayout hostLayout = new FormLayout();
hostLayout.marginHeight = 5;
hostLayout.marginWidth = 5;
hostGroup.setLayout(hostLayout);
FormData hostFormData1 = new FormData();
hostFormData1.left = new FormAttachment(0, 0);
hostFormData1.right = new FormAttachment(100, 0);
hostGroup.setLayoutData(hostFormData1);
// label "Name or IP"
Label hostLabel = new Label(hostGroup, SWT.NONE);
hostLabel.setText("Name or IP :");
// text hostname or IP
hostCombo = new Combo(hostGroup, SWT.BORDER);
FormData hostFormData = new FormData();
hostFormData.top = new FormAttachment(0, -1);
hostFormData.left = new FormAttachment(hostLabel, 5);
hostFormData.right = new FormAttachment(50, -5);
hostCombo.setLayoutData(hostFormData);
hostCombo.addSelectionListener(new SelectionListener() {
public void widgetSelected(SelectionEvent e) {
String hostName = hostCombo.getText();
String url = urls.get(hostName);
Integer port = URIBuilder.getPortNumber(url);
String protocol = URIBuilder.getProtocol(url);
portText.setText(port.toString());
protocolCombo.setText(protocol);
}
public void widgetDefaultSelected(SelectionEvent e) {
String text = hostCombo.getText();
if (hostCombo.indexOf(text) < 0) { // Not in the list yet.
hostCombo.add(text);
// Re-sort
String[] items = hostCombo.getItems();
Arrays.sort(items);
hostCombo.setItems(items);
hostCombo.setText(text);
}
}
});
// label "Port"
Label portLabel = new Label(hostGroup, SWT.NONE);
portLabel.setText("Port :");
FormData portFormData = new FormData();
portFormData.left = new FormAttachment(50, 5);
portLabel.setLayoutData(portFormData);
// text port
this.portText = new Text(hostGroup, SWT.BORDER);
if (port != null) {
portText.setText(port);
}
FormData portFormData2 = new FormData();
portFormData2.top = new FormAttachment(0, -1);
portFormData2.left = new FormAttachment(portLabel, 5);
portFormData2.right = new FormAttachment(70, 0);
portText.setLayoutData(portFormData2);
// label "Protocol"
Label protocolLabel = new Label(hostGroup, SWT.NONE);
protocolLabel.setText("Protocol :");
FormData protocolFormData1 = new FormData();
protocolFormData1.left = new FormAttachment(70, 5);
protocolLabel.setLayoutData(protocolFormData1);
// combo protocols
protocolCombo = new Combo(hostGroup, SWT.DROP_DOWN);
protocolCombo.add(Constants.RMI_PROTOCOL_IDENTIFIER);
protocolCombo.add(Constants.XMLHTTP_PROTOCOL_IDENTIFIER);
protocolCombo.add(Constants.IBIS_PROTOCOL_IDENTIFIER);
protocolCombo.setText(Constants.RMI_PROTOCOL_IDENTIFIER);
FormData protocolFormData = new FormData();
protocolFormData.top = new FormAttachment(0, -1);
protocolFormData.left = new FormAttachment(protocolLabel, 5);
protocolFormData.right = new FormAttachment(100, 0);
protocolCombo.setLayoutData(protocolFormData);
// Load Urls
loadUrls();
// label depth
Label depthLabel = new Label(shell, SWT.NONE);
depthLabel.setText("Hosts will be recursively searched up to a depth of :");
FormData depthFormData = new FormData();
depthFormData.top = new FormAttachment(hostGroup, 20);
depthFormData.left = new FormAttachment(15, 0);
depthLabel.setLayoutData(depthFormData);
// text depth
this.depthText = new Text(shell, SWT.BORDER);
depthText.setText(Integer.toString(world.getDepth()));
FormData depthFormData2 = new FormData();
depthFormData2.top = new FormAttachment(hostGroup, 17);
depthFormData2.left = new FormAttachment(depthLabel, 5);
depthFormData2.right = new FormAttachment(85, 0);
depthText.setLayoutData(depthFormData2);
// label set depth control
/*Label depthLabel2 = new Label(shell, SWT.CENTER);
depthLabel2.setText("You can change it there or from menu \"Control -> Set depth control\"");
FormData depthFormData3 = new FormData();
depthFormData3.top = new FormAttachment(depthLabel, 5);
depthFormData3.left = new FormAttachment(8, 0);
//depthFormData3.right = new FormAttachment(85, 0);
depthLabel2.setLayoutData(depthFormData3);*/
// button "OK"
this.okButton = new Button(shell, SWT.NONE);
okButton.setText("OK");
okButton.addSelectionListener(new MonitorNewHostListener());
FormData okFormData = new FormData();
okFormData.top = new FormAttachment( /*depthLabel2*/
depthLabel, 20);
okFormData.left = new FormAttachment(25, 20);
okFormData.right = new FormAttachment(50, -10);
okButton.setLayoutData(okFormData);
shell.setDefaultButton(okButton);
// button "CANCEL"
this.cancelButton = new Button(shell, SWT.NONE);
cancelButton.setText("Cancel");
cancelButton.addSelectionListener(new MonitorNewHostListener());
FormData cancelFormData = new FormData();
cancelFormData.top = new FormAttachment( /*depthLabel2*/
depthLabel, 20);
cancelFormData.left = new FormAttachment(50, 10);
cancelFormData.right = new FormAttachment(75, -20);
cancelButton.setLayoutData(cancelFormData);
shell.pack();
shell.open();
while (!shell.isDisposed()) {
if (!display.readAndDispatch()) {
display.sleep();
}
}
//display.dispose(); TODO ???
}
//
// -- PRIVATE METHODS -----------------------------------------------
//
/**
* Logs in the IC2D's console, and show a pop-up.
* @param message
*/
// private void displayMessage(final String message) {
// System.out.println("MonitorNewHostDialog.displayMessage()");
// // Print the message in the UI Thread in async mode
// Display.getDefault().asyncExec(new Runnable() {
// public void run() {
// Console.getInstance("IC2D").warn(message);
// MessageBox mb = new MessageBox(parent);
// mb.setMessage(message);
// mb.open();
// }
// });
// }
/**
* Load Urls
*/
@SuppressWarnings("unchecked")
private void loadUrls() {
try {
BufferedReader reader = null;
String url = null;
reader = new BufferedReader(new FileReader(file));
try {
Set<String> hostNames = new TreeSet<String>();
String lastNameUsed = null;
Integer lastPortUsed = null;
String lastProtocolUsed = null;
while ((url = reader.readLine()) != null) {
if ((url == null) || url.equals("")) {
url = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
}
lastNameUsed = URIBuilder.getHostNameFromUrl(url);
lastPortUsed = URIBuilder.getPortNumber(url);
lastProtocolUsed = URIBuilder.getProtocol(url);
hostNames.add(lastNameUsed);
urls.put(lastNameUsed, url);
}
String[] t = { "" };
String[] hosts = null;
if (hostNames.isEmpty()) {
url = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
lastNameUsed = URIBuilder.getHostNameFromUrl(url);
lastPortUsed = URIBuilder.getPortNumber(url);
lastProtocolUsed = URIBuilder.getProtocol(url);
hostNames.add(lastNameUsed);
}
hosts = (new ArrayList<String>(hostNames)).toArray(t);
Arrays.sort(hosts);
hostCombo.setItems(hosts);
hostCombo.setText(lastNameUsed);
portText.setText(lastPortUsed.toString());
protocolCombo.setText(lastProtocolUsed);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
reader.close();
} catch (IOException e) {
e.printStackTrace();
Console.getInstance(Activator.CONSOLE_NAME).logException(e);
}
}
} catch (FileNotFoundException e) {
hostCombo.add(initialHostValue);
hostCombo.setText(initialHostValue);
String defaultURL = URIBuilder.buildURIFromProperties(initialHostValue, "").toString();
urls.put(initialHostValue, defaultURL);
recordUrl(defaultURL);
}
}
/**
* Record an url
* @param url
*/
private void recordUrl(String url) {
BufferedWriter bw = null;
try {
bw = new BufferedWriter(new FileWriter(file, false));
PrintWriter pw = new PrintWriter(bw, true);
String host = URIBuilder.getHostNameFromUrl(url);
if (urls.size() > 1) {
urls.remove(host);
}
// Record urls
Iterator<String> it = urls.values().iterator();
while (it.hasNext()) {
pw.println(it.next());
}
// Record the last URL used at the end of the file
// in order to find it easily for the next time
pw.println(url);
} catch (IOException e) {
e.printStackTrace();
} finally {
try {
bw.close();
} catch (IOException e) {
e.printStackTrace();
Console.getInstance(Activator.CONSOLE_NAME).logException(e);
}
}
}
//
// -- INNER CLASS -----------------------------------------------
//
private class MonitorNewHostListener extends SelectionAdapter {
String hostname;
int port;
String protocol;
@Override
public void widgetSelected(SelectionEvent e) {
if (e.widget == okButton) {
hostname = hostCombo.getText();
try {
hostname = InetAddress.getByName(hostname).getCanonicalHostName();
} catch (UnknownHostException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
port = Integer.parseInt(portText.getText());
protocol = protocolCombo.getText();
URI uri = URIBuilder.buildURI(hostname, "", protocol, port);
final String url = RemoteObjectHelper.expandURI(uri).toString();
recordUrl(url);
world.setDepth(Integer.parseInt(depthText.getText()));
// new Thread() {
// public void run() {
world.addHost(url);
// }
// }.start();
}
shell.close();
}
}
}
| The action launched by the dialog box is now threaded. No freeze of the
ui when clicking on the ok button
git-svn-id: 9146c88ff6d39b48099bf954d15d68f687b3fa69@11652 28e8926c-6b08-0410-baaa-805c5e19b8d6
| ic2d-plugins-src/org.objectweb.proactive.ic2d.JMXmonitoring/src/org/objectweb/proactive/ic2d/jmxmonitoring/dialog/MonitorNewHostDialog.java | The action launched by the dialog box is now threaded. No freeze of the ui when clicking on the ok button | <ide><path>c2d-plugins-src/org.objectweb.proactive.ic2d.JMXmonitoring/src/org/objectweb/proactive/ic2d/jmxmonitoring/dialog/MonitorNewHostDialog.java
<ide> import org.objectweb.proactive.ic2d.console.Console;
<ide> import org.objectweb.proactive.ic2d.jmxmonitoring.Activator;
<ide> import org.objectweb.proactive.ic2d.jmxmonitoring.data.WorldObject;
<add>import org.objectweb.proactive.ic2d.jmxmonitoring.util.IC2DThreadPool;
<ide>
<ide>
<ide> public class MonitorNewHostDialog extends Dialog {
<ide>
<ide> recordUrl(url);
<ide> world.setDepth(Integer.parseInt(depthText.getText()));
<del> // new Thread() {
<del> // public void run() {
<del> world.addHost(url);
<del> // }
<del> // }.start();
<add> IC2DThreadPool.execute(new Runnable() {
<add> public void run() {
<add> world.addHost(url);
<add> }
<add> });
<ide> }
<ide> shell.close();
<ide> } |
|
Java | apache-2.0 | 8395d5f34f69ab3260758de41769c586065c2820 | 0 | apache/commons-compress,apache/commons-compress,apache/commons-compress | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.commons.compress.archivers.cpio;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.Date;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import org.apache.commons.compress.archivers.ArchiveEntry;
/**
* A cpio archive consists of a sequence of files. There are several types of
* headers defined in two categories of new and old format. The headers are
* recognized by magic numbers:
*
* <ul>
* <li>"070701" ASCII for new portable format</li>
* <li>"070702" ASCII for new portable format with CRC</li>
* <li>"070707" ASCII for old ascii (also known as Portable ASCII, odc or old
* character format</li>
* <li>070707 binary for old binary</li>
* </ul>
*
* <p>The old binary format is limited to 16 bits for user id, group
* id, device, and inode numbers. It is limited to 4 gigabyte file
* sizes.
*
* The old ASCII format is limited to 18 bits for the user id, group
* id, device, and inode numbers. It is limited to 8 gigabyte file
* sizes.
*
* The new ASCII format is limited to 4 gigabyte file sizes.
*
* CPIO 2.5 knows also about tar, but it is not recognized here.</p>
*
*
* <h2>OLD FORMAT</h2>
*
* <p>Each file has a 76 (ascii) / 26 (binary) byte header, a variable
* length, NUL terminated file name, and variable length file data. A
* header for a file name "TRAILER!!!" indicates the end of the
* archive.</p>
*
* <p>All the fields in the header are ISO 646 (approximately ASCII)
* strings of octal numbers, left padded, not NUL terminated.</p>
*
* <pre>
* FIELDNAME NOTES
* c_magic The integer value octal 070707. This value can be used to deter-
* mine whether this archive is written with little-endian or big-
* endian integers.
* c_dev Device that contains a directory entry for this file
* c_ino I-node number that identifies the input file to the file system
* c_mode The mode specifies both the regular permissions and the file type.
* c_uid Numeric User ID of the owner of the input file
* c_gid Numeric Group ID of the owner of the input file
* c_nlink Number of links that are connected to the input file
* c_rdev For block special and character special entries, this field
* contains the associated device number. For all other entry types,
* it should be set to zero by writers and ignored by readers.
* c_mtime[2] Modification time of the file, indicated as the number of seconds
* since the start of the epoch, 00:00:00 UTC January 1, 1970. The
* four-byte integer is stored with the most-significant 16 bits
* first followed by the least-significant 16 bits. Each of the two
* 16 bit values are stored in machine-native byte order.
* c_namesize Length of the path name, including the terminating null byte
* c_filesize[2] Length of the file in bytes. This is the length of the data
* section that follows the header structure. Must be 0 for
* FIFOs and directories
*
* All fields are unsigned short fields with 16-bit integer values
* apart from c_mtime and c_filesize which are 32-bit integer values
* </pre>
*
* <p>If necessary, the file name and file data are padded with a NUL byte to an even length</p>
*
* <p>Special files, directories, and the trailer are recorded with
* the h_filesize field equal to 0.</p>
*
* <p>In the ASCII version of this format, the 16-bit entries are represented as 6-byte octal numbers,
* and the 32-bit entries are represented as 11-byte octal numbers. No padding is added.</p>
*
* <h3>NEW FORMAT</h3>
*
* <p>Each file has a 110 byte header, a variable length, NUL
* terminated file name, and variable length file data. A header for a
* file name "TRAILER!!!" indicates the end of the archive. All the
* fields in the header are ISO 646 (approximately ASCII) strings of
* hexadecimal numbers, left padded, not NUL terminated.</p>
*
* <pre>
* FIELDNAME NOTES
* c_magic[6] The string 070701 for new ASCII, the string 070702 for new ASCII with CRC
* c_ino[8]
* c_mode[8]
* c_uid[8]
* c_gid[8]
* c_nlink[8]
* c_mtim[8]
* c_filesize[8] must be 0 for FIFOs and directories
* c_maj[8]
* c_min[8]
* c_rmaj[8] only valid for chr and blk special files
* c_rmin[8] only valid for chr and blk special files
* c_namesize[8] count includes terminating NUL in pathname
* c_check[8] 0 for "new" portable format; for CRC format
* the sum of all the bytes in the file
* </pre>
*
* <p>New ASCII Format The "new" ASCII format uses 8-byte hexadecimal
* fields for all numbers and separates device numbers into separate
* fields for major and minor numbers.</p>
*
* <p>The pathname is followed by NUL bytes so that the total size of
* the fixed header plus pathname is a multiple of four. Likewise, the
* file data is padded to a multiple of four bytes.</p>
*
* <p>This class uses mutable fields and is not considered to be
* threadsafe.</p>
*
* <p>Based on code from the jRPM project (http://jrpm.sourceforge.net).</p>
*
* <p>The MAGIC numbers and other constants are defined in {@link CpioConstants}</p>
*
* <p>
* N.B. does not handle the cpio "tar" format
* </p>
* @NotThreadSafe
* @see <a href="https://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt">https://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt</a>
*/
public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
// Header description fields - should be same throughout an archive
/**
* See {@link #CpioArchiveEntry(short)} for possible values.
*/
private final short fileFormat;
/** The number of bytes in each header record; depends on the file format */
private final int headerSize;
/** The boundary to which the header and data elements are aligned: 0, 2 or 4 bytes */
private final int alignmentBoundary;
// Header fields
private long chksum;
/** Number of bytes in the file */
private long filesize;
private long gid;
private long inode;
private long maj;
private long min;
private long mode;
private long mtime;
private String name;
private long nlink;
private long rmaj;
private long rmin;
private long uid;
/**
* Creates a CpioArchiveEntry with a specified format.
*
* @param format
* The cpio format for this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*/
public CpioArchiveEntry(final short format) {
switch (format) {
case FORMAT_NEW:
this.headerSize = 110;
this.alignmentBoundary = 4;
break;
case FORMAT_NEW_CRC:
this.headerSize = 110;
this.alignmentBoundary = 4;
break;
case FORMAT_OLD_ASCII:
this.headerSize = 76;
this.alignmentBoundary = 0;
break;
case FORMAT_OLD_BINARY:
this.headerSize = 26;
this.alignmentBoundary = 2;
break;
default:
throw new IllegalArgumentException("Unknown header type " + format);
}
this.fileFormat = format;
}
/**
* Creates a CpioArchiveEntry with a specified name. The format of
* this entry will be the new format.
*
* @param name
* The name of this entry.
*/
public CpioArchiveEntry(final String name) {
this(FORMAT_NEW, name);
}
/**
* Creates a CpioArchiveEntry with a specified name.
*
* @param format
* The cpio format for this entry.
* @param name
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final String name) {
this(format);
this.name = name;
}
/**
* Creates a CpioArchiveEntry with a specified name. The format of
* this entry will be the new format.
*
* @param name
* The name of this entry.
* @param size
* The size of this entry
*/
public CpioArchiveEntry(final String name, final long size) {
this(name);
this.setSize(size);
}
/**
* Creates a CpioArchiveEntry with a specified name.
*
* @param format
* The cpio format for this entry.
* @param name
* The name of this entry.
* @param size
* The size of this entry
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final String name,
final long size) {
this(format, name);
this.setSize(size);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file. The format of this entry will be the new
* format.
*
* @param inputFile
* The file to gather information from.
* @param entryName
* The name of this entry.
*/
public CpioArchiveEntry(final File inputFile, final String entryName) {
this(FORMAT_NEW, inputFile, entryName);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file. The format of this entry will be the new
* format.
*
* @param inputPath
* The file to gather information from.
* @param entryName
* The name of this entry.
* @param options options indicating how symbolic links are handled.
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public CpioArchiveEntry(final Path inputPath, final String entryName, final LinkOption... options) throws IOException {
this(FORMAT_NEW, inputPath, entryName, options);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file.
*
* @param format
* The cpio format for this entry.
* @param inputFile
* The file to gather information from.
* @param entryName
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final File inputFile,
final String entryName) {
this(format, entryName, inputFile.isFile() ? inputFile.length() : 0);
if (inputFile.isDirectory()){
setMode(C_ISDIR);
} else if (inputFile.isFile()){
setMode(C_ISREG);
} else {
throw new IllegalArgumentException("Cannot determine type of file "
+ inputFile.getName());
}
// TODO set other fields as needed
setTime(inputFile.lastModified() / 1000);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified path.
*
* @param format
* The cpio format for this entry.
* @param inputPath
* The file to gather information from.
* @param entryName
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
* @param options options indicating how symbolic links are handled.
*
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public CpioArchiveEntry(final short format, final Path inputPath, final String entryName, final LinkOption... options)
throws IOException {
this(format, entryName, Files.isRegularFile(inputPath, options) ? Files.size(inputPath) : 0);
if (Files.isDirectory(inputPath, options)) {
setMode(C_ISDIR);
} else if (Files.isRegularFile(inputPath, options)) {
setMode(C_ISREG);
} else {
throw new IllegalArgumentException("Cannot determine type of file " + inputPath);
}
// TODO set other fields as needed
setTime(Files.getLastModifiedTime(inputPath, options));
}
/**
* Checks if the method is allowed for the defined format.
*/
private void checkNewFormat() {
if ((this.fileFormat & FORMAT_NEW_MASK) == 0) {
throw new UnsupportedOperationException();
}
}
/**
* Checks if the method is allowed for the defined format.
*/
private void checkOldFormat() {
if ((this.fileFormat & FORMAT_OLD_MASK) == 0) {
throw new UnsupportedOperationException();
}
}
/**
* Gets the checksum.
* Only supported for the new formats.
*
* @return Returns the checksum.
* @throws UnsupportedOperationException if the format is not a new format
*/
public long getChksum() {
checkNewFormat();
return this.chksum & 0xFFFFFFFFL;
}
/**
* Gets the device id.
*
* @return Returns the device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public long getDevice() {
checkOldFormat();
return this.min;
}
/**
* Gets the major device id.
*
* @return Returns the major device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getDeviceMaj() {
checkNewFormat();
return this.maj;
}
/**
* Gets the minor device id
*
* @return Returns the minor device id.
* @throws UnsupportedOperationException if format is not a new format
*/
public long getDeviceMin() {
checkNewFormat();
return this.min;
}
/**
* Gets the filesize.
*
* @return Returns the filesize.
* @see org.apache.commons.compress.archivers.ArchiveEntry#getSize()
*/
@Override
public long getSize() {
return this.filesize;
}
/**
* Gets the format for this entry.
*
* @return Returns the format.
*/
public short getFormat() {
return this.fileFormat;
}
/**
* Gets the group id.
*
* @return Returns the group id.
*/
public long getGID() {
return this.gid;
}
/**
* Gets the header size for this CPIO format
*
* @return Returns the header size in bytes.
*/
public int getHeaderSize() {
return this.headerSize;
}
/**
* Gets the alignment boundary for this CPIO format
*
* @return Returns the aligment boundary (0, 2, 4) in bytes
*/
public int getAlignmentBoundary() {
return this.alignmentBoundary;
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @deprecated This method doesn't properly work for multi-byte encodings. And
* creates corrupt archives. Use {@link #getHeaderPadCount(Charset)}
* or {@link #getHeaderPadCount(long)} in any case.
* @return the number of bytes needed to pad the header (0,1,2,3)
*/
@Deprecated
public int getHeaderPadCount(){
return getHeaderPadCount(null);
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @param charset
* The character set used to encode the entry name in the stream.
* @return the number of bytes needed to pad the header (0,1,2,3)
* @since 1.18
*/
public int getHeaderPadCount(final Charset charset) {
if (name == null) {
return 0;
}
if (charset == null) {
return getHeaderPadCount(name.length());
}
return getHeaderPadCount(name.getBytes(charset).length);
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @param nameSize
* The length of the name in bytes, as read in the stream.
* Without the trailing zero byte.
* @return the number of bytes needed to pad the header (0,1,2,3)
*
* @since 1.18
*/
public int getHeaderPadCount(final long nameSize) {
if (this.alignmentBoundary == 0) {
return 0;
}
int size = this.headerSize + 1; // Name has terminating null
if (name != null) {
size += nameSize;
}
final int remain = size % this.alignmentBoundary;
if (remain > 0) {
return this.alignmentBoundary - remain;
}
return 0;
}
/**
* Gets the number of bytes needed to pad the data to the alignment boundary.
*
* @return the number of bytes needed to pad the data (0,1,2,3)
*/
public int getDataPadCount() {
if (this.alignmentBoundary == 0) {
return 0;
}
final long size = this.filesize;
final int remain = (int) (size % this.alignmentBoundary);
if (remain > 0) {
return this.alignmentBoundary - remain;
}
return 0;
}
/**
* Sets the inode.
*
* @return Returns the inode.
*/
public long getInode() {
return this.inode;
}
/**
* Gets the mode of this entry (e.g. directory, regular file).
*
* @return Returns the mode.
*/
public long getMode() {
return mode == 0 && !CPIO_TRAILER.equals(name) ? C_ISREG : mode;
}
/**
* Gets the name.
*
* <p>This method returns the raw name as it is stored inside of the archive.</p>
*
* @return Returns the name.
*/
@Override
public String getName() {
return this.name;
}
/**
* Gets the number of links.
*
* @return Returns the number of links.
*/
public long getNumberOfLinks() {
return nlink == 0 ? isDirectory() ? 2 : 1 : nlink;
}
/**
* Gets the remote device id.
*
* @return Returns the remote device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public long getRemoteDevice() {
checkOldFormat();
return this.rmin;
}
/**
* Gets the remote major device id.
*
* @return Returns the remote major device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getRemoteDeviceMaj() {
checkNewFormat();
return this.rmaj;
}
/**
* Gets the remote minor device id.
*
* @return Returns the remote minor device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getRemoteDeviceMin() {
checkNewFormat();
return this.rmin;
}
/**
* Gets the time in seconds.
*
* @return Returns the time.
*/
public long getTime() {
return this.mtime;
}
@Override
public Date getLastModifiedDate() {
return new Date(1000 * getTime());
}
/**
* Gets the user id.
*
* @return Returns the user id.
*/
public long getUID() {
return this.uid;
}
/**
* Checks if this entry represents a block device.
*
* @return TRUE if this entry is a block device.
*/
public boolean isBlockDevice() {
return CpioUtil.fileType(mode) == C_ISBLK;
}
/**
* Checks if this entry represents a character device.
*
* @return TRUE if this entry is a character device.
*/
public boolean isCharacterDevice() {
return CpioUtil.fileType(mode) == C_ISCHR;
}
/**
* Checks if this entry represents a directory.
*
* @return TRUE if this entry is a directory.
*/
@Override
public boolean isDirectory() {
return CpioUtil.fileType(mode) == C_ISDIR;
}
/**
* Checks if this entry represents a network device.
*
* @return TRUE if this entry is a network device.
*/
public boolean isNetwork() {
return CpioUtil.fileType(mode) == C_ISNWK;
}
/**
* Checks if this entry represents a pipe.
*
* @return TRUE if this entry is a pipe.
*/
public boolean isPipe() {
return CpioUtil.fileType(mode) == C_ISFIFO;
}
/**
* Checks if this entry represents a regular file.
*
* @return TRUE if this entry is a regular file.
*/
public boolean isRegularFile() {
return CpioUtil.fileType(mode) == C_ISREG;
}
/**
* Checks if this entry represents a socket.
*
* @return TRUE if this entry is a socket.
*/
public boolean isSocket() {
return CpioUtil.fileType(mode) == C_ISSOCK;
}
/**
* Checks if this entry represents a symbolic link.
*
* @return TRUE if this entry is a symbolic link.
*/
public boolean isSymbolicLink() {
return CpioUtil.fileType(mode) == C_ISLNK;
}
/**
* Sets the checksum. The checksum is calculated by adding all bytes of a
* file to transfer (crc += buf[pos] & 0xFF).
*
* @param chksum
* The checksum to set.
*/
public void setChksum(final long chksum) {
checkNewFormat();
this.chksum = chksum & 0xFFFFFFFFL;
}
/**
* Sets the device id.
*
* @param device
* The device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public void setDevice(final long device) {
checkOldFormat();
this.min = device;
}
/**
* Sets major device id.
*
* @param maj
* The major device id to set.
*/
public void setDeviceMaj(final long maj) {
checkNewFormat();
this.maj = maj;
}
/**
* Sets the minor device id
*
* @param min
* The minor device id to set.
*/
public void setDeviceMin(final long min) {
checkNewFormat();
this.min = min;
}
/**
* Sets the filesize.
*
* @param size
* The filesize to set.
*/
public void setSize(final long size) {
if (size < 0 || size > 0xFFFFFFFFL) {
throw new IllegalArgumentException("Invalid entry size <" + size + ">");
}
this.filesize = size;
}
/**
* Sets the group id.
*
* @param gid
* The group id to set.
*/
public void setGID(final long gid) {
this.gid = gid;
}
/**
* Sets the inode.
*
* @param inode
* The inode to set.
*/
public void setInode(final long inode) {
this.inode = inode;
}
/**
* Sets the mode of this entry (e.g. directory, regular file).
*
* @param mode
* The mode to set.
*/
public void setMode(final long mode) {
final long maskedMode = mode & S_IFMT;
switch ((int) maskedMode) {
case C_ISDIR:
case C_ISLNK:
case C_ISREG:
case C_ISFIFO:
case C_ISCHR:
case C_ISBLK:
case C_ISSOCK:
case C_ISNWK:
break;
default:
throw new IllegalArgumentException(
"Unknown mode. "
+ "Full: " + Long.toHexString(mode)
+ " Masked: " + Long.toHexString(maskedMode));
}
this.mode = mode;
}
/**
* Sets the name.
*
* @param name
* The name to set.
*/
public void setName(final String name) {
this.name = name;
}
/**
* Sets the number of links.
*
* @param nlink
* The number of links to set.
*/
public void setNumberOfLinks(final long nlink) {
this.nlink = nlink;
}
/**
* Sets the remote device id.
*
* @param device
* The remote device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public void setRemoteDevice(final long device) {
checkOldFormat();
this.rmin = device;
}
/**
* Sets the remote major device id.
*
* @param rmaj
* The remote major device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public void setRemoteDeviceMaj(final long rmaj) {
checkNewFormat();
this.rmaj = rmaj;
}
/**
* Sets the remote minor device id.
*
* @param rmin
* The remote minor device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public void setRemoteDeviceMin(final long rmin) {
checkNewFormat();
this.rmin = rmin;
}
/**
* Sets the time in seconds.
*
* @param time
* The time to set.
*/
public void setTime(final long time) {
this.mtime = time;
}
/**
* Sets the time.
*
* @param time
* The time to set.
*/
public void setTime(final FileTime time) {
this.mtime = time.to(TimeUnit.SECONDS);
}
/**
* Sets the user id.
*
* @param uid
* The user id to set.
*/
public void setUID(final long uid) {
this.uid = uid;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(name);
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final CpioArchiveEntry other = (CpioArchiveEntry) obj;
if (name == null) {
return other.name == null;
}
return name.equals(other.name);
}
}
| src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.commons.compress.archivers.cpio;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.attribute.FileTime;
import java.util.Date;
import java.util.Objects;
import java.util.concurrent.TimeUnit;
import org.apache.commons.compress.archivers.ArchiveEntry;
/**
* A cpio archive consists of a sequence of files. There are several types of
* headers defined in two categories of new and old format. The headers are
* recognized by magic numbers:
*
* <ul>
* <li>"070701" ASCII for new portable format</li>
* <li>"070702" ASCII for new portable format with CRC</li>
* <li>"070707" ASCII for old ascii (also known as Portable ASCII, odc or old
* character format</li>
* <li>070707 binary for old binary</li>
* </ul>
*
* <p>The old binary format is limited to 16 bits for user id, group
* id, device, and inode numbers. It is limited to 4 gigabyte file
* sizes.
*
* The old ASCII format is limited to 18 bits for the user id, group
* id, device, and inode numbers. It is limited to 8 gigabyte file
* sizes.
*
* The new ASCII format is limited to 4 gigabyte file sizes.
*
* CPIO 2.5 knows also about tar, but it is not recognized here.</p>
*
*
* <h2>OLD FORMAT</h2>
*
* <p>Each file has a 76 (ascii) / 26 (binary) byte header, a variable
* length, NUL terminated file name, and variable length file data. A
* header for a file name "TRAILER!!!" indicates the end of the
* archive.</p>
*
* <p>All the fields in the header are ISO 646 (approximately ASCII)
* strings of octal numbers, left padded, not NUL terminated.</p>
*
* <pre>
* FIELDNAME NOTES
* c_magic The integer value octal 070707. This value can be used to deter-
* mine whether this archive is written with little-endian or big-
* endian integers.
* c_dev Device that contains a directory entry for this file
* c_ino I-node number that identifies the input file to the file system
* c_mode The mode specifies both the regular permissions and the file type.
* c_uid Numeric User ID of the owner of the input file
* c_gid Numeric Group ID of the owner of the input file
* c_nlink Number of links that are connected to the input file
* c_rdev For block special and character special entries, this field
* contains the associated device number. For all other entry types,
* it should be set to zero by writers and ignored by readers.
* c_mtime[2] Modification time of the file, indicated as the number of seconds
* since the start of the epoch, 00:00:00 UTC January 1, 1970. The
* four-byte integer is stored with the most-significant 16 bits
* first followed by the least-significant 16 bits. Each of the two
* 16 bit values are stored in machine-native byte order.
* c_namesize Length of the path name, including the terminating null byte
* c_filesize[2] Length of the file in bytes. This is the length of the data
* section that follows the header structure. Must be 0 for
* FIFOs and directories
*
* All fields are unsigned short fields with 16-bit integer values
* apart from c_mtime and c_filesize which are 32-bit integer values
* </pre>
*
* <p>If necessary, the file name and file data are padded with a NUL byte to an even length</p>
*
* <p>Special files, directories, and the trailer are recorded with
* the h_filesize field equal to 0.</p>
*
* <p>In the ASCII version of this format, the 16-bit entries are represented as 6-byte octal numbers,
* and the 32-bit entries are represented as 11-byte octal numbers. No padding is added.</p>
*
* <h3>NEW FORMAT</h3>
*
* <p>Each file has a 110 byte header, a variable length, NUL
* terminated file name, and variable length file data. A header for a
* file name "TRAILER!!!" indicates the end of the archive. All the
* fields in the header are ISO 646 (approximately ASCII) strings of
* hexadecimal numbers, left padded, not NUL terminated.</p>
*
* <pre>
* FIELDNAME NOTES
* c_magic[6] The string 070701 for new ASCII, the string 070702 for new ASCII with CRC
* c_ino[8]
* c_mode[8]
* c_uid[8]
* c_gid[8]
* c_nlink[8]
* c_mtim[8]
* c_filesize[8] must be 0 for FIFOs and directories
* c_maj[8]
* c_min[8]
* c_rmaj[8] only valid for chr and blk special files
* c_rmin[8] only valid for chr and blk special files
* c_namesize[8] count includes terminating NUL in pathname
* c_check[8] 0 for "new" portable format; for CRC format
* the sum of all the bytes in the file
* </pre>
*
* <p>New ASCII Format The "new" ASCII format uses 8-byte hexadecimal
* fields for all numbers and separates device numbers into separate
* fields for major and minor numbers.</p>
*
* <p>The pathname is followed by NUL bytes so that the total size of
* the fixed header plus pathname is a multiple of four. Likewise, the
* file data is padded to a multiple of four bytes.</p>
*
* <p>This class uses mutable fields and is not considered to be
* threadsafe.</p>
*
* <p>Based on code from the jRPM project (http://jrpm.sourceforge.net).</p>
*
* <p>The MAGIC numbers and other constants are defined in {@link CpioConstants}</p>
*
* <p>
* N.B. does not handle the cpio "tar" format
* </p>
* @NotThreadSafe
* @see <a href="https://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt">https://people.freebsd.org/~kientzle/libarchive/man/cpio.5.txt</a>
*/
public class CpioArchiveEntry implements CpioConstants, ArchiveEntry {
// Header description fields - should be same throughout an archive
/**
* See {@link #CpioArchiveEntry(short)} for possible values.
*/
private final short fileFormat;
/** The number of bytes in each header record; depends on the file format */
private final int headerSize;
/** The boundary to which the header and data elements are aligned: 0, 2 or 4 bytes */
private final int alignmentBoundary;
// Header fields
private long chksum;
/** Number of bytes in the file */
private long filesize;
private long gid;
private long inode;
private long maj;
private long min;
private long mode;
private long mtime;
private String name;
private long nlink;
private long rmaj;
private long rmin;
private long uid;
/**
* Creates a CpioArchiveEntry with a specified format.
*
* @param format
* The cpio format for this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*/
public CpioArchiveEntry(final short format) {
switch (format) {
case FORMAT_NEW:
this.headerSize = 110;
this.alignmentBoundary = 4;
break;
case FORMAT_NEW_CRC:
this.headerSize = 110;
this.alignmentBoundary = 4;
break;
case FORMAT_OLD_ASCII:
this.headerSize = 76;
this.alignmentBoundary = 0;
break;
case FORMAT_OLD_BINARY:
this.headerSize = 26;
this.alignmentBoundary = 2;
break;
default:
throw new IllegalArgumentException("Unknown header type");
}
this.fileFormat = format;
}
/**
* Creates a CpioArchiveEntry with a specified name. The format of
* this entry will be the new format.
*
* @param name
* The name of this entry.
*/
public CpioArchiveEntry(final String name) {
this(FORMAT_NEW, name);
}
/**
* Creates a CpioArchiveEntry with a specified name.
*
* @param format
* The cpio format for this entry.
* @param name
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final String name) {
this(format);
this.name = name;
}
/**
* Creates a CpioArchiveEntry with a specified name. The format of
* this entry will be the new format.
*
* @param name
* The name of this entry.
* @param size
* The size of this entry
*/
public CpioArchiveEntry(final String name, final long size) {
this(name);
this.setSize(size);
}
/**
* Creates a CpioArchiveEntry with a specified name.
*
* @param format
* The cpio format for this entry.
* @param name
* The name of this entry.
* @param size
* The size of this entry
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final String name,
final long size) {
this(format, name);
this.setSize(size);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file. The format of this entry will be the new
* format.
*
* @param inputFile
* The file to gather information from.
* @param entryName
* The name of this entry.
*/
public CpioArchiveEntry(final File inputFile, final String entryName) {
this(FORMAT_NEW, inputFile, entryName);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file. The format of this entry will be the new
* format.
*
* @param inputPath
* The file to gather information from.
* @param entryName
* The name of this entry.
* @param options options indicating how symbolic links are handled.
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public CpioArchiveEntry(final Path inputPath, final String entryName, final LinkOption... options) throws IOException {
this(FORMAT_NEW, inputPath, entryName, options);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified file.
*
* @param format
* The cpio format for this entry.
* @param inputFile
* The file to gather information from.
* @param entryName
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
*
* @since 1.1
*/
public CpioArchiveEntry(final short format, final File inputFile,
final String entryName) {
this(format, entryName, inputFile.isFile() ? inputFile.length() : 0);
if (inputFile.isDirectory()){
setMode(C_ISDIR);
} else if (inputFile.isFile()){
setMode(C_ISREG);
} else {
throw new IllegalArgumentException("Cannot determine type of file "
+ inputFile.getName());
}
// TODO set other fields as needed
setTime(inputFile.lastModified() / 1000);
}
/**
* Creates a CpioArchiveEntry with a specified name for a
* specified path.
*
* @param format
* The cpio format for this entry.
* @param inputPath
* The file to gather information from.
* @param entryName
* The name of this entry.
* <p>
* Possible format values are:
* <pre>
* CpioConstants.FORMAT_NEW
* CpioConstants.FORMAT_NEW_CRC
* CpioConstants.FORMAT_OLD_BINARY
* CpioConstants.FORMAT_OLD_ASCII
* </pre>
* @param options options indicating how symbolic links are handled.
*
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public CpioArchiveEntry(final short format, final Path inputPath, final String entryName, final LinkOption... options)
throws IOException {
this(format, entryName, Files.isRegularFile(inputPath, options) ? Files.size(inputPath) : 0);
if (Files.isDirectory(inputPath, options)) {
setMode(C_ISDIR);
} else if (Files.isRegularFile(inputPath, options)) {
setMode(C_ISREG);
} else {
throw new IllegalArgumentException("Cannot determine type of file " + inputPath);
}
// TODO set other fields as needed
setTime(Files.getLastModifiedTime(inputPath, options));
}
/**
* Checks if the method is allowed for the defined format.
*/
private void checkNewFormat() {
if ((this.fileFormat & FORMAT_NEW_MASK) == 0) {
throw new UnsupportedOperationException();
}
}
/**
* Checks if the method is allowed for the defined format.
*/
private void checkOldFormat() {
if ((this.fileFormat & FORMAT_OLD_MASK) == 0) {
throw new UnsupportedOperationException();
}
}
/**
* Gets the checksum.
* Only supported for the new formats.
*
* @return Returns the checksum.
* @throws UnsupportedOperationException if the format is not a new format
*/
public long getChksum() {
checkNewFormat();
return this.chksum & 0xFFFFFFFFL;
}
/**
* Gets the device id.
*
* @return Returns the device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public long getDevice() {
checkOldFormat();
return this.min;
}
/**
* Gets the major device id.
*
* @return Returns the major device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getDeviceMaj() {
checkNewFormat();
return this.maj;
}
/**
* Gets the minor device id
*
* @return Returns the minor device id.
* @throws UnsupportedOperationException if format is not a new format
*/
public long getDeviceMin() {
checkNewFormat();
return this.min;
}
/**
* Gets the filesize.
*
* @return Returns the filesize.
* @see org.apache.commons.compress.archivers.ArchiveEntry#getSize()
*/
@Override
public long getSize() {
return this.filesize;
}
/**
* Gets the format for this entry.
*
* @return Returns the format.
*/
public short getFormat() {
return this.fileFormat;
}
/**
* Gets the group id.
*
* @return Returns the group id.
*/
public long getGID() {
return this.gid;
}
/**
* Gets the header size for this CPIO format
*
* @return Returns the header size in bytes.
*/
public int getHeaderSize() {
return this.headerSize;
}
/**
* Gets the alignment boundary for this CPIO format
*
* @return Returns the aligment boundary (0, 2, 4) in bytes
*/
public int getAlignmentBoundary() {
return this.alignmentBoundary;
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @deprecated This method doesn't properly work for multi-byte encodings. And
* creates corrupt archives. Use {@link #getHeaderPadCount(Charset)}
* or {@link #getHeaderPadCount(long)} in any case.
* @return the number of bytes needed to pad the header (0,1,2,3)
*/
@Deprecated
public int getHeaderPadCount(){
return getHeaderPadCount(null);
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @param charset
* The character set used to encode the entry name in the stream.
* @return the number of bytes needed to pad the header (0,1,2,3)
* @since 1.18
*/
public int getHeaderPadCount(final Charset charset) {
if (name == null) {
return 0;
}
if (charset == null) {
return getHeaderPadCount(name.length());
}
return getHeaderPadCount(name.getBytes(charset).length);
}
/**
* Gets the number of bytes needed to pad the header to the alignment boundary.
*
* @param nameSize
* The length of the name in bytes, as read in the stream.
* Without the trailing zero byte.
* @return the number of bytes needed to pad the header (0,1,2,3)
*
* @since 1.18
*/
public int getHeaderPadCount(final long nameSize) {
if (this.alignmentBoundary == 0) {
return 0;
}
int size = this.headerSize + 1; // Name has terminating null
if (name != null) {
size += nameSize;
}
final int remain = size % this.alignmentBoundary;
if (remain > 0) {
return this.alignmentBoundary - remain;
}
return 0;
}
/**
* Gets the number of bytes needed to pad the data to the alignment boundary.
*
* @return the number of bytes needed to pad the data (0,1,2,3)
*/
public int getDataPadCount() {
if (this.alignmentBoundary == 0) {
return 0;
}
final long size = this.filesize;
final int remain = (int) (size % this.alignmentBoundary);
if (remain > 0) {
return this.alignmentBoundary - remain;
}
return 0;
}
/**
* Sets the inode.
*
* @return Returns the inode.
*/
public long getInode() {
return this.inode;
}
/**
* Gets the mode of this entry (e.g. directory, regular file).
*
* @return Returns the mode.
*/
public long getMode() {
return mode == 0 && !CPIO_TRAILER.equals(name) ? C_ISREG : mode;
}
/**
* Gets the name.
*
* <p>This method returns the raw name as it is stored inside of the archive.</p>
*
* @return Returns the name.
*/
@Override
public String getName() {
return this.name;
}
/**
* Gets the number of links.
*
* @return Returns the number of links.
*/
public long getNumberOfLinks() {
return nlink == 0 ? isDirectory() ? 2 : 1 : nlink;
}
/**
* Gets the remote device id.
*
* @return Returns the remote device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public long getRemoteDevice() {
checkOldFormat();
return this.rmin;
}
/**
* Gets the remote major device id.
*
* @return Returns the remote major device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getRemoteDeviceMaj() {
checkNewFormat();
return this.rmaj;
}
/**
* Gets the remote minor device id.
*
* @return Returns the remote minor device id.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public long getRemoteDeviceMin() {
checkNewFormat();
return this.rmin;
}
/**
* Gets the time in seconds.
*
* @return Returns the time.
*/
public long getTime() {
return this.mtime;
}
@Override
public Date getLastModifiedDate() {
return new Date(1000 * getTime());
}
/**
* Gets the user id.
*
* @return Returns the user id.
*/
public long getUID() {
return this.uid;
}
/**
* Checks if this entry represents a block device.
*
* @return TRUE if this entry is a block device.
*/
public boolean isBlockDevice() {
return CpioUtil.fileType(mode) == C_ISBLK;
}
/**
* Checks if this entry represents a character device.
*
* @return TRUE if this entry is a character device.
*/
public boolean isCharacterDevice() {
return CpioUtil.fileType(mode) == C_ISCHR;
}
/**
* Checks if this entry represents a directory.
*
* @return TRUE if this entry is a directory.
*/
@Override
public boolean isDirectory() {
return CpioUtil.fileType(mode) == C_ISDIR;
}
/**
* Checks if this entry represents a network device.
*
* @return TRUE if this entry is a network device.
*/
public boolean isNetwork() {
return CpioUtil.fileType(mode) == C_ISNWK;
}
/**
* Checks if this entry represents a pipe.
*
* @return TRUE if this entry is a pipe.
*/
public boolean isPipe() {
return CpioUtil.fileType(mode) == C_ISFIFO;
}
/**
* Checks if this entry represents a regular file.
*
* @return TRUE if this entry is a regular file.
*/
public boolean isRegularFile() {
return CpioUtil.fileType(mode) == C_ISREG;
}
/**
* Checks if this entry represents a socket.
*
* @return TRUE if this entry is a socket.
*/
public boolean isSocket() {
return CpioUtil.fileType(mode) == C_ISSOCK;
}
/**
* Checks if this entry represents a symbolic link.
*
* @return TRUE if this entry is a symbolic link.
*/
public boolean isSymbolicLink() {
return CpioUtil.fileType(mode) == C_ISLNK;
}
/**
* Sets the checksum. The checksum is calculated by adding all bytes of a
* file to transfer (crc += buf[pos] & 0xFF).
*
* @param chksum
* The checksum to set.
*/
public void setChksum(final long chksum) {
checkNewFormat();
this.chksum = chksum & 0xFFFFFFFFL;
}
/**
* Sets the device id.
*
* @param device
* The device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public void setDevice(final long device) {
checkOldFormat();
this.min = device;
}
/**
* Sets major device id.
*
* @param maj
* The major device id to set.
*/
public void setDeviceMaj(final long maj) {
checkNewFormat();
this.maj = maj;
}
/**
* Sets the minor device id
*
* @param min
* The minor device id to set.
*/
public void setDeviceMin(final long min) {
checkNewFormat();
this.min = min;
}
/**
* Sets the filesize.
*
* @param size
* The filesize to set.
*/
public void setSize(final long size) {
if (size < 0 || size > 0xFFFFFFFFL) {
throw new IllegalArgumentException("Invalid entry size <" + size + ">");
}
this.filesize = size;
}
/**
* Sets the group id.
*
* @param gid
* The group id to set.
*/
public void setGID(final long gid) {
this.gid = gid;
}
/**
* Sets the inode.
*
* @param inode
* The inode to set.
*/
public void setInode(final long inode) {
this.inode = inode;
}
/**
* Sets the mode of this entry (e.g. directory, regular file).
*
* @param mode
* The mode to set.
*/
public void setMode(final long mode) {
final long maskedMode = mode & S_IFMT;
switch ((int) maskedMode) {
case C_ISDIR:
case C_ISLNK:
case C_ISREG:
case C_ISFIFO:
case C_ISCHR:
case C_ISBLK:
case C_ISSOCK:
case C_ISNWK:
break;
default:
throw new IllegalArgumentException(
"Unknown mode. "
+ "Full: " + Long.toHexString(mode)
+ " Masked: " + Long.toHexString(maskedMode));
}
this.mode = mode;
}
/**
* Sets the name.
*
* @param name
* The name to set.
*/
public void setName(final String name) {
this.name = name;
}
/**
* Sets the number of links.
*
* @param nlink
* The number of links to set.
*/
public void setNumberOfLinks(final long nlink) {
this.nlink = nlink;
}
/**
* Sets the remote device id.
*
* @param device
* The remote device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with a new
* format.
*/
public void setRemoteDevice(final long device) {
checkOldFormat();
this.rmin = device;
}
/**
* Sets the remote major device id.
*
* @param rmaj
* The remote major device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public void setRemoteDeviceMaj(final long rmaj) {
checkNewFormat();
this.rmaj = rmaj;
}
/**
* Sets the remote minor device id.
*
* @param rmin
* The remote minor device id to set.
* @throws UnsupportedOperationException
* if this method is called for a CpioArchiveEntry with an old
* format.
*/
public void setRemoteDeviceMin(final long rmin) {
checkNewFormat();
this.rmin = rmin;
}
/**
* Sets the time in seconds.
*
* @param time
* The time to set.
*/
public void setTime(final long time) {
this.mtime = time;
}
/**
* Sets the time.
*
* @param time
* The time to set.
*/
public void setTime(final FileTime time) {
this.mtime = time.to(TimeUnit.SECONDS);
}
/**
* Sets the user id.
*
* @param uid
* The user id to set.
*/
public void setUID(final long uid) {
this.uid = uid;
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return Objects.hash(name);
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (obj == null || getClass() != obj.getClass()) {
return false;
}
final CpioArchiveEntry other = (CpioArchiveEntry) obj;
if (name == null) {
return other.name == null;
}
return name.equals(other.name);
}
}
| Better IllegalArgumentException message.
| src/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java | Better IllegalArgumentException message. | <ide><path>rc/main/java/org/apache/commons/compress/archivers/cpio/CpioArchiveEntry.java
<ide> this.alignmentBoundary = 2;
<ide> break;
<ide> default:
<del> throw new IllegalArgumentException("Unknown header type");
<add> throw new IllegalArgumentException("Unknown header type " + format);
<ide> }
<ide> this.fileFormat = format;
<ide> } |
|
Java | bsd-2-clause | 571256f00731b0f306fa237a1a18681f8a369eb3 | 0 | eddysystems/eddy,eddysystems/eddy | package tarski;
import scala.Function0;
import scala.Function1;
import scala.Function2;
import scala.collection.immutable.$colon$colon$;
import scala.collection.immutable.List;
import scala.collection.immutable.Nil$;
import tarski.Scores.*;
import java.util.PriorityQueue;
import static java.lang.Math.max;
import static tarski.Scores.oneError;
import static tarski.Scores.nestError;
public class JavaScores {
// If true, failure causes are tracked via Bad. If false, only Empty and Best are used.
static final boolean trackErrors = false;
// To enable probability tracking, swap the comment blocks below and make the substitution
// double /*Prob*/ -> DebugProb
// except without the space. Also swap the definition of Prob in Scores, and fix the compile error in JavaTrie.
// Divide two probabilities, turning infinity into 2
static double pdiv(double x, double y) { return y == 0 ? 2 : x/y; }
// Indirection functions so that we can swap in DebugProb for debugging
static final boolean trackProbabilities = false;
static double pp(double x) { return x; }
static double pmul(double x, double y) { return x*y; }
static final double pzero = 0;
static double padd(double x, double y) { return x+y; }
static double pcomp(double x) { return 1-x; }
/**/
// Named probabilities. Very expensive, so enable only for debugging.
/*
static class DebugProb {
final double prob;
DebugProb(double prob) { this.prob = prob; }
public boolean equals(Object y) { return y instanceof DebugProb && prob==((DebugProb)y).prob; }
}
static final class NameProb extends DebugProb {
final String name;
NameProb(String name, double prob) { super(prob); this.name = name; }
}
static final class MulProb extends DebugProb {
final DebugProb x,y;
MulProb(DebugProb x, DebugProb y) { super(x.prob*y.prob); this.x = x; this.y = y; }
}
static final class AddProb extends DebugProb {
final DebugProb x,y;
AddProb(DebugProb x, DebugProb y) { super(x.prob+y.prob); this.x = x; this.y = y; }
}
static final class CompProb extends DebugProb {
final DebugProb x;
CompProb(DebugProb x) { super(x.prob); this.x = x; }
}
static final boolean trackProbabilities = true;
static double pp(DebugProb x) { return x.prob; }
static DebugProb pmul(DebugProb x, DebugProb y) { return new MulProb(x,y); }
static final DebugProb pzero = null;
static DebugProb padd(DebugProb x, DebugProb y) { return y==pzero ? x : new AddProb(x,y); }
static DebugProb pcomp(DebugProb x) { return new CompProb(x); }
static double pdiv(double x, DebugProb y) { return pdiv(x,y.prob); }
/**/
// s bias q
static final class Biased<B> extends HasProb {
final double/*Prob*/ q;
final Scored<B> s;
Biased(double/*Prob*/ q, Scored<B> s) {
this.q = q;
this.s = s;
}
public double p() {
return pp(q)*s.p();
}
}
static abstract public class State<A> {
// Current probability bound. May decrease over time.
abstract public double p();
// Once called, the extractor should be discarded.
abstract public Scored<A> extract(double p);
}
static public final class Extractor<A> extends LazyScored<A> {
private final double _p;
private State<A> state;
private Scored<A> _s;
public Extractor(State<A> state) {
this._p = state.p();
this.state = state;
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (_s == null) {
_s = state.extract(p);
state = null;
}
return _s;
}
}
static public final class FlatMapState<A,B> extends State<B> {
private final Function1<A,Scored<B>> f; // Our flatMap function
private Scored<A> as; // Unprocessed input
private PriorityQueue<Biased<B>> bs; // Sorted processed output
private List<Bad> bads; // List of errors, null if we've already found something
public FlatMapState(Scored<A> input, Function1<A,Scored<B>> f) {
this.as = input;
this.f = f;
if (trackErrors)
bads = (List)Nil$.MODULE$;
}
public double p() {
return max(as.p(), bs == null || bs.isEmpty() ? 0 : bs.peek().p());
}
public Scored<B> extract(final double goal) {
do {
// If bs is better than as, we may be done
if (bs != null) {
final double asp = as.p();
final Biased<B> b = bs.peek();
if (b != null && b.p() >= asp) {
bs.poll();
if (b.s instanceof LazyScored) { // Force and add back to heap
final double limit = max(max(goal,asp),bs.isEmpty() ? 0 : bs.peek().p());
bs.add(new Biased<B>(b.q,((LazyScored<B>)b.s).force(limit)));
continue;
} else if (b.s instanceof Best) { // We found the best one
bads = null; // We've found at least one thing, so no need to track errors further
final Best<B> bb = (Best<B>)b.s;
final Scored<B> r = bb.r();
if (!(r instanceof Empty$))
bs.add(new Biased<B>(b.q,r));
return new Best<B>(pmul(b.q,bb.dp()),bb.x(),new Extractor<B>(this));
} else if (bads != null) {
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)b.s,bads);
continue;
}
}
}
// Otherwise, dig into as
if (as instanceof LazyScored) {
final double limit = max(goal,bs==null || bs.isEmpty() ? 0 : bs.peek().p());
as = ((LazyScored<A>)as).force(limit);
continue;
} else if (as instanceof Best) {
final Best<A> ab = (Best<A>)this.as;
as = ab.r();
if (bs == null)
bs = new PriorityQueue<Biased<B>>();
bs.add(new Biased<B>(ab.dp(),f.apply(ab.x())));
continue;
} else if (bads == null)
return (Scored)Empty$.MODULE$;
else if (as instanceof Bad)
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)as,bads);
return nestError("flatMap failed",bads);
} while (p() > goal);
// If we hit goal without finding an option, return more laziness
return new Extractor<B>(this);
}
}
static public final class OrderedAlternativeState<A> extends State<A> {
private PriorityQueue<Alt<A>> heap;
private Function0<List<Alt<A>>> more;
private Function0<String> error;
// Requires: prob first >= prob andThen
public OrderedAlternativeState(List<Alt<A>> list, Function0<List<Alt<A>>> more, Function0<String> error) {
this.error = error;
heap = new PriorityQueue<Alt<A>>();
absorb(list);
if (more != null && heap.isEmpty())
absorb(more.apply());
else
this.more = more;
}
private void absorb(List<Alt<A>> list) {
while (!list.isEmpty()) {
heap.add(list.head());
list = (List<Alt<A>>)list.tail();
}
}
// Current probability bound
public double p() {
Alt<A> a = heap.peek();
return a == null ? 0 : a.p();
}
public Scored<A> extract(final double goal) {
if (heap.isEmpty()) {
if (more != null) {
absorb(more.apply());
more = null;
}
if (heap.isEmpty()) {
if (error == null)
return (Scored<A>)Empty$.MODULE$;
return oneError(error);
}
}
Alt<A> a = heap.poll();
error = null;
return new Best<A>(a.dp(),a.x(),new Extractor<A>(this));
}
}
static public final class UniformState<A> extends State<A> {
private final double/*Prob*/ _p;
private A[] xs;
private int i;
private Function0<String> error;
public UniformState(double/*Prob*/ p, A[] xs, Function0<String> error) {
this._p = p;
this.xs = xs == null || xs.length == 0 ? null : xs;
this.error = this.xs == null ? error : null;
}
public double p() {
return xs == null ? 0 : pp(_p);
}
public Scored<A> extract(final double goal) {
if (xs == null) {
if (error == null)
return (Scored<A>)Empty$.MODULE$;
return oneError(error);
}
final A x = xs[i++];
if (i == xs.length)
xs = null;
return new Best<A>(_p,x,new Extractor<A>(this));
}
}
static public final class MultipleState<A> extends State<A> {
private final PriorityQueue<Scored<A>> heap;
// List of errors, null if we've already found at least one option.
private List<Bad> bads;
// The Alt's probability is an upper bound on the Scored returned by the functions
public MultipleState(List<Scored<A>> options) {
assert options.nonEmpty();
heap = new PriorityQueue<Scored<A>>();
while (options.nonEmpty()) {
heap.add(options.head());
options = (List)options.tail();
}
if (trackErrors)
bads = (List)Nil$.MODULE$;
}
// Current probability bound
public double p() {
final Scored<A> a = heap.peek();
return a == null ? 0 : a.p();
}
public Scored<A> extract(final double goal) {
do {
if (heap.isEmpty()) {
if (bads == null)
return (Scored<A>)Empty$.MODULE$;
return nestError("multiple failed",bads);
}
final Scored<A> s = heap.poll();
if (s instanceof LazyScored) {
final double limit = max(goal,p());
heap.add(((LazyScored<A>)s).force(limit));
} else if (s instanceof Best) {
bads = null; // We've found at least one option, so no need to track errors
final Best<A> b = (Best<A>)s;
heap.add(b.r());
return new Best<A>(b.dp(),b.x(),new Extractor<A>(this));
} else if (bads != null)
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)s,bads);
} while (heap.isEmpty() || heap.peek().p() > goal);
// If we hit goal without finding an option, return more laziness
return new Extractor<A>(this);
}
}
// Lazy version of x bias q
static public final class LazyBias<A> extends LazyScored<A> {
private LazyScored<A> x;
private final double/*Prob*/ q;
private final double _p;
private Scored<A> s;
public LazyBias(LazyScored<A> x, double/*Prob*/ q) {
this.x = x;
this.q = q;
this._p = x.p()*pp(q);
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (s == null) {
final double pq = pdiv(p,q);
Scored<A> x = this.x.force(pq); this.x = null;
for (;;) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (_x.p() > pq) {
x = _x.force(pq);
continue;
} else
s = new LazyBias<A>(_x,q);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(pmul(q,_x.dp()),_x.x(),_x.r().bias(q));
} else
s = x;
break;
}
}
return s;
}
}
// Lazy version of x ++ y, assuming x.p >= y.p
static public final class LazyPlus<A> extends LazyScored<A> {
private LazyScored<A> x;
private Scored<A> y;
private final double _p;
private Scored<A> s;
LazyPlus(LazyScored<A> x, Scored<A> y) {
this.x = x;
this.y = y;
this._p = x.p();
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (s == null) {
Scored<A> x = this.x.force(max(p,y.p())); this.x = null;
Scored<A> y = this.y; this.y = null;
for (;;) {
if (x.p() < y.p()) {
Scored<A> t = x; x = y; y = t;
}
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (x.p() > p) {
x = _x.force(max(p,y.p()));
continue;
} else
s = new LazyPlus<A>(_x,y);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(_x.dp(),_x.x(),_x.r().$plus$plus(y));
} else if (trackErrors && x instanceof Bad)
s = x.$plus$plus(y);
else
s = y;
break;
}
}
return s;
}
}
// Lazy version of x map f bias p, where f and p are abstract.
static public abstract class LazyMapBase<A,B> extends LazyScored<B> {
private Scored<A> x;
private final double _p;
private Scored<B> s;
LazyMapBase(Scored<A> x, double bound) {
this.x = x;
this._p = bound;
}
// Abstract interface
abstract protected LazyMapBase<A,B> clone(Scored<A> x); // Map a different Scored
abstract protected Best<B> map(double/*Prob*/ p, A x, Scored<B> r); // Apply the map
public double p() {
return _p;
}
public Scored<B> force(double p) {
if (s == null) {
Scored<A> x = this.x; this.x = null;
for (boolean first=true;;first=false) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (first || _x.p() > p) {
x = _x.force(p);
continue;
} else
s = clone(x);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
final Scored<A> xr = _x.r();
final Scored<B> fr = xr instanceof EmptyOrBad ? (Scored<B>)Empty$.MODULE$ : clone(xr);
s = map(_x.dp(),_x.x(),fr);
} else
s = (Scored)x;
break;
}
}
return s;
}
}
// Lazy version of x map f
static public final class LazyMap<A,B> extends LazyMapBase<A,B> {
private Function1<A,B> f;
LazyMap(Scored<A> x, Function1<A,B> f) { super(x,x.p()); this.f = f; }
protected LazyMap<A,B> clone(Scored<A> x) { return new LazyMap<A,B>(x,f); }
protected Best<B> map(double/*Prob*/ p, A x, Scored<B> r) { return new Best<B>(p,f.apply(x),r); }
}
// Lazy version of x.productWith(y)(f)
static public final class LazyProductWith<A,B,C> extends LazyScored<C> {
private Scored<A> x;
private Scored<B> y;
private final double _p, yp;
private Function2<A,B,C> f;
private Scored<C> s;
LazyProductWith(Scored<A> x, Scored<B> y, Function2<A,B,C> f) {
this.x = x;
this.y = y;
this.f = f;
yp = y.p();
_p = x.p()*yp;
}
public double p() {
return _p;
}
static private final class FX<A,B,C> extends LazyMapBase<B,C> {
private final double/*Prob*/ px;
private final A x;
private final Function2<A,B,C> f;
FX(double/*Prob*/ px, A x, Scored<B> y, Function2<A,B,C> f) { super(y,pp(px)*y.p()); this.px = px; this.x = x; this.f = f; }
protected FX<A,B,C> clone(Scored<B> y) { return new FX<A,B,C>(px,x,y,f); }
protected Best<C> map(double/*Prob*/ py, B y, Scored<C> r) { return new Best<C>(pmul(px,py),f.apply(x,y),r); }
}
static private final class FY<A,B,C> extends LazyMapBase<A,C> {
private final double/*Prob*/ py;
private final B y;
private final Function2<A,B,C> f;
FY(double/*Prob*/ py, Scored<A> x, B y, Function2<A,B,C> f) { super(x,x.p()*pp(py)); this.py = py; this.y = y; this.f = f; }
protected FY<A,B,C> clone(Scored<A> x) { return new FY<A,B,C>(py,x,y,f); }
protected Best<C> map(double/*Prob*/ px, A x, Scored<C> r) { return new Best<C>(pmul(px,py),f.apply(x,y),r); }
}
public Scored<C> force(double p) {
if (s == null) {
final double px = pdiv(p,yp);
Scored<A> x = this.x; this.x = null;
Scored<B> y = this.y; this.y = null;
final Function2<A,B,C> f = this.f; this.f = null;
for (boolean first=true;;first=false) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (first || _x.p() > px) {
x = _x.force(px);
continue;
} else
s = new LazyProductWith<A,B,C>(x,y,f);
} else if (x instanceof EmptyOrBad)
s = (Scored)x;
else {
final Best<A> _x = (Best<A>)x;
final double xp = _x.p();
final double py = pdiv(p,xp);
for (;;first=false) {
if (y instanceof LazyScored) {
final LazyScored<B> _y = (LazyScored<B>)y;
if (first || y.p() > py) {
y = _y.force(py);
continue;
} else
s = new LazyProductWith<A,B,C>(x,y,f);
} else if (y instanceof EmptyOrBad)
s = (Scored)y;
else {
final Best<B> _y = (Best<B>)y;
final double/*Prob*/ xdp = _x.dp();
final double/*Prob*/ ydp = _y.dp();
final A xx = _x.x();
final B yx = _y.x();
final Scored<A> xr = _x.r();
final Scored<B> yr = _y.r();
LazyScored<C> r0 = yr instanceof EmptyOrBad ? null : new FX<A,B,C>(xdp,xx,yr,f),
r1 = xr instanceof EmptyOrBad ? null : new FY<A,B,C>(ydp,xr,yx,f);
if ((r0 == null ? -1 : r0.p()) < (r1 == null ? -1 : r1.p())) {
final LazyScored<C> t = r0; r0 = r1; r1 = t;
}
if (r1 != null)
r0 = new LazyPlus<C>(r0,r1);
final Scored<C> r = r0 == null ? (Scored<C>)Empty$.MODULE$
: new LazyPlus<C>(r0,new LazyProductWith<A,B,C>(xr,yr,f));
s = new Best<C>(pmul(xdp,ydp),f.apply(xx,yx),r);
}
break;
}
break;
}
break;
}
}
return s;
}
}
static public final class LazyBiased<A> extends LazyScored<A> {
private final double/*Prob*/ _p;
private Function0<Scored<A>> f;
private Scored<A> s;
LazyBiased(double/*Prob*/ p, Function0<Scored<A>> f) {
this._p = p;
this.f = f;
}
public double p() {
return pp(_p);
}
public Scored<A> force(double q) {
if (s == null) {
final double pq = pdiv(q,_p);
Scored<A> x = f.apply(); f = null;
for (;;) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (_x.p() > pq) {
x = _x.force(pq);
continue;
} else
s = new LazyBias<A>(_x,_p);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(pmul(_p,_x.dp()),_x.x(),_x.r().bias(_p));
} else
s = (Scored)x;
break;
}
}
return s;
}
}
static public final class LazyBound<A> extends LazyScored<A> {
private final double _p;
private Function0<Scored<A>> f;
private Scored<A> s;
LazyBound(double p, Function0<Scored<A>> f) {
this._p = p;
this.f = f;
}
public double p() {
return _p;
}
public Scored<A> force(double q) {
if (s == null) {
Scored<A> x = f.apply(); f = null;
while (x instanceof LazyScored && x.p() > q)
x = ((LazyScored<A>)x).force(q);
s = x;
}
return s;
}
}
}
| IntelliJ-plugin/tarski/src/tarski/JavaScores.java | package tarski;
import scala.Function0;
import scala.Function1;
import scala.Function2;
import scala.collection.immutable.$colon$colon$;
import scala.collection.immutable.List;
import scala.collection.immutable.Nil$;
import tarski.Scores.*;
import java.util.PriorityQueue;
import static java.lang.Math.max;
import static tarski.Scores.oneError;
import static tarski.Scores.nestError;
public class JavaScores {
// If true, failure causes are tracked via Bad. If false, only Empty and Best are used.
static final boolean trackErrors = false;
// To enable probability tracking, swap the comment blocks below and make the substitution
// double/*Prob*/ -> DebugProb
// Also swap the definition of Prob in Scores, and fix the compile error in JavaTrie.
// Divide two probabilities, turning infinity into 2
static double pdiv(double x, double y) { return y == 0 ? 2 : x/y; }
// Indirection functions so that we can swap in DebugProb for debugging
static final boolean trackProbabilities = false;
static double pp(double x) { return x; }
static double pmul(double x, double y) { return x*y; }
static final double pzero = 0;
static double padd(double x, double y) { return x+y; }
static double pcomp(double x) { return 1-x; }
// Named probabilities. Very expensive, so enable only for debugging.
/*
static class DebugProb {
final double prob;
DebugProb(double prob) { this.prob = prob; }
public boolean equals(Object y) { return y instanceof DebugProb && prob==((DebugProb)y).prob; }
}
static final class NameProb extends DebugProb {
final String name;
NameProb(String name, double prob) { super(prob); this.name = name; }
}
static final class MulProb extends DebugProb {
final DebugProb x,y;
MulProb(DebugProb x, DebugProb y) { super(x.prob*y.prob); this.x = x; this.y = y; }
}
static final class AddProb extends DebugProb {
final DebugProb x,y;
AddProb(DebugProb x, DebugProb y) { super(x.prob+y.prob); this.x = x; this.y = y; }
}
static final class CompProb extends DebugProb {
final DebugProb x;
CompProb(DebugProb x) { super(x.prob); this.x = x; }
}
static final boolean trackProbabilities = true;
static double pp(DebugProb x) { return x.prob; }
static DebugProb pmul(DebugProb x, DebugProb y) { return new MulProb(x,y); }
static final DebugProb pzero = null;
static DebugProb padd(DebugProb x, DebugProb y) { return y==pzero ? x : new AddProb(x,y); }
static DebugProb pcomp(DebugProb x) { return new CompProb(x); }
static double pdiv(double x, DebugProb y) { return pdiv(x,y.prob); }
*/
// s bias q
static final class Biased<B> extends HasProb {
final double/*Prob*/ q;
final Scored<B> s;
Biased(double/*Prob*/ q, Scored<B> s) {
this.q = q;
this.s = s;
}
public double p() {
return pp(q)*s.p();
}
}
static abstract public class State<A> {
// Current probability bound. May decrease over time.
abstract public double p();
// Once called, the extractor should be discarded.
abstract public Scored<A> extract(double p);
}
static public final class Extractor<A> extends LazyScored<A> {
private final double _p;
private State<A> state;
private Scored<A> _s;
public Extractor(State<A> state) {
this._p = state.p();
this.state = state;
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (_s == null) {
_s = state.extract(p);
state = null;
}
return _s;
}
}
static public final class FlatMapState<A,B> extends State<B> {
private final Function1<A,Scored<B>> f; // Our flatMap function
private Scored<A> as; // Unprocessed input
private PriorityQueue<Biased<B>> bs; // Sorted processed output
private List<Bad> bads; // List of errors, null if we've already found something
public FlatMapState(Scored<A> input, Function1<A,Scored<B>> f) {
this.as = input;
this.f = f;
if (trackErrors)
bads = (List)Nil$.MODULE$;
}
public double p() {
return max(as.p(), bs == null || bs.isEmpty() ? 0 : bs.peek().p());
}
public Scored<B> extract(final double goal) {
do {
// If bs is better than as, we may be done
if (bs != null) {
final double asp = as.p();
final Biased<B> b = bs.peek();
if (b != null && b.p() >= asp) {
bs.poll();
if (b.s instanceof LazyScored) { // Force and add back to heap
final double limit = max(max(goal,asp),bs.isEmpty() ? 0 : bs.peek().p());
bs.add(new Biased<B>(b.q,((LazyScored<B>)b.s).force(limit)));
continue;
} else if (b.s instanceof Best) { // We found the best one
bads = null; // We've found at least one thing, so no need to track errors further
final Best<B> bb = (Best<B>)b.s;
final Scored<B> r = bb.r();
if (!(r instanceof Empty$))
bs.add(new Biased<B>(b.q,r));
return new Best<B>(pmul(b.q,bb.dp()),bb.x(),new Extractor<B>(this));
} else if (bads != null) {
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)b.s,bads);
continue;
}
}
}
// Otherwise, dig into as
if (as instanceof LazyScored) {
final double limit = max(goal,bs==null || bs.isEmpty() ? 0 : bs.peek().p());
as = ((LazyScored<A>)as).force(limit);
continue;
} else if (as instanceof Best) {
final Best<A> ab = (Best<A>)this.as;
as = ab.r();
if (bs == null)
bs = new PriorityQueue<Biased<B>>();
bs.add(new Biased<B>(ab.dp(),f.apply(ab.x())));
continue;
} else if (bads == null)
return (Scored)Empty$.MODULE$;
else if (as instanceof Bad)
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)as,bads);
return nestError("flatMap failed",bads);
} while (p() > goal);
// If we hit goal without finding an option, return more laziness
return new Extractor<B>(this);
}
}
static public final class OrderedAlternativeState<A> extends State<A> {
private PriorityQueue<Alt<A>> heap;
private Function0<List<Alt<A>>> more;
private Function0<String> error;
// Requires: prob first >= prob andThen
public OrderedAlternativeState(List<Alt<A>> list, Function0<List<Alt<A>>> more, Function0<String> error) {
this.error = error;
heap = new PriorityQueue<Alt<A>>();
absorb(list);
if (more != null && heap.isEmpty())
absorb(more.apply());
else
this.more = more;
}
private void absorb(List<Alt<A>> list) {
while (!list.isEmpty()) {
heap.add(list.head());
list = (List<Alt<A>>)list.tail();
}
}
// Current probability bound
public double p() {
Alt<A> a = heap.peek();
return a == null ? 0 : a.p();
}
public Scored<A> extract(final double goal) {
if (heap.isEmpty()) {
if (more != null) {
absorb(more.apply());
more = null;
}
if (heap.isEmpty()) {
if (error == null)
return (Scored<A>)Empty$.MODULE$;
return oneError(error);
}
}
Alt<A> a = heap.poll();
error = null;
return new Best<A>(a.dp(),a.x(),new Extractor<A>(this));
}
}
static public final class UniformState<A> extends State<A> {
private final double/*Prob*/ _p;
private A[] xs;
private int i;
private Function0<String> error;
public UniformState(double/*Prob*/ p, A[] xs, Function0<String> error) {
this._p = p;
this.xs = xs == null || xs.length == 0 ? null : xs;
this.error = this.xs == null ? error : null;
}
public double p() {
return xs == null ? 0 : pp(_p);
}
public Scored<A> extract(final double goal) {
if (xs == null) {
if (error == null)
return (Scored<A>)Empty$.MODULE$;
return oneError(error);
}
final A x = xs[i++];
if (i == xs.length)
xs = null;
return new Best<A>(_p,x,new Extractor<A>(this));
}
}
static public final class MultipleState<A> extends State<A> {
private final PriorityQueue<Scored<A>> heap;
// List of errors, null if we've already found at least one option.
private List<Bad> bads;
// The Alt's probability is an upper bound on the Scored returned by the functions
public MultipleState(List<Scored<A>> options) {
assert options.nonEmpty();
heap = new PriorityQueue<Scored<A>>();
while (options.nonEmpty()) {
heap.add(options.head());
options = (List)options.tail();
}
if (trackErrors)
bads = (List)Nil$.MODULE$;
}
// Current probability bound
public double p() {
final Scored<A> a = heap.peek();
return a == null ? 0 : a.p();
}
public Scored<A> extract(final double goal) {
do {
if (heap.isEmpty()) {
if (bads == null)
return (Scored<A>)Empty$.MODULE$;
return nestError("multiple failed",bads);
}
final Scored<A> s = heap.poll();
if (s instanceof LazyScored) {
final double limit = max(goal,p());
heap.add(((LazyScored<A>)s).force(limit));
} else if (s instanceof Best) {
bads = null; // We've found at least one option, so no need to track errors
final Best<A> b = (Best<A>)s;
heap.add(b.r());
return new Best<A>(b.dp(),b.x(),new Extractor<A>(this));
} else if (bads != null)
bads = $colon$colon$.MODULE$.<Bad>apply((Bad)s,bads);
} while (heap.isEmpty() || heap.peek().p() > goal);
// If we hit goal without finding an option, return more laziness
return new Extractor<A>(this);
}
}
// Lazy version of x bias q
static public final class LazyBias<A> extends LazyScored<A> {
private LazyScored<A> x;
private final double/*Prob*/ q;
private final double _p;
private Scored<A> s;
public LazyBias(LazyScored<A> x, double/*Prob*/ q) {
this.x = x;
this.q = q;
this._p = x.p()*pp(q);
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (s == null) {
final double pq = pdiv(p,q);
Scored<A> x = this.x.force(pq); this.x = null;
for (;;) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (_x.p() > pq) {
x = _x.force(pq);
continue;
} else
s = new LazyBias<A>(_x,q);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(pmul(q,_x.dp()),_x.x(),_x.r().bias(q));
} else
s = x;
break;
}
}
return s;
}
}
// Lazy version of x ++ y, assuming x.p >= y.p
static public final class LazyPlus<A> extends LazyScored<A> {
private LazyScored<A> x;
private Scored<A> y;
private final double _p;
private Scored<A> s;
LazyPlus(LazyScored<A> x, Scored<A> y) {
this.x = x;
this.y = y;
this._p = x.p();
}
public double p() {
return _p;
}
public Scored<A> force(double p) {
if (s == null) {
Scored<A> x = this.x.force(max(p,y.p())); this.x = null;
Scored<A> y = this.y; this.y = null;
for (;;) {
if (x.p() < y.p()) {
Scored<A> t = x; x = y; y = t;
}
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (x.p() > p) {
x = _x.force(max(p,y.p()));
continue;
} else
s = new LazyPlus<A>(_x,y);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(_x.dp(),_x.x(),_x.r().$plus$plus(y));
} else if (trackErrors && x instanceof Bad)
s = x.$plus$plus(y);
else
s = y;
break;
}
}
return s;
}
}
// Lazy version of x map f bias p, where f and p are abstract.
static public abstract class LazyMapBase<A,B> extends LazyScored<B> {
private Scored<A> x;
private final double _p;
private Scored<B> s;
LazyMapBase(Scored<A> x, double bound) {
this.x = x;
this._p = bound;
}
// Abstract interface
abstract protected LazyMapBase<A,B> clone(Scored<A> x); // Map a different Scored
abstract protected Best<B> map(double/*Prob*/ p, A x, Scored<B> r); // Apply the map
public double p() {
return _p;
}
public Scored<B> force(double p) {
if (s == null) {
Scored<A> x = this.x; this.x = null;
for (boolean first=true;;first=false) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (first || _x.p() > p) {
x = _x.force(p);
continue;
} else
s = clone(x);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
final Scored<A> xr = _x.r();
final Scored<B> fr = xr instanceof EmptyOrBad ? (Scored<B>)Empty$.MODULE$ : clone(xr);
s = map(_x.dp(),_x.x(),fr);
} else
s = (Scored)x;
break;
}
}
return s;
}
}
// Lazy version of x map f
static public final class LazyMap<A,B> extends LazyMapBase<A,B> {
private Function1<A,B> f;
LazyMap(Scored<A> x, Function1<A,B> f) { super(x,x.p()); this.f = f; }
protected LazyMap<A,B> clone(Scored<A> x) { return new LazyMap<A,B>(x,f); }
protected Best<B> map(double/*Prob*/ p, A x, Scored<B> r) { return new Best<B>(p,f.apply(x),r); }
}
// Lazy version of x.productWith(y)(f)
static public final class LazyProductWith<A,B,C> extends LazyScored<C> {
private Scored<A> x;
private Scored<B> y;
private final double _p, yp;
private Function2<A,B,C> f;
private Scored<C> s;
LazyProductWith(Scored<A> x, Scored<B> y, Function2<A,B,C> f) {
this.x = x;
this.y = y;
this.f = f;
yp = y.p();
_p = x.p()*yp;
}
public double p() {
return _p;
}
static private final class FX<A,B,C> extends LazyMapBase<B,C> {
private final double/*Prob*/ px;
private final A x;
private final Function2<A,B,C> f;
FX(double/*Prob*/ px, A x, Scored<B> y, Function2<A,B,C> f) { super(y,pp(px)*y.p()); this.px = px; this.x = x; this.f = f; }
protected FX<A,B,C> clone(Scored<B> y) { return new FX<A,B,C>(px,x,y,f); }
protected Best<C> map(double/*Prob*/ py, B y, Scored<C> r) { return new Best<C>(pmul(px,py),f.apply(x,y),r); }
}
static private final class FY<A,B,C> extends LazyMapBase<A,C> {
private final double/*Prob*/ py;
private final B y;
private final Function2<A,B,C> f;
FY(double/*Prob*/ py, Scored<A> x, B y, Function2<A,B,C> f) { super(x,x.p()*pp(py)); this.py = py; this.y = y; this.f = f; }
protected FY<A,B,C> clone(Scored<A> x) { return new FY<A,B,C>(py,x,y,f); }
protected Best<C> map(double/*Prob*/ px, A x, Scored<C> r) { return new Best<C>(pmul(px,py),f.apply(x,y),r); }
}
public Scored<C> force(double p) {
if (s == null) {
final double px = pdiv(p,yp);
Scored<A> x = this.x; this.x = null;
Scored<B> y = this.y; this.y = null;
final Function2<A,B,C> f = this.f; this.f = null;
for (boolean first=true;;first=false) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (first || _x.p() > px) {
x = _x.force(px);
continue;
} else
s = new LazyProductWith<A,B,C>(x,y,f);
} else if (x instanceof EmptyOrBad)
s = (Scored)x;
else {
final Best<A> _x = (Best<A>)x;
final double xp = _x.p();
final double py = pdiv(p,xp);
for (;;first=false) {
if (y instanceof LazyScored) {
final LazyScored<B> _y = (LazyScored<B>)y;
if (first || y.p() > py) {
y = _y.force(py);
continue;
} else
s = new LazyProductWith<A,B,C>(x,y,f);
} else if (y instanceof EmptyOrBad)
s = (Scored)y;
else {
final Best<B> _y = (Best<B>)y;
final double/*Prob*/ xdp = _x.dp();
final double/*Prob*/ ydp = _y.dp();
final A xx = _x.x();
final B yx = _y.x();
final Scored<A> xr = _x.r();
final Scored<B> yr = _y.r();
LazyScored<C> r0 = yr instanceof EmptyOrBad ? null : new FX<A,B,C>(xdp,xx,yr,f),
r1 = xr instanceof EmptyOrBad ? null : new FY<A,B,C>(ydp,xr,yx,f);
if ((r0 == null ? -1 : r0.p()) < (r1 == null ? -1 : r1.p())) {
final LazyScored<C> t = r0; r0 = r1; r1 = t;
}
if (r1 != null)
r0 = new LazyPlus<C>(r0,r1);
final Scored<C> r = r0 == null ? (Scored<C>)Empty$.MODULE$
: new LazyPlus<C>(r0,new LazyProductWith<A,B,C>(xr,yr,f));
s = new Best<C>(pmul(xdp,ydp),f.apply(xx,yx),r);
}
break;
}
break;
}
break;
}
}
return s;
}
}
static public final class LazyBiased<A> extends LazyScored<A> {
private final double/*Prob*/ _p;
private Function0<Scored<A>> f;
private Scored<A> s;
LazyBiased(double/*Prob*/ p, Function0<Scored<A>> f) {
this._p = p;
this.f = f;
}
public double p() {
return pp(_p);
}
public Scored<A> force(double q) {
if (s == null) {
final double pq = pdiv(q,_p);
Scored<A> x = f.apply(); f = null;
for (;;) {
if (x instanceof LazyScored) {
final LazyScored<A> _x = (LazyScored<A>)x;
if (_x.p() > pq) {
x = _x.force(pq);
continue;
} else
s = new LazyBias<A>(_x,_p);
} else if (x instanceof Best) {
final Best<A> _x = (Best<A>)x;
s = new Best<A>(pmul(_p,_x.dp()),_x.x(),_x.r().bias(_p));
} else
s = (Scored)x;
break;
}
}
return s;
}
}
static public final class LazyBound<A> extends LazyScored<A> {
private final double _p;
private Function0<Scored<A>> f;
private Scored<A> s;
LazyBound(double p, Function0<Scored<A>> f) {
this._p = p;
this.f = f;
}
public double p() {
return _p;
}
public Scored<A> force(double q) {
if (s == null) {
Scored<A> x = f.apply(); f = null;
while (x instanceof LazyScored && x.p() > q)
x = ((LazyScored<A>)x).force(q);
s = x;
}
return s;
}
}
}
| Improve comment
| IntelliJ-plugin/tarski/src/tarski/JavaScores.java | Improve comment | <ide><path>ntelliJ-plugin/tarski/src/tarski/JavaScores.java
<ide> static final boolean trackErrors = false;
<ide>
<ide> // To enable probability tracking, swap the comment blocks below and make the substitution
<del> // double/*Prob*/ -> DebugProb
<del> // Also swap the definition of Prob in Scores, and fix the compile error in JavaTrie.
<add> // double /*Prob*/ -> DebugProb
<add> // except without the space. Also swap the definition of Prob in Scores, and fix the compile error in JavaTrie.
<ide>
<ide> // Divide two probabilities, turning infinity into 2
<ide> static double pdiv(double x, double y) { return y == 0 ? 2 : x/y; }
<ide> static final double pzero = 0;
<ide> static double padd(double x, double y) { return x+y; }
<ide> static double pcomp(double x) { return 1-x; }
<add> /**/
<ide>
<ide> // Named probabilities. Very expensive, so enable only for debugging.
<ide> /*
<ide> static DebugProb padd(DebugProb x, DebugProb y) { return y==pzero ? x : new AddProb(x,y); }
<ide> static DebugProb pcomp(DebugProb x) { return new CompProb(x); }
<ide> static double pdiv(double x, DebugProb y) { return pdiv(x,y.prob); }
<del> */
<add> /**/
<ide>
<ide> // s bias q
<ide> static final class Biased<B> extends HasProb { |
|
Java | apache-2.0 | 295b4127a77de9b670ed533ac537659ca4950aec | 0 | danielsun1106/groovy-parser,danielsun1106/groovy-parser | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.groovy.parser.antlr4;
import groovy.lang.IntRange;
import org.antlr.v4.runtime.ANTLRErrorListener;
import org.antlr.v4.runtime.ANTLRInputStream;
import org.antlr.v4.runtime.CommonTokenStream;
import org.antlr.v4.runtime.RecognitionException;
import org.antlr.v4.runtime.Recognizer;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.atn.PredictionMode;
import org.antlr.v4.runtime.misc.ParseCancellationException;
import org.antlr.v4.runtime.tree.ParseTree;
import org.antlr.v4.runtime.tree.TerminalNode;
import org.apache.groovy.parser.antlr4.internal.AtnManager;
import org.apache.groovy.parser.antlr4.internal.DescriptiveErrorStrategy;
import org.apache.groovy.parser.antlr4.util.StringUtils;
import org.codehaus.groovy.GroovyBugError;
import org.codehaus.groovy.antlr.EnumHelper;
import org.codehaus.groovy.ast.ASTNode;
import org.codehaus.groovy.ast.AnnotationNode;
import org.codehaus.groovy.ast.ClassHelper;
import org.codehaus.groovy.ast.ClassNode;
import org.codehaus.groovy.ast.ConstructorNode;
import org.codehaus.groovy.ast.EnumConstantClassNode;
import org.codehaus.groovy.ast.FieldNode;
import org.codehaus.groovy.ast.GenericsType;
import org.codehaus.groovy.ast.ImportNode;
import org.codehaus.groovy.ast.InnerClassNode;
import org.codehaus.groovy.ast.MethodNode;
import org.codehaus.groovy.ast.ModuleNode;
import org.codehaus.groovy.ast.PackageNode;
import org.codehaus.groovy.ast.Parameter;
import org.codehaus.groovy.ast.PropertyNode;
import org.codehaus.groovy.ast.expr.AnnotationConstantExpression;
import org.codehaus.groovy.ast.expr.ArgumentListExpression;
import org.codehaus.groovy.ast.expr.ArrayExpression;
import org.codehaus.groovy.ast.expr.AttributeExpression;
import org.codehaus.groovy.ast.expr.BinaryExpression;
import org.codehaus.groovy.ast.expr.BitwiseNegationExpression;
import org.codehaus.groovy.ast.expr.BooleanExpression;
import org.codehaus.groovy.ast.expr.CastExpression;
import org.codehaus.groovy.ast.expr.ClassExpression;
import org.codehaus.groovy.ast.expr.ClosureExpression;
import org.codehaus.groovy.ast.expr.ClosureListExpression;
import org.codehaus.groovy.ast.expr.ConstantExpression;
import org.codehaus.groovy.ast.expr.ConstructorCallExpression;
import org.codehaus.groovy.ast.expr.DeclarationExpression;
import org.codehaus.groovy.ast.expr.ElvisOperatorExpression;
import org.codehaus.groovy.ast.expr.EmptyExpression;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.expr.GStringExpression;
import org.codehaus.groovy.ast.expr.LambdaExpression;
import org.codehaus.groovy.ast.expr.ListExpression;
import org.codehaus.groovy.ast.expr.MapEntryExpression;
import org.codehaus.groovy.ast.expr.MapExpression;
import org.codehaus.groovy.ast.expr.MethodCallExpression;
import org.codehaus.groovy.ast.expr.MethodPointerExpression;
import org.codehaus.groovy.ast.expr.MethodReferenceExpression;
import org.codehaus.groovy.ast.expr.NamedArgumentListExpression;
import org.codehaus.groovy.ast.expr.NotExpression;
import org.codehaus.groovy.ast.expr.PostfixExpression;
import org.codehaus.groovy.ast.expr.PrefixExpression;
import org.codehaus.groovy.ast.expr.PropertyExpression;
import org.codehaus.groovy.ast.expr.RangeExpression;
import org.codehaus.groovy.ast.expr.SpreadExpression;
import org.codehaus.groovy.ast.expr.SpreadMapExpression;
import org.codehaus.groovy.ast.expr.TernaryExpression;
import org.codehaus.groovy.ast.expr.TupleExpression;
import org.codehaus.groovy.ast.expr.UnaryMinusExpression;
import org.codehaus.groovy.ast.expr.UnaryPlusExpression;
import org.codehaus.groovy.ast.expr.VariableExpression;
import org.codehaus.groovy.ast.stmt.AssertStatement;
import org.codehaus.groovy.ast.stmt.BlockStatement;
import org.codehaus.groovy.ast.stmt.BreakStatement;
import org.codehaus.groovy.ast.stmt.CaseStatement;
import org.codehaus.groovy.ast.stmt.CatchStatement;
import org.codehaus.groovy.ast.stmt.ContinueStatement;
import org.codehaus.groovy.ast.stmt.DoWhileStatement;
import org.codehaus.groovy.ast.stmt.EmptyStatement;
import org.codehaus.groovy.ast.stmt.ExpressionStatement;
import org.codehaus.groovy.ast.stmt.ForStatement;
import org.codehaus.groovy.ast.stmt.IfStatement;
import org.codehaus.groovy.ast.stmt.ReturnStatement;
import org.codehaus.groovy.ast.stmt.Statement;
import org.codehaus.groovy.ast.stmt.SwitchStatement;
import org.codehaus.groovy.ast.stmt.SynchronizedStatement;
import org.codehaus.groovy.ast.stmt.ThrowStatement;
import org.codehaus.groovy.ast.stmt.TryCatchStatement;
import org.codehaus.groovy.ast.stmt.WhileStatement;
import org.codehaus.groovy.control.CompilationFailedException;
import org.codehaus.groovy.control.CompilePhase;
import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.control.messages.SyntaxErrorMessage;
import org.codehaus.groovy.runtime.IOGroovyMethods;
import org.codehaus.groovy.runtime.StringGroovyMethods;
import org.codehaus.groovy.syntax.Numbers;
import org.codehaus.groovy.syntax.SyntaxException;
import org.codehaus.groovy.syntax.Types;
import org.objectweb.asm.Opcodes;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.Field;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static org.apache.groovy.parser.antlr4.GroovyLangParser.*;
import static org.codehaus.groovy.runtime.DefaultGroovyMethods.asBoolean;
import static org.codehaus.groovy.runtime.DefaultGroovyMethods.last;
/**
* Building the AST from the parse tree generated by Antlr4
*
* @author <a href="mailto:[email protected]">Daniel.Sun</a>
* Created on 2016/08/14
*/
public class AstBuilder extends GroovyParserBaseVisitor<Object> implements GroovyParserVisitor<Object> {
public AstBuilder(SourceUnit sourceUnit, ClassLoader classLoader) {
this.sourceUnit = sourceUnit;
this.moduleNode = new ModuleNode(sourceUnit);
this.classLoader = classLoader; // unused for the time being
this.lexer = new GroovyLangLexer(
new ANTLRInputStream(
this.readSourceCode(sourceUnit)));
this.parser = new GroovyLangParser(
new CommonTokenStream(this.lexer));
this.parser.setErrorHandler(new DescriptiveErrorStrategy());
this.tryWithResourcesASTTransformation = new TryWithResourcesASTTransformation(this);
this.groovydocManager = new GroovydocManager(this);
}
private GroovyParserRuleContext buildCST() {
GroovyParserRuleContext result;
// parsing have to wait util clearing is complete.
AtnManager.RRWL.readLock().lock();
try {
result = buildCST(PredictionMode.SLL);
} catch (Throwable t) {
// if some syntax error occurred in the lexer, no need to retry the powerful LL mode
if (t instanceof GroovySyntaxError && GroovySyntaxError.LEXER == ((GroovySyntaxError) t).getSource()) {
throw t;
}
result = buildCST(PredictionMode.LL);
} finally {
AtnManager.RRWL.readLock().unlock();
}
return result;
}
private GroovyParserRuleContext buildCST(PredictionMode predictionMode) {
parser.getInterpreter().setPredictionMode(predictionMode);
if (PredictionMode.SLL.equals(predictionMode)) {
this.removeErrorListeners();
} else {
((CommonTokenStream) parser.getInputStream()).reset();
this.addErrorListeners();
}
return parser.compilationUnit();
}
public ModuleNode buildAST() {
try {
return (ModuleNode) this.visit(this.buildCST());
} catch (Throwable t) {
CompilationFailedException cfe;
if (t instanceof CompilationFailedException) {
cfe = (CompilationFailedException) t;
} else if (t instanceof ParseCancellationException) {
cfe = createParsingFailedException(t.getCause());
} else {
cfe = createParsingFailedException(t);
}
// LOGGER.log(Level.SEVERE, "Failed to build AST", cfe);
throw cfe;
}
}
@Override
public ModuleNode visitCompilationUnit(CompilationUnitContext ctx) {
this.visit(ctx.packageDeclaration());
ctx.statement().stream()
.map(this::visit)
// .filter(e -> e instanceof Statement)
.forEach(e -> {
if (e instanceof DeclarationListStatement) { // local variable declaration
((DeclarationListStatement) e).getDeclarationStatements().forEach(moduleNode::addStatement);
} else if (e instanceof Statement) {
moduleNode.addStatement((Statement) e);
} else if (e instanceof MethodNode) { // script method
moduleNode.addMethod((MethodNode) e);
}
});
this.classNodeList.forEach(moduleNode::addClass);
if (this.isPackageInfoDeclaration()) {
this.addPackageInfoClassNode();
} else {
// if groovy source file only contains blank(including EOF), add "return null" to the AST
if (this.isBlankScript(ctx)) {
this.addEmptyReturnStatement();
}
}
this.configureScriptClassNode();
return moduleNode;
}
@Override
public PackageNode visitPackageDeclaration(PackageDeclarationContext ctx) {
String packageName = this.visitQualifiedName(ctx.qualifiedName());
moduleNode.setPackageName(packageName + DOT_STR);
PackageNode packageNode = moduleNode.getPackage();
this.visitAnnotationsOpt(ctx.annotationsOpt()).forEach(packageNode::addAnnotation);
return this.configureAST(packageNode, ctx);
}
@Override
public ImportNode visitImportDeclaration(ImportDeclarationContext ctx) {
ImportNode importNode;
boolean hasStatic = asBoolean(ctx.STATIC());
boolean hasStar = asBoolean(ctx.MUL());
boolean hasAlias = asBoolean(ctx.alias);
List<AnnotationNode> annotationNodeList = this.visitAnnotationsOpt(ctx.annotationsOpt());
if (hasStatic) {
if (hasStar) { // e.g. import static java.lang.Math.*
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
ClassNode type = ClassHelper.make(qualifiedName);
this.configureAST(type, ctx);
moduleNode.addStaticStarImport(type.getText(), type, annotationNodeList);
importNode = last(moduleNode.getStaticStarImports().values());
} else { // e.g. import static java.lang.Math.pow
List<GroovyParserRuleContext> identifierList = new LinkedList<>(ctx.qualifiedName().qualifiedNameElement());
int identifierListSize = identifierList.size();
String name = identifierList.get(identifierListSize - 1).getText();
ClassNode classNode =
ClassHelper.make(
identifierList.stream()
.limit(identifierListSize - 1)
.map(ParseTree::getText)
.collect(Collectors.joining(DOT_STR)));
String alias = hasAlias
? ctx.alias.getText()
: name;
this.configureAST(classNode, ctx);
moduleNode.addStaticImport(classNode, name, alias, annotationNodeList);
importNode = last(moduleNode.getStaticImports().values());
}
} else {
if (hasStar) { // e.g. import java.util.*
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
moduleNode.addStarImport(qualifiedName + DOT_STR, annotationNodeList);
importNode = last(moduleNode.getStarImports());
} else { // e.g. import java.util.Map
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
String name = last(ctx.qualifiedName().qualifiedNameElement()).getText();
ClassNode classNode = ClassHelper.make(qualifiedName);
String alias = hasAlias
? ctx.alias.getText()
: name;
this.configureAST(classNode, ctx);
moduleNode.addImport(alias, classNode, annotationNodeList);
importNode = last(moduleNode.getImports());
}
}
return this.configureAST(importNode, ctx);
}
// statement { --------------------------------------------------------------------
@Override
public AssertStatement visitAssertStatement(AssertStatementContext ctx) {
Expression conditionExpression = (Expression) this.visit(ctx.ce);
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
if (!asBoolean(ctx.me)) {
return this.configureAST(
new AssertStatement(booleanExpression), ctx);
}
return this.configureAST(new AssertStatement(booleanExpression,
(Expression) this.visit(ctx.me)),
ctx);
}
@Override
public AssertStatement visitAssertStmtAlt(AssertStmtAltContext ctx) {
return this.configureAST(this.visitAssertStatement(ctx.assertStatement()), ctx);
}
@Override
public IfStatement visitIfElseStmtAlt(IfElseStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
Statement ifBlock =
this.unpackStatement(
(Statement) this.visit(ctx.tb));
Statement elseBlock =
this.unpackStatement(
asBoolean(ctx.ELSE())
? (Statement) this.visit(ctx.fb)
: EmptyStatement.INSTANCE);
return this.configureAST(new IfStatement(booleanExpression, ifBlock, elseBlock), ctx);
}
@Override
public Statement visitLoopStmtAlt(LoopStmtAltContext ctx) {
return this.configureAST((Statement) this.visit(ctx.loopStatement()), ctx);
}
@Override
public ForStatement visitForStmtAlt(ForStmtAltContext ctx) {
Pair<Parameter, Expression> controlPair = this.visitForControl(ctx.forControl());
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new ForStatement(controlPair.getKey(), controlPair.getValue(), asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public Pair<Parameter, Expression> visitForControl(ForControlContext ctx) {
if (asBoolean(ctx.enhancedForControl())) { // e.g. for(int i in 0..<10) {}
return this.visitEnhancedForControl(ctx.enhancedForControl());
}
if (asBoolean(ctx.classicalForControl())) { // e.g. for(int i = 0; i < 10; i++) {}
return this.visitClassicalForControl(ctx.classicalForControl());
}
throw createParsingFailedException("Unsupported for control: " + ctx.getText(), ctx);
}
@Override
public Expression visitForInit(ForInitContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
if (asBoolean(ctx.localVariableDeclaration())) {
DeclarationListStatement declarationListStatement = this.visitLocalVariableDeclaration(ctx.localVariableDeclaration());
List<?> declarationExpressionList = declarationListStatement.getDeclarationExpressions();
if (declarationExpressionList.size() == 1) {
return this.configureAST((Expression) declarationExpressionList.get(0), ctx);
} else {
return this.configureAST(new ClosureListExpression((List<Expression>) declarationExpressionList), ctx);
}
}
if (asBoolean(ctx.expressionList())) {
return this.translateExpressionList(ctx.expressionList());
}
throw createParsingFailedException("Unsupported for init: " + ctx.getText(), ctx);
}
@Override
public Expression visitForUpdate(ForUpdateContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
return this.translateExpressionList(ctx.expressionList());
}
private Expression translateExpressionList(ExpressionListContext ctx) {
List<Expression> expressionList = this.visitExpressionList(ctx);
if (expressionList.size() == 1) {
return this.configureAST(expressionList.get(0), ctx);
} else {
return this.configureAST(new ClosureListExpression(expressionList), ctx);
}
}
@Override
public Pair<Parameter, Expression> visitEnhancedForControl(EnhancedForControlContext ctx) {
Parameter parameter = this.configureAST(
new Parameter(this.visitType(ctx.type()), this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName()),
ctx.variableDeclaratorId());
// FIXME Groovy will ignore variableModifier of parameter in the for control
// In order to make the new parser behave same with the old one, we do not process variableModifier*
return new Pair<>(parameter, (Expression) this.visit(ctx.expression()));
}
@Override
public Pair<Parameter, Expression> visitClassicalForControl(ClassicalForControlContext ctx) {
ClosureListExpression closureListExpression = new ClosureListExpression();
closureListExpression.addExpression(this.visitForInit(ctx.forInit()));
closureListExpression.addExpression(asBoolean(ctx.expression()) ? (Expression) this.visit(ctx.expression()) : EmptyExpression.INSTANCE);
closureListExpression.addExpression(this.visitForUpdate(ctx.forUpdate()));
return new Pair<>(ForStatement.FOR_LOOP_DUMMY, closureListExpression);
}
@Override
public WhileStatement visitWhileStmtAlt(WhileStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new WhileStatement(booleanExpression, asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public DoWhileStatement visitDoWhileStmtAlt(DoWhileStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression),
conditionExpression
);
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new DoWhileStatement(booleanExpression, asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public Statement visitTryCatchStmtAlt(TryCatchStmtAltContext ctx) {
return this.configureAST(this.visitTryCatchStatement(ctx.tryCatchStatement()), ctx);
}
@Override
public Statement visitTryCatchStatement(TryCatchStatementContext ctx) {
TryCatchStatement tryCatchStatement =
new TryCatchStatement((Statement) this.visit(ctx.block()),
this.visitFinallyBlock(ctx.finallyBlock()));
if (asBoolean(ctx.resources())) {
this.visitResources(ctx.resources()).forEach(tryCatchStatement::addResource);
}
ctx.catchClause().stream().map(this::visitCatchClause)
.reduce(new LinkedList<CatchStatement>(), (r, e) -> {
r.addAll(e); // merge several LinkedList<CatchStatement> instances into one LinkedList<CatchStatement> instance
return r;
})
.forEach(tryCatchStatement::addCatch);
return this.configureAST(
tryWithResourcesASTTransformation.transform(
this.configureAST(tryCatchStatement, ctx)),
ctx);
}
@Override
public List<ExpressionStatement> visitResources(ResourcesContext ctx) {
return this.visitResourceList(ctx.resourceList());
}
@Override
public List<ExpressionStatement> visitResourceList(ResourceListContext ctx) {
return ctx.resource().stream().map(this::visitResource).collect(Collectors.toList());
}
@Override
public ExpressionStatement visitResource(ResourceContext ctx) {
if (asBoolean(ctx.localVariableDeclaration())) {
List<ExpressionStatement> declarationStatements = this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()).getDeclarationStatements();
if (declarationStatements.size() > 1) {
throw createParsingFailedException("Multi resources can not be declared in one statement", ctx);
}
return declarationStatements.get(0);
} else if (asBoolean(ctx.expression())) {
Expression expression = (Expression) this.visit(ctx.expression());
if (!(expression instanceof BinaryExpression
&& Types.ASSIGN == ((BinaryExpression) expression).getOperation().getType()
&& ((BinaryExpression) expression).getLeftExpression() instanceof VariableExpression)) {
throw createParsingFailedException("Only variable declarations are allowed to declare resource", ctx);
}
BinaryExpression assignmentExpression = (BinaryExpression) expression;
return this.configureAST(
new ExpressionStatement(
this.configureAST(
new DeclarationExpression(
this.configureAST(
new VariableExpression(assignmentExpression.getLeftExpression().getText()),
assignmentExpression.getLeftExpression()
),
assignmentExpression.getOperation(),
assignmentExpression.getRightExpression()
), ctx)
), ctx);
}
throw createParsingFailedException("Unsupported resource declaration: " + ctx.getText(), ctx);
}
/**
* Multi-catch(1..*) clause will be unpacked to several normal catch clauses, so the return type is List
*
* @param ctx the parse tree
* @return
*/
@Override
public List<CatchStatement> visitCatchClause(CatchClauseContext ctx) {
// FIXME Groovy will ignore variableModifier of parameter in the catch clause
// In order to make the new parser behave same with the old one, we do not process variableModifier*
return this.visitCatchType(ctx.catchType()).stream()
.map(e -> this.configureAST(
new CatchStatement(
// FIXME The old parser does not set location info for the parameter of the catch clause.
// we could make it better
//this.configureAST(new Parameter(e, this.visitIdentifier(ctx.identifier())), ctx.Identifier()),
new Parameter(e, this.visitIdentifier(ctx.identifier())),
this.visitBlock(ctx.block())),
ctx))
.collect(Collectors.toList());
}
@Override
public List<ClassNode> visitCatchType(CatchTypeContext ctx) {
if (!asBoolean(ctx)) {
return Collections.singletonList(ClassHelper.OBJECT_TYPE);
}
return ctx.qualifiedClassName().stream()
.map(this::visitQualifiedClassName)
.collect(Collectors.toList());
}
@Override
public Statement visitFinallyBlock(FinallyBlockContext ctx) {
if (!asBoolean(ctx)) {
return EmptyStatement.INSTANCE;
}
return this.configureAST(
this.createBlockStatement((Statement) this.visit(ctx.block())),
ctx);
}
@Override
public SwitchStatement visitSwitchStmtAlt(SwitchStmtAltContext ctx) {
return this.configureAST(this.visitSwitchStatement(ctx.switchStatement()), ctx);
}
public SwitchStatement visitSwitchStatement(SwitchStatementContext ctx) {
List<Statement> statementList =
ctx.switchBlockStatementGroup().stream()
.map(this::visitSwitchBlockStatementGroup)
.reduce(new LinkedList<>(), (r, e) -> {
r.addAll(e);
return r;
});
List<CaseStatement> caseStatementList = new LinkedList<>();
List<Statement> defaultStatementList = new LinkedList<>();
statementList.forEach(e -> {
if (e instanceof CaseStatement) {
caseStatementList.add((CaseStatement) e);
} else if (isTrue(e, IS_SWITCH_DEFAULT)) {
defaultStatementList.add(e);
}
});
int defaultStatementListSize = defaultStatementList.size();
if (defaultStatementListSize > 1) {
throw createParsingFailedException("switch statement should have only one default case, which should appear at last", defaultStatementList.get(0));
}
if (defaultStatementListSize > 0 && last(statementList) instanceof CaseStatement) {
throw createParsingFailedException("default case should appear at last", defaultStatementList.get(0));
}
return this.configureAST(
new SwitchStatement(
this.visitParExpression(ctx.parExpression()),
caseStatementList,
defaultStatementListSize == 0 ? EmptyStatement.INSTANCE : defaultStatementList.get(0)
),
ctx);
}
@Override
@SuppressWarnings({"unchecked"})
public List<Statement> visitSwitchBlockStatementGroup(SwitchBlockStatementGroupContext ctx) {
int labelCnt = ctx.switchLabel().size();
List<Token> firstLabelHolder = new ArrayList<>(1);
return (List<Statement>) ctx.switchLabel().stream()
.map(e -> (Object) this.visitSwitchLabel(e))
.reduce(new ArrayList<Statement>(4), (r, e) -> {
List<Statement> statementList = (List<Statement>) r;
Pair<Token, Expression> pair = (Pair<Token, Expression>) e;
boolean isLast = labelCnt - 1 == statementList.size();
switch (pair.getKey().getType()) {
case CASE: {
if (!asBoolean(statementList)) {
firstLabelHolder.add(pair.getKey());
}
statementList.add(
this.configureAST(
new CaseStatement(
pair.getValue(),
// check whether processing the last label. if yes, block statement should be attached.
isLast ? this.visitBlockStatements(ctx.blockStatements())
: EmptyStatement.INSTANCE
),
firstLabelHolder.get(0)));
break;
}
case DEFAULT: {
BlockStatement blockStatement = this.visitBlockStatements(ctx.blockStatements());
blockStatement.putNodeMetaData(IS_SWITCH_DEFAULT, true);
statementList.add(
// this.configureAST(blockStatement, pair.getKey())
blockStatement
);
break;
}
}
return statementList;
});
}
@Override
public Pair<Token, Expression> visitSwitchLabel(SwitchLabelContext ctx) {
if (asBoolean(ctx.CASE())) {
return new Pair<>(ctx.CASE().getSymbol(), (Expression) this.visit(ctx.expression()));
} else if (asBoolean(ctx.DEFAULT())) {
return new Pair<>(ctx.DEFAULT().getSymbol(), EmptyExpression.INSTANCE);
}
throw createParsingFailedException("Unsupported switch label: " + ctx.getText(), ctx);
}
@Override
public SynchronizedStatement visitSynchronizedStmtAlt(SynchronizedStmtAltContext ctx) {
return this.configureAST(
new SynchronizedStatement(this.visitParExpression(ctx.parExpression()), this.visitBlock(ctx.block())),
ctx);
}
@Override
public ExpressionStatement visitExpressionStmtAlt(ExpressionStmtAltContext ctx) {
return (ExpressionStatement) this.visit(ctx.statementExpression());
}
@Override
public ReturnStatement visitReturnStmtAlt(ReturnStmtAltContext ctx) {
return this.configureAST(new ReturnStatement(asBoolean(ctx.expression())
? (Expression) this.visit(ctx.expression())
: ConstantExpression.EMPTY_EXPRESSION),
ctx);
}
@Override
public ThrowStatement visitThrowStmtAlt(ThrowStmtAltContext ctx) {
return this.configureAST(
new ThrowStatement((Expression) this.visit(ctx.expression())),
ctx);
}
@Override
public Statement visitLabeledStmtAlt(LabeledStmtAltContext ctx) {
Statement statement = (Statement) this.visit(ctx.statement());
statement.addStatementLabel(this.visitIdentifier(ctx.identifier()));
return statement; // this.configureAST(statement, ctx);
}
@Override
public BreakStatement visitBreakStatement(BreakStatementContext ctx) {
String label = asBoolean(ctx.identifier())
? this.visitIdentifier(ctx.identifier())
: null;
return this.configureAST(new BreakStatement(label), ctx);
}
@Override
public BreakStatement visitBreakStmtAlt(BreakStmtAltContext ctx) {
return this.configureAST(this.visitBreakStatement(ctx.breakStatement()), ctx);
}
@Override
public ContinueStatement visitContinueStatement(ContinueStatementContext ctx) {
String label = asBoolean(ctx.identifier())
? this.visitIdentifier(ctx.identifier())
: null;
return this.configureAST(new ContinueStatement(label), ctx);
}
@Override
public ContinueStatement visitContinueStmtAlt(ContinueStmtAltContext ctx) {
return this.configureAST(this.visitContinueStatement(ctx.continueStatement()), ctx);
}
@Override
public ImportNode visitImportStmtAlt(ImportStmtAltContext ctx) {
return this.configureAST(this.visitImportDeclaration(ctx.importDeclaration()), ctx);
}
@Override
public ClassNode visitTypeDeclarationStmtAlt(TypeDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitTypeDeclaration(ctx.typeDeclaration()), ctx);
}
@Override
public Statement visitLocalVariableDeclarationStmtAlt(LocalVariableDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()), ctx);
}
@Override
public MethodNode visitMethodDeclarationStmtAlt(MethodDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitMethodDeclaration(ctx.methodDeclaration()), ctx);
}
// } statement --------------------------------------------------------------------
@Override
public ClassNode visitTypeDeclaration(TypeDeclarationContext ctx) {
if (asBoolean(ctx.classDeclaration())) { // e.g. class A {}
ctx.classDeclaration().putNodeMetaData(TYPE_DECLARATION_MODIFIERS, this.visitClassOrInterfaceModifiersOpt(ctx.classOrInterfaceModifiersOpt()));
return this.configureAST(this.visitClassDeclaration(ctx.classDeclaration()), ctx);
}
throw createParsingFailedException("Unsupported type declaration: " + ctx.getText(), ctx);
}
private void initUsingGenerics(ClassNode classNode) {
if (classNode.isUsingGenerics()) {
return;
}
if (!classNode.isEnum()) {
classNode.setUsingGenerics(classNode.getSuperClass().isUsingGenerics());
}
if (!classNode.isUsingGenerics() && asBoolean((Object) classNode.getInterfaces())) {
for (ClassNode anInterface : classNode.getInterfaces()) {
classNode.setUsingGenerics(classNode.isUsingGenerics() || anInterface.isUsingGenerics());
if (classNode.isUsingGenerics())
break;
}
}
}
@Override
public ClassNode visitClassDeclaration(ClassDeclarationContext ctx) {
String packageName = moduleNode.getPackageName();
packageName = asBoolean((Object) packageName) ? packageName : "";
List<ModifierNode> modifierNodeList = ctx.getNodeMetaData(TYPE_DECLARATION_MODIFIERS);
Objects.requireNonNull(modifierNodeList, "modifierNodeList should not be null");
ModifierManager modifierManager = new ModifierManager(this, modifierNodeList);
int modifiers = modifierManager.getClassModifiersOpValue();
boolean syntheticPublic = ((modifiers & Opcodes.ACC_SYNTHETIC) != 0);
modifiers &= ~Opcodes.ACC_SYNTHETIC;
final ClassNode outerClass = classNodeStack.peek();
ClassNode classNode;
String className = this.visitIdentifier(ctx.identifier());
if (asBoolean(ctx.ENUM())) {
classNode =
EnumHelper.makeEnumNode(
asBoolean(outerClass) ? className : packageName + className,
modifiers, null, outerClass);
} else {
if (asBoolean(outerClass)) {
classNode =
new InnerClassNode(
outerClass,
outerClass.getName() + "$" + className,
modifiers | (outerClass.isInterface() ? Opcodes.ACC_STATIC : 0),
ClassHelper.OBJECT_TYPE);
} else {
classNode =
new ClassNode(
packageName + className,
modifiers,
ClassHelper.OBJECT_TYPE);
}
}
this.configureAST(classNode, ctx);
classNode.putNodeMetaData(CLASS_NAME, className);
classNode.setSyntheticPublic(syntheticPublic);
if (asBoolean(ctx.TRAIT())) {
classNode.addAnnotation(new AnnotationNode(ClassHelper.make(GROOVY_TRANSFORM_TRAIT)));
}
classNode.addAnnotations(modifierManager.getAnnotations());
classNode.setGenericsTypes(this.visitTypeParameters(ctx.typeParameters()));
boolean isInterface = asBoolean(ctx.INTERFACE()) && !asBoolean(ctx.AT());
boolean isInterfaceWithDefaultMethods = false;
// declaring interface with default method
if (isInterface && this.containsDefaultMethods(ctx)) {
isInterfaceWithDefaultMethods = true;
classNode.addAnnotation(new AnnotationNode(ClassHelper.make(GROOVY_TRANSFORM_TRAIT)));
classNode.putNodeMetaData(IS_INTERFACE_WITH_DEFAULT_METHODS, true);
}
if (asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT()) || isInterfaceWithDefaultMethods) { // class OR trait OR interface with default methods
classNode.setSuperClass(this.visitType(ctx.sc));
classNode.setInterfaces(this.visitTypeList(ctx.is));
this.initUsingGenerics(classNode);
} else if (isInterface) { // interface(NOT annotation)
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_INTERFACE | Opcodes.ACC_ABSTRACT);
classNode.setSuperClass(ClassHelper.OBJECT_TYPE);
classNode.setInterfaces(this.visitTypeList(ctx.scs));
this.initUsingGenerics(classNode);
this.hackMixins(classNode);
} else if (asBoolean(ctx.ENUM())) { // enum
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_ENUM | Opcodes.ACC_FINAL);
classNode.setInterfaces(this.visitTypeList(ctx.is));
this.initUsingGenerics(classNode);
} else if (asBoolean(ctx.AT())) { // annotation
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_INTERFACE | Opcodes.ACC_ABSTRACT | Opcodes.ACC_ANNOTATION);
classNode.addInterface(ClassHelper.Annotation_TYPE);
this.hackMixins(classNode);
} else {
throw createParsingFailedException("Unsupported class declaration: " + ctx.getText(), ctx);
}
// we put the class already in output to avoid the most inner classes
// will be used as first class later in the loader. The first class
// there determines what GCL#parseClass for example will return, so we
// have here to ensure it won't be the inner class
if (asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT())) {
classNodeList.add(classNode);
}
int oldAnonymousInnerClassCounter = this.anonymousInnerClassCounter;
classNodeStack.push(classNode);
ctx.classBody().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassBody(ctx.classBody());
classNodeStack.pop();
this.anonymousInnerClassCounter = oldAnonymousInnerClassCounter;
if (!(asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT()))) {
classNodeList.add(classNode);
}
groovydocManager.handle(classNode, ctx);
return classNode;
}
@SuppressWarnings({"unchecked"})
private boolean containsDefaultMethods(ClassDeclarationContext ctx) {
List<MethodDeclarationContext> methodDeclarationContextList =
(List<MethodDeclarationContext>) ctx.classBody().classBodyDeclaration().stream()
.map(ClassBodyDeclarationContext::memberDeclaration)
.filter(Objects::nonNull)
.map(e -> (Object) e.methodDeclaration())
.filter(Objects::nonNull).reduce(new LinkedList<MethodDeclarationContext>(), (r, e) -> {
MethodDeclarationContext methodDeclarationContext = (MethodDeclarationContext) e;
if (createModifierManager(methodDeclarationContext).contains(DEFAULT)) {
((List) r).add(methodDeclarationContext);
}
return r;
});
return !methodDeclarationContextList.isEmpty();
}
@Override
public Void visitClassBody(ClassBodyContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.enumConstants())) {
ctx.enumConstants().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitEnumConstants(ctx.enumConstants());
}
ctx.classBodyDeclaration().forEach(e -> {
e.putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassBodyDeclaration(e);
});
return null;
}
@Override
public List<FieldNode> visitEnumConstants(EnumConstantsContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
return ctx.enumConstant().stream()
.map(e -> {
e.putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
return this.visitEnumConstant(e);
})
.collect(Collectors.toList());
}
@Override
public FieldNode visitEnumConstant(EnumConstantContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
InnerClassNode anonymousInnerClassNode = null;
if (asBoolean(ctx.anonymousInnerClassDeclaration())) {
ctx.anonymousInnerClassDeclaration().putNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS, classNode);
anonymousInnerClassNode = this.visitAnonymousInnerClassDeclaration(ctx.anonymousInnerClassDeclaration());
}
FieldNode enumConstant =
EnumHelper.addEnumConstant(
classNode,
this.visitIdentifier(ctx.identifier()),
createEnumConstantInitExpression(ctx.arguments(), anonymousInnerClassNode));
this.visitAnnotationsOpt(ctx.annotationsOpt()).forEach(enumConstant::addAnnotation);
groovydocManager.handle(enumConstant, ctx);
return this.configureAST(enumConstant, ctx);
}
private Expression createEnumConstantInitExpression(ArgumentsContext ctx, InnerClassNode anonymousInnerClassNode) {
if (!asBoolean(ctx) && !asBoolean(anonymousInnerClassNode)) {
return null;
}
TupleExpression argumentListExpression = (TupleExpression) this.visitArguments(ctx);
List<Expression> expressions = argumentListExpression.getExpressions();
if (expressions.size() == 1) {
Expression expression = expressions.get(0);
if (expression instanceof NamedArgumentListExpression) { // e.g. SOME_ENUM_CONSTANT(a: "1", b: "2")
List<MapEntryExpression> mapEntryExpressionList = ((NamedArgumentListExpression) expression).getMapEntryExpressions();
ListExpression listExpression =
new ListExpression(
mapEntryExpressionList.stream()
.map(e -> (Expression) e)
.collect(Collectors.toList()));
if (asBoolean(anonymousInnerClassNode)) {
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
}
if (mapEntryExpressionList.size() > 1) {
listExpression.setWrapped(true);
}
return this.configureAST(listExpression, ctx);
}
if (!asBoolean(anonymousInnerClassNode)) {
if (expression instanceof ListExpression) {
ListExpression listExpression = new ListExpression();
listExpression.addExpression(expression);
return this.configureAST(listExpression, ctx);
}
return expression;
}
ListExpression listExpression = new ListExpression();
if (expression instanceof ListExpression) {
((ListExpression) expression).getExpressions().forEach(listExpression::addExpression);
} else {
listExpression.addExpression(expression);
}
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
return this.configureAST(listExpression, ctx);
}
ListExpression listExpression = new ListExpression(expressions);
if (asBoolean(anonymousInnerClassNode)) {
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
}
if (asBoolean(ctx)) {
listExpression.setWrapped(true);
}
return asBoolean(ctx)
? this.configureAST(listExpression, ctx)
: this.configureAST(listExpression, anonymousInnerClassNode);
}
@Override
public Void visitClassBodyDeclaration(ClassBodyDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.memberDeclaration())) {
ctx.memberDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitMemberDeclaration(ctx.memberDeclaration());
} else if (asBoolean(ctx.block())) {
Statement statement = this.visitBlock(ctx.block());
if (asBoolean(ctx.STATIC())) { // e.g. static { }
classNode.addStaticInitializerStatements(Collections.singletonList(statement), false);
} else { // e.g. { }
classNode.addObjectInitializerStatements(
this.configureAST(
this.createBlockStatement(statement),
statement));
}
}
return null;
}
@Override
public Void visitMemberDeclaration(MemberDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.methodDeclaration())) {
ctx.methodDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitMethodDeclaration(ctx.methodDeclaration());
} else if (asBoolean(ctx.fieldDeclaration())) {
ctx.fieldDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitFieldDeclaration(ctx.fieldDeclaration());
} else if (asBoolean(ctx.classDeclaration())) {
ctx.classDeclaration().putNodeMetaData(TYPE_DECLARATION_MODIFIERS, this.visitModifiersOpt(ctx.modifiersOpt()));
ctx.classDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassDeclaration(ctx.classDeclaration());
}
return null;
}
@Override
public GenericsType[] visitTypeParameters(TypeParametersContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return ctx.typeParameter().stream()
.map(this::visitTypeParameter)
.toArray(GenericsType[]::new);
}
@Override
public GenericsType visitTypeParameter(TypeParameterContext ctx) {
return this.configureAST(
new GenericsType(
this.configureAST(ClassHelper.make(this.visitClassName(ctx.className())), ctx),
this.visitTypeBound(ctx.typeBound()),
null
),
ctx);
}
@Override
public ClassNode[] visitTypeBound(TypeBoundContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return ctx.type().stream()
.map(this::visitType)
.toArray(ClassNode[]::new);
}
@Override
public Void visitFieldDeclaration(FieldDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
ctx.variableDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitVariableDeclaration(ctx.variableDeclaration());
return null;
}
private ConstructorCallExpression checkThisAndSuperConstructorCall(Statement statement) {
if (!(statement instanceof BlockStatement)) { // method code must be a BlockStatement
return null;
}
BlockStatement blockStatement = (BlockStatement) statement;
List<Statement> statementList = blockStatement.getStatements();
for (int i = 0, n = statementList.size(); i < n; i++) {
Statement s = statementList.get(i);
if (s instanceof ExpressionStatement) {
Expression expression = ((ExpressionStatement) s).getExpression();
if ((expression instanceof ConstructorCallExpression) && 0 != i) {
return (ConstructorCallExpression) expression;
}
}
}
return null;
}
private ModifierManager createModifierManager(MethodDeclarationContext ctx) {
List<ModifierNode> modifierNodeList = Collections.emptyList();
if (asBoolean(ctx.modifiers())) {
modifierNodeList = this.visitModifiers(ctx.modifiers());
} else if (asBoolean(ctx.modifiersOpt())) {
modifierNodeList = this.visitModifiersOpt(ctx.modifiersOpt());
}
return new ModifierManager(this, modifierNodeList);
}
private void validateParametersOfMethodDeclaration(Parameter[] parameters, ClassNode classNode) {
if (!classNode.isInterface()) {
return;
}
Arrays.stream(parameters).forEach(e -> {
if (e.hasInitialExpression()) {
throw createParsingFailedException("Cannot specify default value for method parameter '" + e.getName() + " = " + e.getInitialExpression().getText() + "' inside an interface", e);
}
});
}
@Override
public MethodNode visitMethodDeclaration(MethodDeclarationContext ctx) {
ModifierManager modifierManager = createModifierManager(ctx);
String methodName = this.visitMethodName(ctx.methodName());
ClassNode returnType = this.visitReturnType(ctx.returnType());
Parameter[] parameters = this.visitFormalParameters(ctx.formalParameters());
ClassNode[] exceptions = this.visitQualifiedClassNameList(ctx.qualifiedClassNameList());
anonymousInnerClassesDefinedInMethodStack.push(new LinkedList<>());
Statement code = this.visitMethodBody(ctx.methodBody());
List<InnerClassNode> anonymousInnerClassList = anonymousInnerClassesDefinedInMethodStack.pop();
MethodNode methodNode;
// if classNode is not null, the method declaration is for class declaration
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
if (asBoolean(classNode)) {
validateParametersOfMethodDeclaration(parameters, classNode);
methodNode = createConstructorOrMethodNodeForClass(ctx, modifierManager, methodName, returnType, parameters, exceptions, code, classNode);
} else { // script method declaration
methodNode = createScriptMethodNode(modifierManager, methodName, returnType, parameters, exceptions, code);
}
anonymousInnerClassList.forEach(e -> e.setEnclosingMethod(methodNode));
methodNode.setGenericsTypes(this.visitTypeParameters(ctx.typeParameters()));
methodNode.setSyntheticPublic(
this.isSyntheticPublic(
this.isAnnotationDeclaration(classNode),
classNode instanceof EnumConstantClassNode,
asBoolean(ctx.returnType()),
modifierManager));
if (modifierManager.contains(STATIC)) {
Arrays.stream(methodNode.getParameters()).forEach(e -> e.setInStaticContext(true));
methodNode.getVariableScope().setInStaticContext(true);
}
this.configureAST(methodNode, ctx);
validateMethodDeclaration(ctx, methodNode, modifierManager, classNode);
groovydocManager.handle(methodNode, ctx);
return methodNode;
}
private void validateMethodDeclaration(MethodDeclarationContext ctx, MethodNode methodNode, ModifierManager modifierManager, ClassNode classNode) {
boolean isAbstractMethod = methodNode.isAbstract();
boolean hasMethodBody = asBoolean(methodNode.getCode());
if (9 == ctx.ct) { // script
if (isAbstractMethod || !hasMethodBody) { // method should not be declared abstract in the script
throw createParsingFailedException("You can not define a " + (isAbstractMethod ? "abstract" : "") + " method[" + methodNode.getName() + "] " + (!hasMethodBody ? "without method body" : "") + " in the script. Try " + (isAbstractMethod ? "removing the 'abstract'" : "") + (isAbstractMethod && !hasMethodBody ? " and" : "") + (!hasMethodBody ? " adding a method body" : ""), methodNode);
}
} else {
if (!isAbstractMethod && !hasMethodBody) { // non-abstract method without body in the non-script(e.g. class, enum, trait) is not allowed!
throw createParsingFailedException("You defined a method[" + methodNode.getName() + "] without body. Try adding a method body, or declare it abstract", methodNode);
}
boolean isInterfaceOrAbstractClass = asBoolean(classNode) && classNode.isAbstract() && !classNode.isAnnotationDefinition();
if (isInterfaceOrAbstractClass && !modifierManager.contains(DEFAULT) && isAbstractMethod && hasMethodBody) {
throw createParsingFailedException("You defined an abstract method[" + methodNode.getName() + "] with body. Try removing the method body" + (classNode.isInterface() ? ", or declare it default" : ""), methodNode);
}
}
modifierManager.validate(methodNode);
if (methodNode instanceof ConstructorNode) {
modifierManager.validate((ConstructorNode) methodNode);
}
}
private MethodNode createScriptMethodNode(ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code) {
MethodNode methodNode;
methodNode =
new MethodNode(
methodName,
modifierManager.contains(PRIVATE) ? Opcodes.ACC_PRIVATE : Opcodes.ACC_PUBLIC,
returnType,
parameters,
exceptions,
code);
modifierManager.processMethodNode(methodNode);
return methodNode;
}
private MethodNode createConstructorOrMethodNodeForClass(MethodDeclarationContext ctx, ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode) {
MethodNode methodNode;
String className = classNode.getNodeMetaData(CLASS_NAME);
int modifiers = modifierManager.getClassMemberModifiersOpValue();
if (!asBoolean(ctx.returnType())
&& asBoolean(ctx.methodBody())
&& methodName.equals(className)) { // constructor declaration
methodNode = createConstructorNodeForClass(methodName, parameters, exceptions, code, classNode, modifiers);
} else { // class memeber method declaration
methodNode = createMethodNodeForClass(ctx, modifierManager, methodName, returnType, parameters, exceptions, code, classNode, modifiers);
}
modifierManager.attachAnnotations(methodNode);
return methodNode;
}
private MethodNode createMethodNodeForClass(MethodDeclarationContext ctx, ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode, int modifiers) {
MethodNode methodNode;
if (asBoolean(ctx.elementValue())) { // the code of annotation method
code = this.configureAST(
new ExpressionStatement(
this.visitElementValue(ctx.elementValue())),
ctx.elementValue());
}
modifiers |= !modifierManager.contains(STATIC) && (classNode.isInterface() || (isTrue(classNode, IS_INTERFACE_WITH_DEFAULT_METHODS) && !modifierManager.contains(DEFAULT))) ? Opcodes.ACC_ABSTRACT : 0;
checkWhetherMethodNodeWithSameSignatureExists(classNode, methodName, parameters, ctx);
methodNode = classNode.addMethod(methodName, modifiers, returnType, parameters, exceptions, code);
methodNode.setAnnotationDefault(asBoolean(ctx.elementValue()));
return methodNode;
}
private void checkWhetherMethodNodeWithSameSignatureExists(ClassNode classNode, String methodName, Parameter[] parameters, MethodDeclarationContext ctx) {
MethodNode sameSigMethodNode = classNode.getDeclaredMethod(methodName, parameters);
if (null == sameSigMethodNode) {
return;
}
throw createParsingFailedException("The method " + sameSigMethodNode.getText() + " duplicates another method of the same signature", ctx);
}
private ConstructorNode createConstructorNodeForClass(String methodName, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode, int modifiers) {
ConstructorCallExpression thisOrSuperConstructorCallExpression = this.checkThisAndSuperConstructorCall(code);
if (asBoolean(thisOrSuperConstructorCallExpression)) {
throw createParsingFailedException(thisOrSuperConstructorCallExpression.getText() + " should be the first statement in the constructor[" + methodName + "]", thisOrSuperConstructorCallExpression);
}
return classNode.addConstructor(
modifiers,
parameters,
exceptions,
code);
}
@Override
public String visitMethodName(MethodNameContext ctx) {
if (asBoolean(ctx.identifier())) {
return this.visitIdentifier(ctx.identifier());
}
if (asBoolean(ctx.stringLiteral())) {
return this.visitStringLiteral(ctx.stringLiteral()).getText();
}
throw createParsingFailedException("Unsupported method name: " + ctx.getText(), ctx);
}
@Override
public ClassNode visitReturnType(ReturnTypeContext ctx) {
if (!asBoolean(ctx)) {
return ClassHelper.OBJECT_TYPE;
}
if (asBoolean(ctx.type())) {
return this.visitType(ctx.type());
}
if (asBoolean(ctx.VOID())) {
return ClassHelper.VOID_TYPE;
}
throw createParsingFailedException("Unsupported return type: " + ctx.getText(), ctx);
}
@Override
public Statement visitMethodBody(MethodBodyContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return this.configureAST(this.visitBlock(ctx.block()), ctx);
}
@Override
public DeclarationListStatement visitLocalVariableDeclaration(LocalVariableDeclarationContext ctx) {
return this.configureAST(this.visitVariableDeclaration(ctx.variableDeclaration()), ctx);
}
private ModifierManager createModifierManager(VariableDeclarationContext ctx) {
List<ModifierNode> modifierNodeList = Collections.emptyList();
if (asBoolean(ctx.variableModifiers())) {
modifierNodeList = this.visitVariableModifiers(ctx.variableModifiers());
} else if (asBoolean(ctx.variableModifiersOpt())) {
modifierNodeList = this.visitVariableModifiersOpt(ctx.variableModifiersOpt());
} else if (asBoolean(ctx.modifiers())) {
modifierNodeList = this.visitModifiers(ctx.modifiers());
} else if (asBoolean(ctx.modifiersOpt())) {
modifierNodeList = this.visitModifiersOpt(ctx.modifiersOpt());
}
return new ModifierManager(this, modifierNodeList);
}
private DeclarationListStatement createMultiAssignmentDeclarationListStatement(VariableDeclarationContext ctx, ModifierManager modifierManager) {
if (!modifierManager.contains(DEF)) {
throw createParsingFailedException("keyword def is required to declare tuple, e.g. def (int a, int b) = [1, 2]", ctx);
}
return this.configureAST(
new DeclarationListStatement(
this.configureAST(
modifierManager.attachAnnotations(
new DeclarationExpression(
new ArgumentListExpression(
this.visitTypeNamePairs(ctx.typeNamePairs()).stream()
.peek(e -> modifierManager.processVariableExpression((VariableExpression) e))
.collect(Collectors.toList())
),
this.createGroovyTokenByType(ctx.ASSIGN().getSymbol(), Types.ASSIGN),
this.visitVariableInitializer(ctx.variableInitializer())
)
),
ctx
)
),
ctx
);
}
@Override
public DeclarationListStatement visitVariableDeclaration(VariableDeclarationContext ctx) {
ModifierManager modifierManager = this.createModifierManager(ctx);
if (asBoolean(ctx.typeNamePairs())) { // e.g. def (int a, int b) = [1, 2]
return this.createMultiAssignmentDeclarationListStatement(ctx, modifierManager);
}
ClassNode variableType = this.visitType(ctx.type());
ctx.variableDeclarators().putNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE, variableType);
List<DeclarationExpression> declarationExpressionList = this.visitVariableDeclarators(ctx.variableDeclarators());
// if classNode is not null, the variable declaration is for class declaration. In other words, it is a field declaration
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
if (asBoolean(classNode)) {
return createFieldDeclarationListStatement(ctx, modifierManager, variableType, declarationExpressionList, classNode);
}
declarationExpressionList.forEach(e -> {
VariableExpression variableExpression = (VariableExpression) e.getLeftExpression();
modifierManager.processVariableExpression(variableExpression);
modifierManager.attachAnnotations(e);
});
int size = declarationExpressionList.size();
if (size > 0) {
DeclarationExpression declarationExpression = declarationExpressionList.get(0);
if (1 == size) {
this.configureAST(declarationExpression, ctx);
} else {
// Tweak start of first declaration
declarationExpression.setLineNumber(ctx.getStart().getLine());
declarationExpression.setColumnNumber(ctx.getStart().getCharPositionInLine() + 1);
}
}
return this.configureAST(new DeclarationListStatement(declarationExpressionList), ctx);
}
private DeclarationListStatement createFieldDeclarationListStatement(VariableDeclarationContext ctx, ModifierManager modifierManager, ClassNode variableType, List<DeclarationExpression> declarationExpressionList, ClassNode classNode) {
for (int i = 0, n = declarationExpressionList.size(); i < n; i++) {
DeclarationExpression declarationExpression = declarationExpressionList.get(i);
VariableExpression variableExpression = (VariableExpression) declarationExpression.getLeftExpression();
int modifiers = modifierManager.getClassMemberModifiersOpValue();
Expression initialValue = EmptyExpression.INSTANCE.equals(declarationExpression.getRightExpression()) ? null : declarationExpression.getRightExpression();
Object defaultValue = findDefaultValueByType(variableType);
if (classNode.isInterface()) {
if (!asBoolean(initialValue)) {
initialValue = !asBoolean(defaultValue) ? null : new ConstantExpression(defaultValue);
}
modifiers |= Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC | Opcodes.ACC_FINAL;
}
if (classNode.isInterface() || modifierManager.containsVisibilityModifier()) {
FieldNode fieldNode =
classNode.addField(
variableExpression.getName(),
modifiers,
variableType,
initialValue);
modifierManager.attachAnnotations(fieldNode);
groovydocManager.handle(fieldNode, ctx);
if (0 == i) {
this.configureAST(fieldNode, ctx, initialValue);
} else {
this.configureAST(fieldNode, variableExpression, initialValue);
}
} else {
PropertyNode propertyNode =
classNode.addProperty(
variableExpression.getName(),
modifiers | Opcodes.ACC_PUBLIC,
variableType,
initialValue,
null,
null);
FieldNode fieldNode = propertyNode.getField();
fieldNode.setModifiers(modifiers & ~Opcodes.ACC_PUBLIC | Opcodes.ACC_PRIVATE);
fieldNode.setSynthetic(!classNode.isInterface());
modifierManager.attachAnnotations(fieldNode);
groovydocManager.handle(fieldNode, ctx);
groovydocManager.handle(propertyNode, ctx);
if (0 == i) {
this.configureAST(fieldNode, ctx, initialValue);
this.configureAST(propertyNode, ctx, initialValue);
} else {
this.configureAST(fieldNode, variableExpression, initialValue);
this.configureAST(propertyNode, variableExpression, initialValue);
}
}
}
return null;
}
@Override
public List<Expression> visitTypeNamePairs(TypeNamePairsContext ctx) {
return ctx.typeNamePair().stream().map(this::visitTypeNamePair).collect(Collectors.toList());
}
@Override
public VariableExpression visitTypeNamePair(TypeNamePairContext ctx) {
return this.configureAST(
new VariableExpression(
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName(),
this.visitType(ctx.type())),
ctx);
}
@Override
public List<DeclarationExpression> visitVariableDeclarators(VariableDeclaratorsContext ctx) {
ClassNode variableType = ctx.getNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE);
Objects.requireNonNull(variableType, "variableType should not be null");
return ctx.variableDeclarator().stream()
.map(e -> {
e.putNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE, variableType);
return this.visitVariableDeclarator(e);
// return this.configureAST(this.visitVariableDeclarator(e), ctx);
})
.collect(Collectors.toList());
}
@Override
public DeclarationExpression visitVariableDeclarator(VariableDeclaratorContext ctx) {
ClassNode variableType = ctx.getNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE);
Objects.requireNonNull(variableType, "variableType should not be null");
org.codehaus.groovy.syntax.Token token;
if (asBoolean(ctx.ASSIGN())) {
token = createGroovyTokenByType(ctx.ASSIGN().getSymbol(), Types.ASSIGN);
} else {
token = new org.codehaus.groovy.syntax.Token(Types.ASSIGN, ASSIGN_STR, ctx.start.getLine(), 1);
}
return this.configureAST(
new DeclarationExpression(
this.configureAST(
new VariableExpression(
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName(),
variableType
),
ctx.variableDeclaratorId()),
token,
this.visitVariableInitializer(ctx.variableInitializer())),
ctx);
}
@Override
public Expression visitVariableInitializer(VariableInitializerContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
if (asBoolean(ctx.statementExpression())) {
return this.configureAST(
((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression(),
ctx);
}
if (asBoolean(ctx.standardLambda())) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
throw createParsingFailedException("Unsupported variable initializer: " + ctx.getText(), ctx);
}
@Override
public List<Expression> visitVariableInitializers(VariableInitializersContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return ctx.variableInitializer().stream()
.map(this::visitVariableInitializer)
.collect(Collectors.toList());
}
@Override
public List<Expression> visitArrayInitializer(ArrayInitializerContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.visitVariableInitializers(ctx.variableInitializers());
}
@Override
public Statement visitBlock(BlockContext ctx) {
if (!asBoolean(ctx)) {
return this.createBlockStatement();
}
return this.configureAST(
this.visitBlockStatementsOpt(ctx.blockStatementsOpt()),
ctx);
}
@Override
public ExpressionStatement visitNormalExprAlt(NormalExprAltContext ctx) {
return this.configureAST(new ExpressionStatement((Expression) this.visit(ctx.expression())), ctx);
}
@Override
public ExpressionStatement visitCommandExprAlt(CommandExprAltContext ctx) {
return this.configureAST(new ExpressionStatement(this.visitCommandExpression(ctx.commandExpression())), ctx);
}
@Override
public Expression visitCommandExpression(CommandExpressionContext ctx) {
Expression baseExpr = this.visitPathExpression(ctx.pathExpression());
Expression arguments = this.visitEnhancedArgumentList(ctx.enhancedArgumentList());
MethodCallExpression methodCallExpression;
if (baseExpr instanceof PropertyExpression) { // e.g. obj.a 1, 2
methodCallExpression =
this.configureAST(
this.createMethodCallExpression(
(PropertyExpression) baseExpr, arguments),
arguments);
} else if (baseExpr instanceof MethodCallExpression && !isTrue(baseExpr, IS_INSIDE_PARENTHESES)) { // e.g. m {} a, b OR m(...) a, b
if (asBoolean(arguments)) {
// The error should never be thrown.
throw new GroovyBugError("When baseExpr is a instance of MethodCallExpression, which should follow NO argumentList");
}
methodCallExpression = (MethodCallExpression) baseExpr;
} else if (
!isTrue(baseExpr, IS_INSIDE_PARENTHESES)
&& (baseExpr instanceof VariableExpression /* e.g. m 1, 2 */
|| baseExpr instanceof GStringExpression /* e.g. "$m" 1, 2 */
|| (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_STRING)) /* e.g. "m" 1, 2 */)
) {
methodCallExpression =
this.configureAST(
this.createMethodCallExpression(baseExpr, arguments),
arguments);
} else { // e.g. a[x] b, new A() b, etc.
methodCallExpression =
this.configureAST(
new MethodCallExpression(
baseExpr,
CALL_STR,
arguments
),
arguments
);
methodCallExpression.setImplicitThis(false);
}
if (!asBoolean(ctx.commandArgument())) {
return this.configureAST(methodCallExpression, ctx);
}
return this.configureAST(
(Expression) ctx.commandArgument().stream()
.map(e -> (Object) e)
.reduce(methodCallExpression,
(r, e) -> {
CommandArgumentContext commandArgumentContext = (CommandArgumentContext) e;
commandArgumentContext.putNodeMetaData(CMD_EXPRESSION_BASE_EXPR, r);
return this.visitCommandArgument(commandArgumentContext);
}
),
ctx);
}
@Override
public Expression visitCommandArgument(CommandArgumentContext ctx) {
// e.g. x y a b we call "x y" as the base expression
Expression baseExpr = ctx.getNodeMetaData(CMD_EXPRESSION_BASE_EXPR);
Expression primaryExpr = (Expression) this.visit(ctx.primary());
if (asBoolean(ctx.enhancedArgumentList())) { // e.g. x y a b
if (baseExpr instanceof PropertyExpression) { // the branch should never reach, because a.b.c will be parsed as a path expression, not a method call
throw createParsingFailedException("Unsupported command argument: " + ctx.getText(), ctx);
}
// the following code will process "a b" of "x y a b"
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
this.createConstantExpression(primaryExpr),
this.visitEnhancedArgumentList(ctx.enhancedArgumentList())
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
} else if (asBoolean(ctx.pathElement())) { // e.g. x y a.b
Expression pathExpression =
this.createPathExpression(
this.configureAST(
new PropertyExpression(baseExpr, this.createConstantExpression(primaryExpr)),
primaryExpr
),
ctx.pathElement()
);
return this.configureAST(pathExpression, ctx);
}
// e.g. x y a
return this.configureAST(
new PropertyExpression(
baseExpr,
primaryExpr instanceof VariableExpression
? this.createConstantExpression(primaryExpr)
: primaryExpr
),
primaryExpr
);
}
// expression { --------------------------------------------------------------------
@Override
public ClassNode visitCastParExpression(CastParExpressionContext ctx) {
return this.visitType(ctx.type());
}
@Override
public Expression visitParExpression(ParExpressionContext ctx) {
Expression expression;
if (asBoolean(ctx.statementExpression())) {
expression = ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression();
} else if (asBoolean(ctx.standardLambda())) {
expression = this.visitStandardLambda(ctx.standardLambda());
} else {
throw createParsingFailedException("Unsupported parentheses expression: " + ctx.getText(), ctx);
}
expression.putNodeMetaData(IS_INSIDE_PARENTHESES, true);
Integer insideParenLevel = expression.getNodeMetaData(INSIDE_PARENTHESES_LEVEL);
if (asBoolean((Object) insideParenLevel)) {
insideParenLevel++;
} else {
insideParenLevel = 1;
}
expression.putNodeMetaData(INSIDE_PARENTHESES_LEVEL, insideParenLevel);
return this.configureAST(expression, ctx);
}
@Override
public Expression visitPathExpression(PathExpressionContext ctx) {
return this.configureAST(
this.createPathExpression((Expression) this.visit(ctx.primary()), ctx.pathElement()),
ctx);
}
@Override
public Expression visitPathElement(PathElementContext ctx) {
Expression baseExpr = ctx.getNodeMetaData(PATH_EXPRESSION_BASE_EXPR);
Objects.requireNonNull(baseExpr, "baseExpr is required!");
if (asBoolean(ctx.namePart())) {
Expression namePartExpr = this.visitNamePart(ctx.namePart());
GenericsType[] genericsTypes = this.visitNonWildcardTypeArguments(ctx.nonWildcardTypeArguments());
if (asBoolean(ctx.DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj.@a
return this.configureAST(new AttributeExpression(baseExpr, namePartExpr), ctx);
} else { // e.g. obj.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
return this.configureAST(propertyExpression, ctx);
}
} else if (asBoolean(ctx.SAFE_DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj?.@a
return this.configureAST(new AttributeExpression(baseExpr, namePartExpr, true), ctx);
} else { // e.g. obj?.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr, true);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
return this.configureAST(propertyExpression, ctx);
}
} else if (asBoolean(ctx.METHOD_POINTER())) { // e.g. obj.&m
return this.configureAST(new MethodPointerExpression(baseExpr, namePartExpr), ctx);
} else if (asBoolean(ctx.METHOD_REFERENCE())) { // e.g. obj::m
return this.configureAST(new MethodReferenceExpression(baseExpr, namePartExpr), ctx);
} else if (asBoolean(ctx.SPREAD_DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj*.@a
AttributeExpression attributeExpression = new AttributeExpression(baseExpr, namePartExpr, true);
attributeExpression.setSpreadSafe(true);
return this.configureAST(attributeExpression, ctx);
} else { // e.g. obj*.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr, true);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
propertyExpression.setSpreadSafe(true);
return this.configureAST(propertyExpression, ctx);
}
}
}
if (asBoolean(ctx.indexPropertyArgs())) { // e.g. list[1, 3, 5]
Pair<Token, Expression> pair = this.visitIndexPropertyArgs(ctx.indexPropertyArgs());
return this.configureAST(
new BinaryExpression(baseExpr, createGroovyToken(pair.getKey()), pair.getValue(), asBoolean(ctx.indexPropertyArgs().QUESTION())),
ctx);
}
if (asBoolean(ctx.namedPropertyArgs())) { // this is a special way to new instance, e.g. Person(name: 'Daniel.Sun', location: 'Shanghai')
List<MapEntryExpression> mapEntryExpressionList =
this.visitNamedPropertyArgs(ctx.namedPropertyArgs());
Expression right;
if (mapEntryExpressionList.size() == 1) {
MapEntryExpression mapEntryExpression = mapEntryExpressionList.get(0);
if (mapEntryExpression.getKeyExpression() instanceof SpreadMapExpression) {
right = mapEntryExpression.getKeyExpression();
} else {
right = mapEntryExpression;
}
} else {
ListExpression listExpression =
this.configureAST(
new ListExpression(
mapEntryExpressionList.stream()
.map(
e -> {
if (e.getKeyExpression() instanceof SpreadMapExpression) {
return e.getKeyExpression();
}
return e;
}
)
.collect(Collectors.toList())),
ctx.namedPropertyArgs()
);
listExpression.setWrapped(true);
right = listExpression;
}
return this.configureAST(
new BinaryExpression(baseExpr, createGroovyToken(ctx.namedPropertyArgs().LBRACK().getSymbol()), right),
ctx);
}
if (asBoolean(ctx.arguments())) {
Expression argumentsExpr = this.visitArguments(ctx.arguments());
this.configureAST(argumentsExpr, ctx);
if (isTrue(baseExpr, IS_INSIDE_PARENTHESES)) { // e.g. (obj.x)(), (obj.@x)()
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
CALL_STR,
argumentsExpr
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof AttributeExpression) { // e.g. obj.@a(1, 2)
AttributeExpression attributeExpression = (AttributeExpression) baseExpr;
attributeExpression.setSpreadSafe(false); // whether attributeExpression is spread safe or not, we must reset it as false
MethodCallExpression methodCallExpression =
new MethodCallExpression(
attributeExpression,
CALL_STR,
argumentsExpr
);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof PropertyExpression) { // e.g. obj.a(1, 2)
MethodCallExpression methodCallExpression =
this.createMethodCallExpression((PropertyExpression) baseExpr, argumentsExpr);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof VariableExpression) { // void and primitive type AST node must be an instance of VariableExpression
String baseExprText = baseExpr.getText();
if (VOID_STR.equals(baseExprText)) { // e.g. void()
MethodCallExpression methodCallExpression =
new MethodCallExpression(
this.createConstantExpression(baseExpr),
CALL_STR,
argumentsExpr
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
} else if (PRIMITIVE_TYPE_SET.contains(baseExprText)) { // e.g. int(), long(), float(), etc.
throw createParsingFailedException("Primitive type literal: " + baseExprText + " cannot be used as a method name", ctx);
}
}
if (baseExpr instanceof VariableExpression
|| baseExpr instanceof GStringExpression
|| (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_STRING))) { // e.g. m(), "$m"(), "m"()
String baseExprText = baseExpr.getText();
if (SUPER_STR.equals(baseExprText) || THIS_STR.equals(baseExprText)) { // e.g. this(...), super(...)
// class declaration is not allowed in the closure,
// so if this and super is inside the closure, it will not be constructor call.
// e.g. src/test/org/codehaus/groovy/transform/MapConstructorTransformTest.groovy:
// @MapConstructor(pre={ super(args?.first, args?.last); args = args ?: [:] }, post = { first = first?.toUpperCase() })
if (ctx.isInsideClosure) {
return this.configureAST(
new MethodCallExpression(
baseExpr,
baseExprText,
argumentsExpr
),
ctx);
}
return this.configureAST(
new ConstructorCallExpression(
SUPER_STR.equals(baseExprText)
? ClassNode.SUPER
: ClassNode.THIS,
argumentsExpr
),
ctx);
}
MethodCallExpression methodCallExpression =
this.createMethodCallExpression(baseExpr, argumentsExpr);
return this.configureAST(methodCallExpression, ctx);
}
// e.g. 1(), 1.1(), ((int) 1 / 2)(1, 2), {a, b -> a + b }(1, 2), m()()
MethodCallExpression methodCallExpression =
new MethodCallExpression(baseExpr, CALL_STR, argumentsExpr);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (asBoolean(ctx.closure())) {
ClosureExpression closureExpression = this.visitClosure(ctx.closure());
if (baseExpr instanceof MethodCallExpression) {
MethodCallExpression methodCallExpression = (MethodCallExpression) baseExpr;
Expression argumentsExpression = methodCallExpression.getArguments();
if (argumentsExpression instanceof ArgumentListExpression) { // normal arguments, e.g. 1, 2
ArgumentListExpression argumentListExpression = (ArgumentListExpression) argumentsExpression;
argumentListExpression.getExpressions().add(closureExpression);
return this.configureAST(methodCallExpression, ctx);
}
if (argumentsExpression instanceof TupleExpression) { // named arguments, e.g. x: 1, y: 2
TupleExpression tupleExpression = (TupleExpression) argumentsExpression;
NamedArgumentListExpression namedArgumentListExpression = (NamedArgumentListExpression) tupleExpression.getExpression(0);
if (asBoolean(tupleExpression.getExpressions())) {
methodCallExpression.setArguments(
this.configureAST(
new ArgumentListExpression(
Stream.of(
this.configureAST(
new MapExpression(namedArgumentListExpression.getMapEntryExpressions()),
namedArgumentListExpression
),
closureExpression
).collect(Collectors.toList())
),
tupleExpression
)
);
} else {
// the branch should never reach, because named arguments must not be empty
methodCallExpression.setArguments(
this.configureAST(
new ArgumentListExpression(closureExpression),
tupleExpression));
}
return this.configureAST(methodCallExpression, ctx);
}
}
// e.g. 1 {}, 1.1 {}
if (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_NUMERIC)) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
CALL_STR,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression
)
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof PropertyExpression) { // e.g. obj.m { }
PropertyExpression propertyExpression = (PropertyExpression) baseExpr;
MethodCallExpression methodCallExpression =
this.createMethodCallExpression(
propertyExpression,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression
)
);
return this.configureAST(methodCallExpression, ctx);
}
// e.g. m { return 1; }
MethodCallExpression methodCallExpression =
new MethodCallExpression(
VariableExpression.THIS_EXPRESSION,
(baseExpr instanceof VariableExpression)
? this.createConstantExpression((VariableExpression) baseExpr)
: baseExpr,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression)
);
return this.configureAST(methodCallExpression, ctx);
}
throw createParsingFailedException("Unsupported path element: " + ctx.getText(), ctx);
}
@Override
public GenericsType[] visitNonWildcardTypeArguments(NonWildcardTypeArgumentsContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return Arrays.stream(this.visitTypeList(ctx.typeList()))
.map(this::createGenericsType)
.toArray(GenericsType[]::new);
}
@Override
public ClassNode[] visitTypeList(TypeListContext ctx) {
if (!asBoolean(ctx)) {
return new ClassNode[0];
}
return ctx.type().stream()
.map(this::visitType)
.toArray(ClassNode[]::new);
}
@Override
public Expression visitArguments(ArgumentsContext ctx) {
if (!asBoolean(ctx) || !asBoolean(ctx.enhancedArgumentList())) {
return new ArgumentListExpression();
}
return this.configureAST(this.visitEnhancedArgumentList(ctx.enhancedArgumentList()), ctx);
}
@Override
public Expression visitEnhancedArgumentList(EnhancedArgumentListContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
List<Expression> expressionList = new LinkedList<>();
List<MapEntryExpression> mapEntryExpressionList = new LinkedList<>();
ctx.enhancedArgumentListElement().stream()
.map(this::visitEnhancedArgumentListElement)
.forEach(e -> {
if (e instanceof MapEntryExpression) {
mapEntryExpressionList.add((MapEntryExpression) e);
} else {
expressionList.add(e);
}
});
if (!asBoolean(mapEntryExpressionList)) { // e.g. arguments like 1, 2 OR someArg, e -> e
return this.configureAST(
new ArgumentListExpression(expressionList),
ctx);
}
if (!asBoolean(expressionList)) { // e.g. arguments like x: 1, y: 2
return this.configureAST(
new TupleExpression(
this.configureAST(
new NamedArgumentListExpression(mapEntryExpressionList),
ctx)),
ctx);
}
if (asBoolean(mapEntryExpressionList) && asBoolean(expressionList)) { // e.g. arguments like x: 1, 'a', y: 2, 'b', z: 3
ArgumentListExpression argumentListExpression = new ArgumentListExpression(expressionList);
argumentListExpression.getExpressions().add(0, new MapExpression(mapEntryExpressionList)); // TODO: confirm BUG OR NOT? All map entries will be put at first, which is not friendly to Groovy developers
return this.configureAST(argumentListExpression, ctx);
}
throw createParsingFailedException("Unsupported argument list: " + ctx.getText(), ctx);
}
@Override
public Expression visitEnhancedArgumentListElement(EnhancedArgumentListElementContext ctx) {
if (asBoolean(ctx.expressionListElement())) {
return this.configureAST(this.visitExpressionListElement(ctx.expressionListElement()), ctx);
}
if (asBoolean(ctx.standardLambda())) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
if (asBoolean(ctx.mapEntry())) {
return this.configureAST(this.visitMapEntry(ctx.mapEntry()), ctx);
}
throw createParsingFailedException("Unsupported enhanced argument list element: " + ctx.getText(), ctx);
}
@Override
public ConstantExpression visitStringLiteral(StringLiteralContext ctx) {
String text = ctx.StringLiteral().getText();
int slashyType = text.startsWith("/") ? StringUtils.SLASHY :
text.startsWith("$/") ? StringUtils.DOLLAR_SLASHY : StringUtils.NONE_SLASHY;
if (text.startsWith("'''") || text.startsWith("\"\"\"")) {
text = StringUtils.removeCR(text); // remove CR in the multiline string
text = text.length() == 6 ? "" : text.substring(3, text.length() - 3);
} else if (text.startsWith("'") || text.startsWith("/") || text.startsWith("\"")) {
if (text.startsWith("/")) { // the slashy string can span rows, so we have to remove CR for it
text = StringUtils.removeCR(text); // remove CR in the multiline string
}
text = text.length() == 2 ? "" : text.substring(1, text.length() - 1);
} else if (text.startsWith("$/")) {
text = StringUtils.removeCR(text);
text = text.length() == 4 ? "" : text.substring(2, text.length() - 2);
}
//handle escapes.
text = StringUtils.replaceEscapes(text, slashyType);
ConstantExpression constantExpression = new ConstantExpression(text, true);
constantExpression.putNodeMetaData(IS_STRING, true);
return this.configureAST(constantExpression, ctx);
}
@Override
public Pair<Token, Expression> visitIndexPropertyArgs(IndexPropertyArgsContext ctx) {
List<Expression> expressionList = this.visitExpressionList(ctx.expressionList());
if (expressionList.size() == 1) {
Expression expr = expressionList.get(0);
Expression indexExpr;
if (expr instanceof SpreadExpression) { // e.g. a[*[1, 2]]
ListExpression listExpression = new ListExpression(expressionList);
listExpression.setWrapped(false);
indexExpr = listExpression;
} else { // e.g. a[1]
indexExpr = expr;
}
return new Pair<>(ctx.LBRACK().getSymbol(), indexExpr);
}
// e.g. a[1, 2]
ListExpression listExpression = new ListExpression(expressionList);
listExpression.setWrapped(true);
return new Pair<>(ctx.LBRACK().getSymbol(), this.configureAST(listExpression, ctx));
}
@Override
public List<MapEntryExpression> visitNamedPropertyArgs(NamedPropertyArgsContext ctx) {
return this.visitMapEntryList(ctx.mapEntryList());
}
@Override
public Expression visitNamePart(NamePartContext ctx) {
if (asBoolean(ctx.identifier())) {
return this.configureAST(new ConstantExpression(this.visitIdentifier(ctx.identifier())), ctx);
} else if (asBoolean(ctx.stringLiteral())) {
return this.configureAST(this.visitStringLiteral(ctx.stringLiteral()), ctx);
} else if (asBoolean(ctx.dynamicMemberName())) {
return this.configureAST(this.visitDynamicMemberName(ctx.dynamicMemberName()), ctx);
} else if (asBoolean(ctx.keywords())) {
return this.configureAST(new ConstantExpression(ctx.keywords().getText()), ctx);
}
throw createParsingFailedException("Unsupported name part: " + ctx.getText(), ctx);
}
@Override
public Expression visitDynamicMemberName(DynamicMemberNameContext ctx) {
if (asBoolean(ctx.parExpression())) {
return this.configureAST(this.visitParExpression(ctx.parExpression()), ctx);
} else if (asBoolean(ctx.gstring())) {
return this.configureAST(this.visitGstring(ctx.gstring()), ctx);
}
throw createParsingFailedException("Unsupported dynamic member name: " + ctx.getText(), ctx);
}
@Override
public Expression visitPostfixExpression(PostfixExpressionContext ctx) {
Expression pathExpr = this.visitPathExpression(ctx.pathExpression());
if (asBoolean(ctx.op)) {
PostfixExpression postfixExpression = new PostfixExpression(pathExpr, createGroovyToken(ctx.op));
if (ctx.isInsideAssert) {
// powerassert requires different column for values, so we have to copy the location of op
return this.configureAST(postfixExpression, ctx.op);
} else {
return this.configureAST(postfixExpression, ctx);
}
}
return this.configureAST(pathExpr, ctx);
}
@Override
public Expression visitPostfixExprAlt(PostfixExprAltContext ctx) {
return this.visitPostfixExpression(ctx.postfixExpression());
}
@Override
public Expression visitUnaryNotExprAlt(UnaryNotExprAltContext ctx) {
if (asBoolean(ctx.NOT())) {
return this.configureAST(
new NotExpression((Expression) this.visit(ctx.expression())),
ctx);
}
if (asBoolean(ctx.BITNOT())) {
return this.configureAST(
new BitwiseNegationExpression((Expression) this.visit(ctx.expression())),
ctx);
}
throw createParsingFailedException("Unsupported unary expression: " + ctx.getText(), ctx);
}
@Override
public CastExpression visitCastExprAlt(CastExprAltContext ctx) {
return this.configureAST(
new CastExpression(
this.visitCastParExpression(ctx.castParExpression()),
(Expression) this.visit(ctx.expression())
),
ctx
);
}
@Override
public BinaryExpression visitPowerExprAlt(PowerExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitUnaryAddExprAlt(UnaryAddExprAltContext ctx) {
ExpressionContext expressionCtx = ctx.expression();
Expression expression = (Expression) this.visit(expressionCtx);
Boolean insidePar = isTrue(expression, IS_INSIDE_PARENTHESES);
switch (ctx.op.getType()) {
case ADD: {
if (expression instanceof ConstantExpression && !insidePar) {
return this.configureAST(expression, ctx);
}
return this.configureAST(new UnaryPlusExpression(expression), ctx);
}
case SUB: {
if (expression instanceof ConstantExpression && !insidePar) {
ConstantExpression constantExpression = (ConstantExpression) expression;
String integerLiteralText = constantExpression.getNodeMetaData(INTEGER_LITERAL_TEXT);
if (asBoolean((Object) integerLiteralText)) {
return this.configureAST(new ConstantExpression(Numbers.parseInteger(null, SUB_STR + integerLiteralText)), ctx);
}
String floatingPointLiteralText = constantExpression.getNodeMetaData(FLOATING_POINT_LITERAL_TEXT);
if (asBoolean((Object) floatingPointLiteralText)) {
return this.configureAST(new ConstantExpression(Numbers.parseDecimal(SUB_STR + floatingPointLiteralText)), ctx);
}
throw new GroovyBugError("Failed to find the original number literal text: " + constantExpression.getText());
}
return this.configureAST(new UnaryMinusExpression(expression), ctx);
}
case INC:
case DEC:
return this.configureAST(new PrefixExpression(this.createGroovyToken(ctx.op), expression), ctx);
default:
throw createParsingFailedException("Unsupported unary operation: " + ctx.getText(), ctx);
}
}
@Override
public BinaryExpression visitMultiplicativeExprAlt(MultiplicativeExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitAdditiveExprAlt(AdditiveExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitShiftExprAlt(ShiftExprAltContext ctx) {
Expression left = (Expression) this.visit(ctx.left);
Expression right = (Expression) this.visit(ctx.right);
if (asBoolean(ctx.rangeOp)) {
return this.configureAST(new RangeExpression(left, right, !ctx.rangeOp.getText().endsWith("<")), ctx);
}
org.codehaus.groovy.syntax.Token op = null;
if (asBoolean(ctx.dlOp)) {
op = this.createGroovyToken(ctx.dlOp, 2);
} else if (asBoolean(ctx.dgOp)) {
op = this.createGroovyToken(ctx.dgOp, 2);
} else if (asBoolean(ctx.tgOp)) {
op = this.createGroovyToken(ctx.tgOp, 3);
} else {
throw createParsingFailedException("Unsupported shift expression: " + ctx.getText(), ctx);
}
return this.configureAST(
new BinaryExpression(left, op, right),
ctx);
}
@Override
public Expression visitRelationalExprAlt(RelationalExprAltContext ctx) {
switch (ctx.op.getType()) {
case AS:
return this.configureAST(
CastExpression.asExpression(this.visitType(ctx.type()), (Expression) this.visit(ctx.left)),
ctx);
case INSTANCEOF:
case NOT_INSTANCEOF:
ctx.type().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, true);
return this.configureAST(
new BinaryExpression((Expression) this.visit(ctx.left),
this.createGroovyToken(ctx.op),
this.configureAST(new ClassExpression(this.visitType(ctx.type())), ctx.type())),
ctx);
case LE:
case GE:
case GT:
case LT:
case IN:
case NOT_IN:
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
default:
throw createParsingFailedException("Unsupported relational expression: " + ctx.getText(), ctx);
}
}
@Override
public Expression visitEqualityExprAlt(EqualityExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitRegexExprAlt(RegexExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitAndExprAlt(AndExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitExclusiveOrExprAlt(ExclusiveOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitInclusiveOrExprAlt(InclusiveOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitLogicalAndExprAlt(LogicalAndExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitLogicalOrExprAlt(LogicalOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitConditionalExprAlt(ConditionalExprAltContext ctx) {
if (asBoolean(ctx.ELVIS())) { // e.g. a == 6 ?: 0
return this.configureAST(
new ElvisOperatorExpression((Expression) this.visit(ctx.con), (Expression) this.visit(ctx.fb)),
ctx);
}
return this.configureAST(
new TernaryExpression(
this.configureAST(new BooleanExpression((Expression) this.visit(ctx.con)),
ctx.con),
(Expression) this.visit(ctx.tb),
(Expression) this.visit(ctx.fb)),
ctx);
}
@Override
public BinaryExpression visitMultipleAssignmentExprAlt(MultipleAssignmentExprAltContext ctx) {
return this.configureAST(
new BinaryExpression(
this.visitVariableNames(ctx.left),
this.createGroovyToken(ctx.op),
((ExpressionStatement) this.visit(ctx.right)).getExpression()),
ctx);
}
@Override
public BinaryExpression visitAssignmentExprAlt(AssignmentExprAltContext ctx) {
Expression leftExpr = (Expression) this.visit(ctx.left);
if (leftExpr instanceof VariableExpression
&& isTrue(leftExpr, IS_INSIDE_PARENTHESES)) { // it is a special multiple assignment whose variable count is only one, e.g. (a) = [1]
if ((Integer) leftExpr.getNodeMetaData(INSIDE_PARENTHESES_LEVEL) > 1) {
throw createParsingFailedException("Nested parenthesis is not allowed in multiple assignment, e.g. ((a)) = b", ctx);
}
return this.configureAST(
new BinaryExpression(
this.configureAST(new TupleExpression(leftExpr), ctx.left),
this.createGroovyToken(ctx.op),
asBoolean(ctx.statementExpression())
? ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression()
: this.visitStandardLambda(ctx.standardLambda())),
ctx);
}
// the LHS expression should be a variable which is not inside any parentheses
if (
!(
(leftExpr instanceof VariableExpression
// && !(THIS_STR.equals(leftExpr.getText()) || SUPER_STR.equals(leftExpr.getText())) // commented, e.g. this = value // this will be transformed to $this
&& !isTrue(leftExpr, IS_INSIDE_PARENTHESES)) // e.g. p = 123
|| leftExpr instanceof PropertyExpression // e.g. obj.p = 123
|| (leftExpr instanceof BinaryExpression
// && !(((BinaryExpression) leftExpr).getRightExpression() instanceof ListExpression) // commented, e.g. list[1, 2] = [11, 12]
&& Types.LEFT_SQUARE_BRACKET == ((BinaryExpression) leftExpr).getOperation().getType()) // e.g. map[a] = 123 OR map['a'] = 123 OR map["$a"] = 123
)
) {
throw createParsingFailedException("The LHS of an assignment should be a variable or a field accessing expression", ctx);
}
return this.configureAST(
new BinaryExpression(
leftExpr,
this.createGroovyToken(ctx.op),
asBoolean(ctx.statementExpression())
? ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression()
: this.visitStandardLambda(ctx.standardLambda())),
ctx);
}
// } expression --------------------------------------------------------------------
// primary { --------------------------------------------------------------------
@Override
public VariableExpression visitIdentifierPrmrAlt(IdentifierPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(this.visitIdentifier(ctx.identifier())), ctx);
}
@Override
public ConstantExpression visitLiteralPrmrAlt(LiteralPrmrAltContext ctx) {
return this.configureAST((ConstantExpression) this.visit(ctx.literal()), ctx);
}
@Override
public GStringExpression visitGstringPrmrAlt(GstringPrmrAltContext ctx) {
return this.configureAST((GStringExpression) this.visit(ctx.gstring()), ctx);
}
@Override
public Expression visitNewPrmrAlt(NewPrmrAltContext ctx) {
return this.configureAST(this.visitCreator(ctx.creator()), ctx);
}
@Override
public VariableExpression visitThisPrmrAlt(ThisPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(ctx.THIS().getText()), ctx);
}
@Override
public VariableExpression visitSuperPrmrAlt(SuperPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(ctx.SUPER().getText()), ctx);
}
@Override
public Expression visitParenPrmrAlt(ParenPrmrAltContext ctx) {
return this.configureAST(this.visitParExpression(ctx.parExpression()), ctx);
}
@Override
public ClosureExpression visitClosurePrmrAlt(ClosurePrmrAltContext ctx) {
return this.configureAST(this.visitClosure(ctx.closure()), ctx);
}
@Override
public ClosureExpression visitLambdaPrmrAlt(LambdaPrmrAltContext ctx) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
@Override
public ListExpression visitListPrmrAlt(ListPrmrAltContext ctx) {
return this.configureAST(
this.visitList(ctx.list()),
ctx);
}
@Override
public MapExpression visitMapPrmrAlt(MapPrmrAltContext ctx) {
return this.configureAST(this.visitMap(ctx.map()), ctx);
}
@Override
public VariableExpression visitTypePrmrAlt(TypePrmrAltContext ctx) {
return this.configureAST(
this.visitBuiltInType(ctx.builtInType()),
ctx);
}
// } primary --------------------------------------------------------------------
@Override
public Expression visitCreator(CreatorContext ctx) {
ClassNode classNode = this.visitCreatedName(ctx.createdName());
Expression arguments = this.visitArguments(ctx.arguments());
if (asBoolean(ctx.arguments())) { // create instance of class
if (asBoolean(ctx.anonymousInnerClassDeclaration())) {
ctx.anonymousInnerClassDeclaration().putNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS, classNode);
InnerClassNode anonymousInnerClassNode = this.visitAnonymousInnerClassDeclaration(ctx.anonymousInnerClassDeclaration());
List<InnerClassNode> anonymousInnerClassList = anonymousInnerClassesDefinedInMethodStack.peek();
if (asBoolean((Object) anonymousInnerClassList)) { // if the anonymous class is created in a script, no anonymousInnerClassList is available.
anonymousInnerClassList.add(anonymousInnerClassNode);
}
ConstructorCallExpression constructorCallExpression = new ConstructorCallExpression(anonymousInnerClassNode, arguments);
constructorCallExpression.setUsingAnonymousInnerClass(true);
return this.configureAST(constructorCallExpression, ctx);
}
return this.configureAST(
new ConstructorCallExpression(classNode, arguments),
ctx);
}
if (asBoolean(ctx.LBRACK())) { // create array
if (asBoolean(ctx.arrayInitializer())) {
ClassNode arrayType = classNode;
for (int i = 0, n = ctx.b.size() - 1; i < n; i++) {
arrayType = arrayType.makeArray();
}
return this.configureAST(
new ArrayExpression(
arrayType,
this.visitArrayInitializer(ctx.arrayInitializer())),
ctx);
} else {
Expression[] empties;
if (asBoolean(ctx.b)) {
empties = new Expression[ctx.b.size()];
Arrays.setAll(empties, i -> ConstantExpression.EMPTY_EXPRESSION);
} else {
empties = new Expression[0];
}
return this.configureAST(
new ArrayExpression(
classNode,
null,
Stream.concat(
ctx.expression().stream()
.map(e -> (Expression) this.visit(e)),
Arrays.stream(empties)
).collect(Collectors.toList())),
ctx);
}
}
throw createParsingFailedException("Unsupported creator: " + ctx.getText(), ctx);
}
private String genAnonymousClassName(String outerClassName) {
return outerClassName + "$" + this.anonymousInnerClassCounter++;
}
@Override
public InnerClassNode visitAnonymousInnerClassDeclaration(AnonymousInnerClassDeclarationContext ctx) {
ClassNode superClass = ctx.getNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS);
Objects.requireNonNull(superClass, "superClass should not be null");
InnerClassNode anonymousInnerClass;
ClassNode outerClass = this.classNodeStack.peek();
outerClass = asBoolean(outerClass) ? outerClass : moduleNode.getScriptClassDummy();
String fullName = this.genAnonymousClassName(outerClass.getName());
if (1 == ctx.t) { // anonymous enum
anonymousInnerClass = new EnumConstantClassNode(outerClass, fullName, superClass.getModifiers() | Opcodes.ACC_FINAL, superClass.getPlainNodeReference());
// and remove the final modifier from classNode to allow the sub class
superClass.setModifiers(superClass.getModifiers() & ~Opcodes.ACC_FINAL);
} else { // anonymous inner class
anonymousInnerClass = new InnerClassNode(outerClass, fullName, Opcodes.ACC_PUBLIC, superClass);
}
anonymousInnerClass.setUsingGenerics(false);
anonymousInnerClass.setAnonymous(true);
this.configureAST(anonymousInnerClass, ctx);
classNodeStack.push(anonymousInnerClass);
ctx.classBody().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, anonymousInnerClass);
this.visitClassBody(ctx.classBody());
classNodeStack.pop();
classNodeList.add(anonymousInnerClass);
return anonymousInnerClass;
}
@Override
public ClassNode visitCreatedName(CreatedNameContext ctx) {
if (asBoolean(ctx.qualifiedClassName())) {
ClassNode classNode = this.visitQualifiedClassName(ctx.qualifiedClassName());
if (asBoolean(ctx.typeArgumentsOrDiamond())) {
classNode.setGenericsTypes(
this.visitTypeArgumentsOrDiamond(ctx.typeArgumentsOrDiamond()));
}
return this.configureAST(classNode, ctx);
}
if (asBoolean(ctx.primitiveType())) {
return this.configureAST(
this.visitPrimitiveType(ctx.primitiveType()),
ctx);
}
throw createParsingFailedException("Unsupported created name: " + ctx.getText(), ctx);
}
@Override
public MapExpression visitMap(MapContext ctx) {
return this.configureAST(
new MapExpression(this.visitMapEntryList(ctx.mapEntryList())),
ctx);
}
@Override
public List<MapEntryExpression> visitMapEntryList(MapEntryListContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.createMapEntryList(ctx.mapEntry());
}
private List<MapEntryExpression> createMapEntryList(List<? extends MapEntryContext> mapEntryContextList) {
if (!asBoolean(mapEntryContextList)) {
return Collections.emptyList();
}
return mapEntryContextList.stream()
.map(this::visitMapEntry)
.collect(Collectors.toList());
}
@Override
public MapEntryExpression visitMapEntry(MapEntryContext ctx) {
Expression keyExpr;
Expression valueExpr = (Expression) this.visit(ctx.expression());
if (asBoolean(ctx.MUL())) {
keyExpr = this.configureAST(new SpreadMapExpression(valueExpr), ctx);
} else if (asBoolean(ctx.mapEntryLabel())) {
keyExpr = this.visitMapEntryLabel(ctx.mapEntryLabel());
} else {
throw createParsingFailedException("Unsupported map entry: " + ctx.getText(), ctx);
}
return this.configureAST(
new MapEntryExpression(keyExpr, valueExpr),
ctx);
}
@Override
public Expression visitMapEntryLabel(MapEntryLabelContext ctx) {
if (asBoolean(ctx.keywords())) {
return this.configureAST(this.visitKeywords(ctx.keywords()), ctx);
} else if (asBoolean(ctx.primary())) {
Expression expression = (Expression) this.visit(ctx.primary());
// if the key is variable and not inside parentheses, convert it to a constant, e.g. [a:1, b:2]
if (expression instanceof VariableExpression && !isTrue(expression, IS_INSIDE_PARENTHESES)) {
expression =
this.configureAST(
new ConstantExpression(((VariableExpression) expression).getName()),
expression);
}
return this.configureAST(expression, ctx);
}
throw createParsingFailedException("Unsupported map entry label: " + ctx.getText(), ctx);
}
@Override
public ConstantExpression visitKeywords(KeywordsContext ctx) {
return this.configureAST(new ConstantExpression(ctx.getText()), ctx);
}
/*
@Override
public VariableExpression visitIdentifier(IdentifierContext ctx) {
return this.configureAST(new VariableExpression(ctx.getText()), ctx);
}
*/
@Override
public VariableExpression visitBuiltInType(BuiltInTypeContext ctx) {
String text;
if (asBoolean(ctx.VOID())) {
text = ctx.VOID().getText();
} else if (asBoolean(ctx.BuiltInPrimitiveType())) {
text = ctx.BuiltInPrimitiveType().getText();
} else {
throw createParsingFailedException("Unsupported built-in type: " + ctx, ctx);
}
return this.configureAST(new VariableExpression(text), ctx);
}
@Override
public ListExpression visitList(ListContext ctx) {
return this.configureAST(
new ListExpression(
this.visitExpressionList(ctx.expressionList())),
ctx);
}
@Override
public List<Expression> visitExpressionList(ExpressionListContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.createExpressionList(ctx.expressionListElement());
}
private List<Expression> createExpressionList(List<? extends ExpressionListElementContext> expressionListElementContextList) {
if (!asBoolean(expressionListElementContextList)) {
return Collections.emptyList();
}
return expressionListElementContextList.stream()
.map(this::visitExpressionListElement)
.collect(Collectors.toList());
}
@Override
public Expression visitExpressionListElement(ExpressionListElementContext ctx) {
Expression expression = (Expression) this.visit(ctx.expression());
if (asBoolean(ctx.MUL())) {
return this.configureAST(new SpreadExpression(expression), ctx);
}
return this.configureAST(expression, ctx);
}
// literal { --------------------------------------------------------------------
@Override
public ConstantExpression visitIntegerLiteralAlt(IntegerLiteralAltContext ctx) {
String text = ctx.IntegerLiteral().getText();
ConstantExpression constantExpression = new ConstantExpression(Numbers.parseInteger(null, text), !text.startsWith(SUB_STR));
constantExpression.putNodeMetaData(IS_NUMERIC, true);
constantExpression.putNodeMetaData(INTEGER_LITERAL_TEXT, text);
return this.configureAST(constantExpression, ctx);
}
@Override
public ConstantExpression visitFloatingPointLiteralAlt(FloatingPointLiteralAltContext ctx) {
String text = ctx.FloatingPointLiteral().getText();
ConstantExpression constantExpression = new ConstantExpression(Numbers.parseDecimal(text), !text.startsWith(SUB_STR));
constantExpression.putNodeMetaData(IS_NUMERIC, true);
constantExpression.putNodeMetaData(FLOATING_POINT_LITERAL_TEXT, text);
return this.configureAST(constantExpression, ctx);
}
@Override
public ConstantExpression visitStringLiteralAlt(StringLiteralAltContext ctx) {
return this.configureAST(
this.visitStringLiteral(ctx.stringLiteral()),
ctx);
}
@Override
public ConstantExpression visitBooleanLiteralAlt(BooleanLiteralAltContext ctx) {
return this.configureAST(new ConstantExpression("true".equals(ctx.BooleanLiteral().getText()), true), ctx);
}
@Override
public ConstantExpression visitNullLiteralAlt(NullLiteralAltContext ctx) {
return this.configureAST(new ConstantExpression(null), ctx);
}
// } literal --------------------------------------------------------------------
// gstring { --------------------------------------------------------------------
@Override
public GStringExpression visitGstring(GstringContext ctx) {
List<ConstantExpression> strings = new LinkedList<>();
String begin = ctx.GStringBegin().getText();
final int slashyType = begin.startsWith("/")
? StringUtils.SLASHY
: begin.startsWith("$/") ? StringUtils.DOLLAR_SLASHY : StringUtils.NONE_SLASHY;
{
String it = begin;
if (it.startsWith("\"\"\"")) {
it = StringUtils.removeCR(it);
it = it.substring(2); // translate leading """ to "
} else if (it.startsWith("$/")) {
it = StringUtils.removeCR(it);
it = "\"" + it.substring(2); // translate leading $/ to "
} else if (it.startsWith("/")) {
it = StringUtils.removeCR(it);
}
it = StringUtils.replaceEscapes(it, slashyType);
it = (it.length() == 2)
? ""
: StringGroovyMethods.getAt(it, new IntRange(true, 1, -2));
strings.add(this.configureAST(new ConstantExpression(it), ctx.GStringBegin()));
}
List<ConstantExpression> partStrings =
ctx.GStringPart().stream()
.map(e -> {
String it = e.getText();
it = StringUtils.removeCR(it);
it = StringUtils.replaceEscapes(it, slashyType);
it = it.length() == 1 ? "" : StringGroovyMethods.getAt(it, new IntRange(true, 0, -2));
return this.configureAST(new ConstantExpression(it), e);
}).collect(Collectors.toList());
strings.addAll(partStrings);
{
String it = ctx.GStringEnd().getText();
if (it.endsWith("\"\"\"")) {
it = StringUtils.removeCR(it);
it = StringGroovyMethods.getAt(it, new IntRange(true, 0, -3)); // translate tailing """ to "
} else if (it.endsWith("/$")) {
it = StringUtils.removeCR(it);
it = StringGroovyMethods.getAt(it, new IntRange(false, 0, -2)) + "\""; // translate tailing /$ to "
} else if (it.endsWith("/")) {
it = StringUtils.removeCR(it);
}
it = StringUtils.replaceEscapes(it, slashyType);
it = (it.length() == 1)
? ""
: StringGroovyMethods.getAt(it, new IntRange(true, 0, -2));
strings.add(this.configureAST(new ConstantExpression(it), ctx.GStringEnd()));
}
List<Expression> values = ctx.gstringValue().stream()
.map(e -> {
Expression expression = this.visitGstringValue(e);
if (expression instanceof ClosureExpression && !asBoolean(e.closure().ARROW())) {
List<Statement> statementList = ((BlockStatement) ((ClosureExpression) expression).getCode()).getStatements();
if (statementList.stream().allMatch(x -> !asBoolean(x))) {
return this.configureAST(new ConstantExpression(null), e);
}
return this.configureAST(new MethodCallExpression(expression, CALL_STR, new ArgumentListExpression()), e);
}
return expression;
})
.collect(Collectors.toList());
StringBuilder verbatimText = new StringBuilder(ctx.getText().length());
for (int i = 0, n = strings.size(), s = values.size(); i < n; i++) {
verbatimText.append(strings.get(i).getValue());
if (i == s) {
continue;
}
Expression value = values.get(i);
if (!asBoolean(value)) {
continue;
}
verbatimText.append(DOLLAR_STR);
verbatimText.append(value.getText());
}
return this.configureAST(new GStringExpression(verbatimText.toString(), strings, values), ctx);
}
@Override
public Expression visitGstringValue(GstringValueContext ctx) {
if (asBoolean(ctx.gstringPath())) {
return this.configureAST(this.visitGstringPath(ctx.gstringPath()), ctx);
}
if (asBoolean(ctx.LBRACE())) {
if (asBoolean(ctx.statementExpression())) {
return this.configureAST(((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression(), ctx.statementExpression());
} else { // e.g. "${}"
return this.configureAST(new ConstantExpression(null), ctx);
}
}
if (asBoolean(ctx.closure())) {
return this.configureAST(this.visitClosure(ctx.closure()), ctx);
}
throw createParsingFailedException("Unsupported gstring value: " + ctx.getText(), ctx);
}
@Override
public Expression visitGstringPath(GstringPathContext ctx) {
VariableExpression variableExpression = new VariableExpression(this.visitIdentifier(ctx.identifier()));
if (asBoolean(ctx.GStringPathPart())) {
Expression propertyExpression = ctx.GStringPathPart().stream()
.map(e -> this.configureAST((Expression) new ConstantExpression(e.getText().substring(1)), e))
.reduce(this.configureAST(variableExpression, ctx.identifier()), (r, e) -> this.configureAST(new PropertyExpression(r, e), e));
return this.configureAST(propertyExpression, ctx);
}
return this.configureAST(variableExpression, ctx);
}
// } gstring --------------------------------------------------------------------
@Override
public LambdaExpression visitStandardLambda(StandardLambdaContext ctx) {
return this.configureAST(this.createLambda(ctx.standardLambdaParameters(), ctx.lambdaBody()), ctx);
}
private LambdaExpression createLambda(StandardLambdaParametersContext standardLambdaParametersContext, LambdaBodyContext lambdaBodyContext) {
return new LambdaExpression(
this.visitStandardLambdaParameters(standardLambdaParametersContext),
this.visitLambdaBody(lambdaBodyContext));
}
@Override
public Parameter[] visitStandardLambdaParameters(StandardLambdaParametersContext ctx) {
if (asBoolean(ctx.variableDeclaratorId())) {
return new Parameter[]{
this.configureAST(
new Parameter(
ClassHelper.OBJECT_TYPE,
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName()
),
ctx.variableDeclaratorId()
)
};
}
Parameter[] parameters = this.visitFormalParameters(ctx.formalParameters());
if (0 == parameters.length) {
return null;
}
return parameters;
}
@Override
public Statement visitLambdaBody(LambdaBodyContext ctx) {
if (asBoolean(ctx.statementExpression())) {
return this.configureAST((ExpressionStatement) this.visit(ctx.statementExpression()), ctx);
}
if (asBoolean(ctx.block())) {
return this.configureAST(this.visitBlock(ctx.block()), ctx);
}
throw createParsingFailedException("Unsupported lambda body: " + ctx.getText(), ctx);
}
@Override
public ClosureExpression visitClosure(ClosureContext ctx) {
Parameter[] parameters = asBoolean(ctx.formalParameterList())
? this.visitFormalParameterList(ctx.formalParameterList())
: null;
if (!asBoolean(ctx.ARROW())) {
parameters = Parameter.EMPTY_ARRAY;
}
Statement code = this.visitBlockStatementsOpt(ctx.blockStatementsOpt());
return this.configureAST(new ClosureExpression(parameters, code), ctx);
}
@Override
public Parameter[] visitFormalParameters(FormalParametersContext ctx) {
if (!asBoolean(ctx)) {
return new Parameter[0];
}
return this.visitFormalParameterList(ctx.formalParameterList());
}
@Override
public Parameter[] visitFormalParameterList(FormalParameterListContext ctx) {
if (!asBoolean(ctx)) {
return new Parameter[0];
}
List<Parameter> parameterList = new LinkedList<>();
if (asBoolean(ctx.formalParameter())) {
parameterList.addAll(
ctx.formalParameter().stream()
.map(this::visitFormalParameter)
.collect(Collectors.toList()));
}
if (asBoolean(ctx.lastFormalParameter())) {
parameterList.add(this.visitLastFormalParameter(ctx.lastFormalParameter()));
}
return parameterList.toArray(new Parameter[0]);
}
@Override
public Parameter visitFormalParameter(FormalParameterContext ctx) {
return this.processFormalParameter(ctx, ctx.variableModifiersOpt(), ctx.type(), null, ctx.variableDeclaratorId(), ctx.expression());
}
@Override
public Parameter visitLastFormalParameter(LastFormalParameterContext ctx) {
return this.processFormalParameter(ctx, ctx.variableModifiersOpt(), ctx.type(), ctx.ELLIPSIS(), ctx.variableDeclaratorId(), ctx.expression());
}
@Override
public List<ModifierNode> visitClassOrInterfaceModifiersOpt(ClassOrInterfaceModifiersOptContext ctx) {
if (asBoolean(ctx.classOrInterfaceModifiers())) {
return this.visitClassOrInterfaceModifiers(ctx.classOrInterfaceModifiers());
}
return Collections.emptyList();
}
@Override
public List<ModifierNode> visitClassOrInterfaceModifiers(ClassOrInterfaceModifiersContext ctx) {
return ctx.classOrInterfaceModifier().stream()
.map(this::visitClassOrInterfaceModifier)
.collect(Collectors.toList());
}
@Override
public ModifierNode visitClassOrInterfaceModifier(ClassOrInterfaceModifierContext ctx) {
if (asBoolean(ctx.annotation())) {
return this.configureAST(new ModifierNode(this.visitAnnotation(ctx.annotation()), ctx.getText()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported class or interface modifier: " + ctx.getText(), ctx);
}
@Override
public ModifierNode visitModifier(ModifierContext ctx) {
if (asBoolean(ctx.classOrInterfaceModifier())) {
return this.configureAST(this.visitClassOrInterfaceModifier(ctx.classOrInterfaceModifier()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported modifier: " + ctx.getText(), ctx);
}
@Override
public List<ModifierNode> visitModifiers(ModifiersContext ctx) {
return ctx.modifier().stream()
.map(this::visitModifier)
.collect(Collectors.toList());
}
@Override
public List<ModifierNode> visitModifiersOpt(ModifiersOptContext ctx) {
if (asBoolean(ctx.modifiers())) {
return this.visitModifiers(ctx.modifiers());
}
return Collections.emptyList();
}
@Override
public ModifierNode visitVariableModifier(VariableModifierContext ctx) {
if (asBoolean(ctx.annotation())) {
return this.configureAST(new ModifierNode(this.visitAnnotation(ctx.annotation()), ctx.getText()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported variable modifier", ctx);
}
@Override
public List<ModifierNode> visitVariableModifiersOpt(VariableModifiersOptContext ctx) {
if (asBoolean(ctx.variableModifiers())) {
return this.visitVariableModifiers(ctx.variableModifiers());
}
return Collections.emptyList();
}
@Override
public List<ModifierNode> visitVariableModifiers(VariableModifiersContext ctx) {
return ctx.variableModifier().stream()
.map(this::visitVariableModifier)
.collect(Collectors.toList());
}
// type { --------------------------------------------------------------------
@Override
public ClassNode visitType(TypeContext ctx) {
if (!asBoolean(ctx)) {
return ClassHelper.OBJECT_TYPE;
}
ClassNode classNode = null;
if (asBoolean(ctx.classOrInterfaceType())) {
ctx.classOrInterfaceType().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitClassOrInterfaceType(ctx.classOrInterfaceType());
}
if (asBoolean(ctx.primitiveType())) {
classNode = this.visitPrimitiveType(ctx.primitiveType());
}
if (asBoolean(ctx.LBRACK())) {
// clear array's generics type info. Groovy's bug? array's generics type will be ignored. e.g. List<String>[]... p
classNode.setGenericsTypes(null);
classNode.setUsingGenerics(false);
for (int i = 0, n = ctx.LBRACK().size(); i < n; i++) {
classNode = this.configureAST(classNode.makeArray(), classNode);
}
}
if (!asBoolean(classNode)) {
throw createParsingFailedException("Unsupported type: " + ctx.getText(), ctx);
}
return this.configureAST(classNode, ctx);
}
@Override
public ClassNode visitClassOrInterfaceType(ClassOrInterfaceTypeContext ctx) {
ClassNode classNode;
if (asBoolean(ctx.qualifiedClassName())) {
ctx.qualifiedClassName().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitQualifiedClassName(ctx.qualifiedClassName());
} else {
ctx.qualifiedStandardClassName().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitQualifiedStandardClassName(ctx.qualifiedStandardClassName());
}
if (asBoolean(ctx.typeArguments())) {
classNode.setGenericsTypes(
this.visitTypeArguments(ctx.typeArguments()));
}
return this.configureAST(classNode, ctx);
}
@Override
public GenericsType[] visitTypeArgumentsOrDiamond(TypeArgumentsOrDiamondContext ctx) {
if (asBoolean(ctx.typeArguments())) {
return this.visitTypeArguments(ctx.typeArguments());
}
if (asBoolean(ctx.LT())) { // e.g. <>
return new GenericsType[0];
}
throw createParsingFailedException("Unsupported type arguments or diamond: " + ctx.getText(), ctx);
}
@Override
public GenericsType[] visitTypeArguments(TypeArgumentsContext ctx) {
return ctx.typeArgument().stream().map(this::visitTypeArgument).toArray(GenericsType[]::new);
}
@Override
public GenericsType visitTypeArgument(TypeArgumentContext ctx) {
if (asBoolean(ctx.QUESTION())) {
ClassNode baseType = this.configureAST(ClassHelper.makeWithoutCaching(QUESTION_STR), ctx.QUESTION());
if (!asBoolean(ctx.type())) {
GenericsType genericsType = new GenericsType(baseType);
genericsType.setWildcard(true);
genericsType.setName(QUESTION_STR);
return this.configureAST(genericsType, ctx);
}
ClassNode[] upperBounds = null;
ClassNode lowerBound = null;
ClassNode classNode = this.visitType(ctx.type());
if (asBoolean(ctx.EXTENDS())) {
upperBounds = new ClassNode[]{classNode};
} else if (asBoolean(ctx.SUPER())) {
lowerBound = classNode;
}
GenericsType genericsType = new GenericsType(baseType, upperBounds, lowerBound);
genericsType.setWildcard(true);
genericsType.setName(QUESTION_STR);
return this.configureAST(genericsType, ctx);
} else if (asBoolean(ctx.type())) {
return this.configureAST(
this.createGenericsType(
this.visitType(ctx.type())),
ctx);
}
throw createParsingFailedException("Unsupported type argument: " + ctx.getText(), ctx);
}
@Override
public ClassNode visitPrimitiveType(PrimitiveTypeContext ctx) {
return this.configureAST(ClassHelper.make(ctx.getText()), ctx);
}
// } type --------------------------------------------------------------------
@Override
public VariableExpression visitVariableDeclaratorId(VariableDeclaratorIdContext ctx) {
return this.configureAST(new VariableExpression(this.visitIdentifier(ctx.identifier())), ctx);
}
@Override
public TupleExpression visitVariableNames(VariableNamesContext ctx) {
return this.configureAST(
new TupleExpression(
ctx.variableDeclaratorId().stream()
.map(this::visitVariableDeclaratorId)
.collect(Collectors.toList())
),
ctx);
}
@Override
public BlockStatement visitBlockStatementsOpt(BlockStatementsOptContext ctx) {
if (asBoolean(ctx.blockStatements())) {
return this.configureAST(this.visitBlockStatements(ctx.blockStatements()), ctx);
}
return this.configureAST(this.createBlockStatement(), ctx);
}
@Override
public BlockStatement visitBlockStatements(BlockStatementsContext ctx) {
return this.configureAST(
this.createBlockStatement(
ctx.blockStatement().stream()
.map(this::visitBlockStatement)
.filter(e -> asBoolean(e))
.collect(Collectors.toList())),
ctx);
}
@Override
public Statement visitBlockStatement(BlockStatementContext ctx) {
if (asBoolean(ctx.localVariableDeclaration())) {
return this.configureAST(this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()), ctx);
}
if (asBoolean(ctx.statement())) {
Object astNode = this.visit(ctx.statement()); //this.configureAST((Statement) this.visit(ctx.statement()), ctx);
if (astNode instanceof MethodNode) {
throw createParsingFailedException("Method definition not expected here", ctx);
} else {
return (Statement) astNode;
}
}
throw createParsingFailedException("Unsupported block statement: " + ctx.getText(), ctx);
}
@Override
public List<AnnotationNode> visitAnnotationsOpt(AnnotationsOptContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return ctx.annotation().stream()
.map(this::visitAnnotation)
.collect(Collectors.toList());
}
@Override
public AnnotationNode visitAnnotation(AnnotationContext ctx) {
String annotationName = this.visitAnnotationName(ctx.annotationName());
AnnotationNode annotationNode = new AnnotationNode(ClassHelper.make(annotationName));
List<Pair<String, Expression>> annotationElementValues = this.visitElementValues(ctx.elementValues());
annotationElementValues.forEach(e -> annotationNode.addMember(e.getKey(), e.getValue()));
return this.configureAST(annotationNode, ctx);
}
@Override
public List<Pair<String, Expression>> visitElementValues(ElementValuesContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
List<Pair<String, Expression>> annotationElementValues = new LinkedList<>();
if (asBoolean(ctx.elementValuePairs())) {
this.visitElementValuePairs(ctx.elementValuePairs()).entrySet().forEach(e -> {
annotationElementValues.add(new Pair<>(e.getKey(), e.getValue()));
});
} else if (asBoolean(ctx.elementValue())) {
annotationElementValues.add(new Pair<>(VALUE_STR, this.visitElementValue(ctx.elementValue())));
}
return annotationElementValues;
}
@Override
public String visitAnnotationName(AnnotationNameContext ctx) {
return this.visitQualifiedClassName(ctx.qualifiedClassName()).getName();
}
@Override
public Map<String, Expression> visitElementValuePairs(ElementValuePairsContext ctx) {
return ctx.elementValuePair().stream()
.map(this::visitElementValuePair)
.collect(Collectors.toMap(
Pair::getKey,
Pair::getValue,
(k, v) -> {
throw new IllegalStateException(String.format("Duplicate key %s", k));
},
LinkedHashMap::new
));
}
@Override
public Pair<String, Expression> visitElementValuePair(ElementValuePairContext ctx) {
return new Pair<>(ctx.elementValuePairName().getText(), this.visitElementValue(ctx.elementValue()));
}
@Override
public Expression visitElementValue(ElementValueContext ctx) {
if (asBoolean(ctx.expression())) {
return this.configureAST((Expression) this.visit(ctx.expression()), ctx);
}
if (asBoolean(ctx.annotation())) {
return this.configureAST(new AnnotationConstantExpression(this.visitAnnotation(ctx.annotation())), ctx);
}
if (asBoolean(ctx.elementValueArrayInitializer())) {
return this.configureAST(this.visitElementValueArrayInitializer(ctx.elementValueArrayInitializer()), ctx);
}
throw createParsingFailedException("Unsupported element value: " + ctx.getText(), ctx);
}
@Override
public ListExpression visitElementValueArrayInitializer(ElementValueArrayInitializerContext ctx) {
return this.configureAST(new ListExpression(ctx.elementValue().stream().map(this::visitElementValue).collect(Collectors.toList())), ctx);
}
@Override
public String visitClassName(ClassNameContext ctx) {
String text = ctx.getText();
if (!text.contains("\\")) {
return text;
}
return StringUtils.replaceHexEscapes(text);
}
@Override
public String visitIdentifier(IdentifierContext ctx) {
String text = ctx.getText();
if (!text.contains("\\")) {
return text;
}
return StringUtils.replaceHexEscapes(text);
}
@Override
public String visitQualifiedName(QualifiedNameContext ctx) {
return ctx.qualifiedNameElement().stream()
.map(ParseTree::getText)
.collect(Collectors.joining(DOT_STR));
}
@Override
public ClassNode[] visitQualifiedClassNameList(QualifiedClassNameListContext ctx) {
if (!asBoolean(ctx)) {
return new ClassNode[0];
}
return ctx.qualifiedClassName().stream()
.map(this::visitQualifiedClassName)
.toArray(ClassNode[]::new);
}
@Override
public ClassNode visitQualifiedClassName(QualifiedClassNameContext ctx) {
return this.createClassNode(ctx);
}
@Override
public ClassNode visitQualifiedStandardClassName(QualifiedStandardClassNameContext ctx) {
return this.createClassNode(ctx);
}
private ClassNode createClassNode(GroovyParserRuleContext ctx) {
ClassNode result = ClassHelper.make(ctx.getText());
if (!isTrue(ctx, IS_INSIDE_INSTANCEOF_EXPR)) { // type in the "instanceof" expression should not have proxy to redirect to it
result = this.proxyClassNode(result);
}
return this.configureAST(result, ctx);
}
private ClassNode proxyClassNode(ClassNode classNode) {
if (!classNode.isUsingGenerics()) {
return classNode;
}
ClassNode cn = ClassHelper.makeWithoutCaching(classNode.getName());
cn.setRedirect(classNode);
return cn;
}
/**
* Visit tree safely, no NPE occurred when the tree is null.
*
* @param tree an AST node
* @return the visiting result
*/
@Override
public Object visit(ParseTree tree) {
if (!asBoolean(tree)) {
return null;
}
return super.visit(tree);
}
// e.g. obj.a(1, 2) or obj.a 1, 2
private MethodCallExpression createMethodCallExpression(PropertyExpression propertyExpression, Expression arguments) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
propertyExpression.getObjectExpression(),
propertyExpression.getProperty(),
arguments
);
methodCallExpression.setImplicitThis(false);
methodCallExpression.setSafe(propertyExpression.isSafe());
methodCallExpression.setSpreadSafe(propertyExpression.isSpreadSafe());
// method call obj*.m(): "safe"(false) and "spreadSafe"(true)
// property access obj*.p: "safe"(true) and "spreadSafe"(true)
// so we have to reset safe here.
if (propertyExpression.isSpreadSafe()) {
methodCallExpression.setSafe(false);
}
// if the generics types meta data is not empty, it is a generic method call, e.g. obj.<Integer>a(1, 2)
methodCallExpression.setGenericsTypes(
propertyExpression.getNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES));
return methodCallExpression;
}
// e.g. m(1, 2) or m 1, 2
private MethodCallExpression createMethodCallExpression(Expression baseExpr, Expression arguments) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
VariableExpression.THIS_EXPRESSION,
(baseExpr instanceof VariableExpression)
? this.createConstantExpression((VariableExpression) baseExpr)
: baseExpr,
arguments
);
return methodCallExpression;
}
private Parameter processFormalParameter(GroovyParserRuleContext ctx,
VariableModifiersOptContext variableModifiersOptContext,
TypeContext typeContext,
TerminalNode ellipsis,
VariableDeclaratorIdContext variableDeclaratorIdContext,
ExpressionContext expressionContext) {
ClassNode classNode = this.visitType(typeContext);
if (asBoolean(ellipsis)) {
classNode = this.configureAST(classNode.makeArray(), classNode);
}
Parameter parameter =
new ModifierManager(this, this.visitVariableModifiersOpt(variableModifiersOptContext))
.processParameter(
this.configureAST(
new Parameter(classNode, this.visitVariableDeclaratorId(variableDeclaratorIdContext).getName()),
ctx)
);
if (asBoolean(expressionContext)) {
parameter.setInitialExpression((Expression) this.visit(expressionContext));
}
return parameter;
}
private Expression createPathExpression(Expression primaryExpr, List<? extends PathElementContext> pathElementContextList) {
return (Expression) pathElementContextList.stream()
.map(e -> (Object) e)
.reduce(primaryExpr,
(r, e) -> {
PathElementContext pathElementContext = (PathElementContext) e;
pathElementContext.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR, r);
return this.visitPathElement(pathElementContext);
}
);
}
private GenericsType createGenericsType(ClassNode classNode) {
return this.configureAST(new GenericsType(classNode), classNode);
}
private ConstantExpression createConstantExpression(Expression expression) {
if (expression instanceof ConstantExpression) {
return (ConstantExpression) expression;
}
return this.configureAST(new ConstantExpression(expression.getText()), expression);
}
private BinaryExpression createBinaryExpression(ExpressionContext left, Token op, ExpressionContext right) {
return new BinaryExpression((Expression) this.visit(left), this.createGroovyToken(op), (Expression) this.visit(right));
}
private Statement unpackStatement(Statement statement) {
if (statement instanceof DeclarationListStatement) {
List<ExpressionStatement> expressionStatementList = ((DeclarationListStatement) statement).getDeclarationStatements();
if (1 == expressionStatementList.size()) {
return expressionStatementList.get(0);
}
return this.configureAST(this.createBlockStatement(statement), statement); // if DeclarationListStatement contains more than 1 declarations, maybe it's better to create a block to hold them
}
return statement;
}
public BlockStatement createBlockStatement(Statement... statements) {
return this.createBlockStatement(Arrays.asList(statements));
}
private BlockStatement createBlockStatement(List<Statement> statementList) {
return this.appendStatementsToBlockStatement(new BlockStatement(), statementList);
}
public BlockStatement appendStatementsToBlockStatement(BlockStatement bs, Statement... statements) {
return this.appendStatementsToBlockStatement(bs, Arrays.asList(statements));
}
private BlockStatement appendStatementsToBlockStatement(BlockStatement bs, List<Statement> statementList) {
return (BlockStatement) statementList.stream()
.reduce(bs, (r, e) -> {
BlockStatement blockStatement = (BlockStatement) r;
if (e instanceof DeclarationListStatement) {
((DeclarationListStatement) e).getDeclarationStatements().forEach(blockStatement::addStatement);
} else {
blockStatement.addStatement(e);
}
return blockStatement;
});
}
private boolean isAnnotationDeclaration(ClassNode classNode) {
return asBoolean(classNode) && classNode.isAnnotationDefinition();
}
private boolean isSyntheticPublic(
boolean isAnnotationDeclaration,
boolean isAnonymousInnerEnumDeclaration,
boolean hasReturnType,
ModifierManager modifierManager
) {
return this.isSyntheticPublic(
isAnnotationDeclaration,
isAnonymousInnerEnumDeclaration,
modifierManager.containsAnnotations(),
modifierManager.containsVisibilityModifier(),
modifierManager.containsNonVisibilityModifier(),
hasReturnType,
modifierManager.contains(DEF));
}
/**
* @param isAnnotationDeclaration whether the method is defined in an annotation
* @param isAnonymousInnerEnumDeclaration whether the method is defined in an anonymous inner enum
* @param hasAnnotation whether the method declaration has annotations
* @param hasVisibilityModifier whether the method declaration contains visibility modifier(e.g. public, protected, private)
* @param hasModifier whether the method declaration has modifier(e.g. visibility modifier, final, static and so on)
* @param hasReturnType whether the method declaration has an return type(e.g. String, generic types)
* @param hasDef whether the method declaration using def keyword
* @return the result
*/
private boolean isSyntheticPublic(
boolean isAnnotationDeclaration,
boolean isAnonymousInnerEnumDeclaration,
boolean hasAnnotation,
boolean hasVisibilityModifier,
boolean hasModifier,
boolean hasReturnType,
boolean hasDef) {
if (hasVisibilityModifier) {
return false;
}
if (isAnnotationDeclaration) {
return true;
}
if (hasDef && hasReturnType) {
return true;
}
if (hasModifier || hasAnnotation || !hasReturnType) {
return true;
}
if (isAnonymousInnerEnumDeclaration) {
return true;
}
return false;
}
// the mixins of interface and annotation should be null
private void hackMixins(ClassNode classNode) {
try {
// FIXME Hack with visibility.
Field field = ClassNode.class.getDeclaredField("mixins");
field.setAccessible(true);
field.set(classNode, null);
} catch (IllegalAccessException | NoSuchFieldException e) {
throw new GroovyBugError("Failed to access mixins field", e);
}
}
private static final Map<ClassNode, Object> TYPE_DEFAULT_VALUE_MAP = Collections.unmodifiableMap(new HashMap<ClassNode, Object>() {
{
this.put(ClassHelper.int_TYPE, 0);
this.put(ClassHelper.long_TYPE, 0L);
this.put(ClassHelper.double_TYPE, 0.0D);
this.put(ClassHelper.float_TYPE, 0.0F);
this.put(ClassHelper.short_TYPE, (short) 0);
this.put(ClassHelper.byte_TYPE, (byte) 0);
this.put(ClassHelper.char_TYPE, (char) 0);
this.put(ClassHelper.boolean_TYPE, Boolean.FALSE);
}
});
private Object findDefaultValueByType(ClassNode type) {
return TYPE_DEFAULT_VALUE_MAP.get(type);
}
private boolean isPackageInfoDeclaration() {
String name = this.sourceUnit.getName();
if (asBoolean((Object) name) && name.endsWith(PACKAGE_INFO_FILE_NAME)) {
return true;
}
return false;
}
private boolean isBlankScript(CompilationUnitContext ctx) {
return moduleNode.getStatementBlock().isEmpty() && moduleNode.getMethods().isEmpty() && moduleNode.getClasses().isEmpty();
}
private void addEmptyReturnStatement() {
moduleNode.addStatement(ReturnStatement.RETURN_NULL_OR_VOID);
}
private void addPackageInfoClassNode() {
List<ClassNode> classNodeList = moduleNode.getClasses();
ClassNode packageInfoClassNode = ClassHelper.make(moduleNode.getPackageName() + PACKAGE_INFO);
if (!classNodeList.contains(packageInfoClassNode)) {
moduleNode.addClass(packageInfoClassNode);
}
}
private org.codehaus.groovy.syntax.Token createGroovyTokenByType(Token token, int type) {
if (null == token) {
throw new IllegalArgumentException("token should not be null");
}
return new org.codehaus.groovy.syntax.Token(type, token.getText(), token.getLine(), token.getCharPositionInLine());
}
private org.codehaus.groovy.syntax.Token createGroovyToken(Token token) {
return this.createGroovyToken(token, 1);
}
private org.codehaus.groovy.syntax.Token createGroovyToken(Token token, int cardinality) {
String text = StringGroovyMethods.multiply((CharSequence) token.getText(), cardinality);
return new org.codehaus.groovy.syntax.Token(
"..<".equals(token.getText()) || "..".equals(token.getText())
? Types.RANGE_OPERATOR
: Types.lookup(text, Types.ANY),
text,
token.getLine(),
token.getCharPositionInLine() + 1
);
}
/*
private org.codehaus.groovy.syntax.Token createGroovyToken(String text, int startLine, int startColumn) {
return new org.codehaus.groovy.syntax.Token(
Types.lookup(text, Types.ANY),
text,
startLine,
startColumn
);
}
*/
/**
* set the script source position
*/
private void configureScriptClassNode() {
ClassNode scriptClassNode = moduleNode.getScriptClassDummy();
if (!asBoolean(scriptClassNode)) {
return;
}
List<Statement> statements = moduleNode.getStatementBlock().getStatements();
if (!statements.isEmpty()) {
Statement firstStatement = statements.get(0);
Statement lastStatement = statements.get(statements.size() - 1);
scriptClassNode.setSourcePosition(firstStatement);
scriptClassNode.setLastColumnNumber(lastStatement.getLastColumnNumber());
scriptClassNode.setLastLineNumber(lastStatement.getLastLineNumber());
}
}
/**
* Sets location(lineNumber, colNumber, lastLineNumber, lastColumnNumber) for node using standard context information.
* Note: this method is implemented to be closed over ASTNode. It returns same node as it received in arguments.
*
* @param astNode Node to be modified.
* @param ctx Context from which information is obtained.
* @return Modified astNode.
*/
private <T extends ASTNode> T configureAST(T astNode, GroovyParserRuleContext ctx) {
Token start = ctx.getStart();
Token stop = ctx.getStop();
astNode.setLineNumber(start.getLine());
astNode.setColumnNumber(start.getCharPositionInLine() + 1);
Pair<Integer, Integer> stopTokenEndPosition = endPosition(stop);
astNode.setLastLineNumber(stopTokenEndPosition.getKey());
astNode.setLastColumnNumber(stopTokenEndPosition.getValue());
return astNode;
}
private Pair<Integer, Integer> endPosition(Token token) {
String stopText = token.getText();
int stopTextLength = 0;
int newLineCnt = 0;
if (asBoolean((Object) stopText)) {
stopTextLength = stopText.length();
newLineCnt = (int) StringUtils.countChar(stopText, '\n');
}
if (0 == newLineCnt) {
return new Pair<Integer, Integer>(token.getLine(), token.getCharPositionInLine() + 1 + token.getText().length());
} else { // e.g. GStringEnd contains newlines, we should fix the location info
return new Pair<Integer, Integer>(token.getLine() + newLineCnt, stopTextLength - stopText.lastIndexOf('\n'));
}
}
private <T extends ASTNode> T configureAST(T astNode, TerminalNode terminalNode) {
return this.configureAST(astNode, terminalNode.getSymbol());
}
private <T extends ASTNode> T configureAST(T astNode, Token token) {
astNode.setLineNumber(token.getLine());
astNode.setColumnNumber(token.getCharPositionInLine() + 1);
astNode.setLastLineNumber(token.getLine());
astNode.setLastColumnNumber(token.getCharPositionInLine() + 1 + token.getText().length());
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, ASTNode source) {
astNode.setLineNumber(source.getLineNumber());
astNode.setColumnNumber(source.getColumnNumber());
astNode.setLastLineNumber(source.getLastLineNumber());
astNode.setLastColumnNumber(source.getLastColumnNumber());
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, GroovyParserRuleContext ctx, ASTNode stop) {
Token start = ctx.getStart();
astNode.setLineNumber(start.getLine());
astNode.setColumnNumber(start.getCharPositionInLine() + 1);
if (asBoolean(stop)) {
astNode.setLastLineNumber(stop.getLastLineNumber());
astNode.setLastColumnNumber(stop.getLastColumnNumber());
} else {
Pair<Integer, Integer> endPosition = endPosition(start);
astNode.setLastLineNumber(endPosition.getKey());
astNode.setLastColumnNumber(endPosition.getValue());
}
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, ASTNode start, ASTNode stop) {
astNode.setLineNumber(start.getLineNumber());
astNode.setColumnNumber(start.getColumnNumber());
if (asBoolean(stop)) {
astNode.setLastLineNumber(stop.getLastLineNumber());
astNode.setLastColumnNumber(stop.getLastColumnNumber());
} else {
astNode.setLastLineNumber(start.getLastLineNumber());
astNode.setLastColumnNumber(start.getLastColumnNumber());
}
return astNode;
}
private boolean isTrue(GroovyParserRuleContext ctx, String key) {
Object nmd = ctx.getNodeMetaData(key);
if (null == nmd) {
return false;
}
if (!(nmd instanceof Boolean)) {
throw new GroovyBugError(ctx + " ctx meta data[" + key + "] is not an instance of Boolean");
}
return (Boolean) nmd;
}
private boolean isTrue(ASTNode node, String key) {
Object nmd = node.getNodeMetaData(key);
if (null == nmd) {
return false;
}
if (!(nmd instanceof Boolean)) {
throw new GroovyBugError(node + " node meta data[" + key + "] is not an instance of Boolean");
}
return (Boolean) nmd;
}
private CompilationFailedException createParsingFailedException(String msg, GroovyParserRuleContext ctx) {
return createParsingFailedException(
new SyntaxException(msg,
ctx.start.getLine(),
ctx.start.getCharPositionInLine() + 1,
ctx.stop.getLine(),
ctx.stop.getCharPositionInLine() + 1 + ctx.stop.getText().length()));
}
public CompilationFailedException createParsingFailedException(String msg, ASTNode node) {
Objects.requireNonNull(node, "node passed into createParsingFailedException should not be null");
return createParsingFailedException(
new SyntaxException(msg,
node.getLineNumber(),
node.getColumnNumber(),
node.getLastLineNumber(),
node.getLastColumnNumber()));
}
/*
private CompilationFailedException createParsingFailedException(String msg, Token token) {
return createParsingFailedException(
new SyntaxException(msg,
token.getLine(),
token.getCharPositionInLine() + 1,
token.getLine(),
token.getCharPositionInLine() + 1 + token.getText().length()));
}
*/
private CompilationFailedException createParsingFailedException(Throwable t) {
if (t instanceof SyntaxException) {
this.collectSyntaxError((SyntaxException) t);
} else if (t instanceof GroovySyntaxError) {
GroovySyntaxError groovySyntaxError = (GroovySyntaxError) t;
this.collectSyntaxError(
new SyntaxException(
groovySyntaxError.getMessage(),
groovySyntaxError,
groovySyntaxError.getLine(),
groovySyntaxError.getColumn()));
} else if (t instanceof Exception) {
this.collectException((Exception) t);
}
return new CompilationFailedException(
CompilePhase.PARSING.getPhaseNumber(),
this.sourceUnit,
t);
}
private void collectSyntaxError(SyntaxException e) {
sourceUnit.getErrorCollector().addFatalError(new SyntaxErrorMessage(e, sourceUnit));
}
private void collectException(Exception e) {
sourceUnit.getErrorCollector().addException(e, this.sourceUnit);
}
private String readSourceCode(SourceUnit sourceUnit) {
String text = null;
try {
text = IOGroovyMethods.getText(
new BufferedReader(
sourceUnit.getSource().getReader()));
} catch (IOException e) {
LOGGER.severe(createExceptionMessage(e));
throw new RuntimeException("Error occurred when reading source code.", e);
}
return text;
}
private ANTLRErrorListener createANTLRErrorListener() {
return new ANTLRErrorListener() {
@Override
public void syntaxError(
Recognizer recognizer,
Object offendingSymbol, int line, int charPositionInLine,
String msg, RecognitionException e) {
collectSyntaxError(new SyntaxException(msg, line, charPositionInLine + 1));
}
};
}
private void removeErrorListeners() {
lexer.removeErrorListeners();
parser.removeErrorListeners();
}
private void addErrorListeners() {
lexer.removeErrorListeners();
lexer.addErrorListener(this.createANTLRErrorListener());
parser.removeErrorListeners();
parser.addErrorListener(this.createANTLRErrorListener());
}
private String createExceptionMessage(Throwable t) {
StringWriter sw = new StringWriter();
try (PrintWriter pw = new PrintWriter(sw)) {
t.printStackTrace(pw);
}
return sw.toString();
}
private class DeclarationListStatement extends Statement {
private List<ExpressionStatement> declarationStatements;
public DeclarationListStatement(DeclarationExpression... declarations) {
this(Arrays.asList(declarations));
}
public DeclarationListStatement(List<DeclarationExpression> declarations) {
this.declarationStatements =
declarations.stream()
.map(e -> configureAST(new ExpressionStatement(e), e))
.collect(Collectors.toList());
}
public List<ExpressionStatement> getDeclarationStatements() {
List<String> declarationListStatementLabels = this.getStatementLabels();
this.declarationStatements.forEach(e -> {
if (asBoolean((Object) declarationListStatementLabels)) {
// clear existing statement labels before setting labels
if (asBoolean((Object) e.getStatementLabels())) {
e.getStatementLabels().clear();
}
declarationListStatementLabels.forEach(e::addStatementLabel);
}
});
return this.declarationStatements;
}
public List<DeclarationExpression> getDeclarationExpressions() {
return this.declarationStatements.stream()
.map(e -> (DeclarationExpression) e.getExpression())
.collect(Collectors.toList());
}
}
private static class Pair<K, V> {
private K key;
private V value;
public Pair(K key, V value) {
this.key = key;
this.value = value;
}
public K getKey() {
return key;
}
public void setKey(K key) {
this.key = key;
}
public V getValue() {
return value;
}
public void setValue(V value) {
this.value = value;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Pair<?, ?> pair = (Pair<?, ?>) o;
return Objects.equals(key, pair.key) &&
Objects.equals(value, pair.value);
}
@Override
public int hashCode() {
return Objects.hash(key, value);
}
}
private final ModuleNode moduleNode;
private final SourceUnit sourceUnit;
private final ClassLoader classLoader; // Our ClassLoader, which provides information on external types
private final GroovyLangLexer lexer;
private final GroovyLangParser parser;
private final TryWithResourcesASTTransformation tryWithResourcesASTTransformation;
private final GroovydocManager groovydocManager;
private final List<ClassNode> classNodeList = new LinkedList<>();
private final Deque<ClassNode> classNodeStack = new ArrayDeque<>();
private final Deque<List<InnerClassNode>> anonymousInnerClassesDefinedInMethodStack = new ArrayDeque<>();
private int anonymousInnerClassCounter = 1;
private static final String QUESTION_STR = "?";
private static final String DOT_STR = ".";
private static final String SUB_STR = "-";
private static final String ASSIGN_STR = "=";
private static final String VALUE_STR = "value";
private static final String DOLLAR_STR = "$";
private static final String CALL_STR = "call";
private static final String THIS_STR = "this";
private static final String SUPER_STR = "super";
private static final String VOID_STR = "void";
private static final String PACKAGE_INFO = "package-info";
private static final String PACKAGE_INFO_FILE_NAME = PACKAGE_INFO + ".groovy";
private static final String GROOVY_TRANSFORM_TRAIT = "groovy.transform.Trait";
private static final Set<String> PRIMITIVE_TYPE_SET = Collections.unmodifiableSet(new HashSet<>(Arrays.asList("boolean", "char", "byte", "short", "int", "long", "float", "double")));
private static final Logger LOGGER = Logger.getLogger(AstBuilder.class.getName());
private static final String IS_INSIDE_PARENTHESES = "_IS_INSIDE_PARENTHESES";
private static final String INSIDE_PARENTHESES_LEVEL = "_INSIDE_PARENTHESES_LEVEL";
private static final String IS_INSIDE_INSTANCEOF_EXPR = "_IS_INSIDE_INSTANCEOF_EXPR";
private static final String IS_SWITCH_DEFAULT = "_IS_SWITCH_DEFAULT";
private static final String IS_NUMERIC = "_IS_NUMERIC";
private static final String IS_STRING = "_IS_STRING";
private static final String IS_INTERFACE_WITH_DEFAULT_METHODS = "_IS_INTERFACE_WITH_DEFAULT_METHODS";
private static final String PATH_EXPRESSION_BASE_EXPR = "_PATH_EXPRESSION_BASE_EXPR";
private static final String PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES = "_PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES";
private static final String CMD_EXPRESSION_BASE_EXPR = "_CMD_EXPRESSION_BASE_EXPR";
private static final String TYPE_DECLARATION_MODIFIERS = "_TYPE_DECLARATION_MODIFIERS";
private static final String CLASS_DECLARATION_CLASS_NODE = "_CLASS_DECLARATION_CLASS_NODE";
private static final String VARIABLE_DECLARATION_VARIABLE_TYPE = "_VARIABLE_DECLARATION_VARIABLE_TYPE";
private static final String ANONYMOUS_INNER_CLASS_SUPER_CLASS = "_ANONYMOUS_INNER_CLASS_SUPER_CLASS";
private static final String INTEGER_LITERAL_TEXT = "_INTEGER_LITERAL_TEXT";
private static final String FLOATING_POINT_LITERAL_TEXT = "_FLOATING_POINT_LITERAL_TEXT";
private static final String CLASS_NAME = "_CLASS_NAME";
}
| src/main/java/org/apache/groovy/parser/antlr4/AstBuilder.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.groovy.parser.antlr4;
import groovy.lang.IntRange;
import org.antlr.v4.runtime.ANTLRErrorListener;
import org.antlr.v4.runtime.ANTLRInputStream;
import org.antlr.v4.runtime.CommonTokenStream;
import org.antlr.v4.runtime.RecognitionException;
import org.antlr.v4.runtime.Recognizer;
import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.atn.PredictionMode;
import org.antlr.v4.runtime.misc.ParseCancellationException;
import org.antlr.v4.runtime.tree.ParseTree;
import org.antlr.v4.runtime.tree.TerminalNode;
import org.apache.groovy.parser.antlr4.internal.AtnManager;
import org.apache.groovy.parser.antlr4.internal.DescriptiveErrorStrategy;
import org.apache.groovy.parser.antlr4.util.StringUtils;
import org.codehaus.groovy.GroovyBugError;
import org.codehaus.groovy.antlr.EnumHelper;
import org.codehaus.groovy.ast.ASTNode;
import org.codehaus.groovy.ast.AnnotationNode;
import org.codehaus.groovy.ast.ClassHelper;
import org.codehaus.groovy.ast.ClassNode;
import org.codehaus.groovy.ast.ConstructorNode;
import org.codehaus.groovy.ast.EnumConstantClassNode;
import org.codehaus.groovy.ast.FieldNode;
import org.codehaus.groovy.ast.GenericsType;
import org.codehaus.groovy.ast.ImportNode;
import org.codehaus.groovy.ast.InnerClassNode;
import org.codehaus.groovy.ast.MethodNode;
import org.codehaus.groovy.ast.ModuleNode;
import org.codehaus.groovy.ast.PackageNode;
import org.codehaus.groovy.ast.Parameter;
import org.codehaus.groovy.ast.PropertyNode;
import org.codehaus.groovy.ast.expr.AnnotationConstantExpression;
import org.codehaus.groovy.ast.expr.ArgumentListExpression;
import org.codehaus.groovy.ast.expr.ArrayExpression;
import org.codehaus.groovy.ast.expr.AttributeExpression;
import org.codehaus.groovy.ast.expr.BinaryExpression;
import org.codehaus.groovy.ast.expr.BitwiseNegationExpression;
import org.codehaus.groovy.ast.expr.BooleanExpression;
import org.codehaus.groovy.ast.expr.CastExpression;
import org.codehaus.groovy.ast.expr.ClassExpression;
import org.codehaus.groovy.ast.expr.ClosureExpression;
import org.codehaus.groovy.ast.expr.ClosureListExpression;
import org.codehaus.groovy.ast.expr.ConstantExpression;
import org.codehaus.groovy.ast.expr.ConstructorCallExpression;
import org.codehaus.groovy.ast.expr.DeclarationExpression;
import org.codehaus.groovy.ast.expr.ElvisOperatorExpression;
import org.codehaus.groovy.ast.expr.EmptyExpression;
import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.expr.GStringExpression;
import org.codehaus.groovy.ast.expr.LambdaExpression;
import org.codehaus.groovy.ast.expr.ListExpression;
import org.codehaus.groovy.ast.expr.MapEntryExpression;
import org.codehaus.groovy.ast.expr.MapExpression;
import org.codehaus.groovy.ast.expr.MethodCallExpression;
import org.codehaus.groovy.ast.expr.MethodPointerExpression;
import org.codehaus.groovy.ast.expr.MethodReferenceExpression;
import org.codehaus.groovy.ast.expr.NamedArgumentListExpression;
import org.codehaus.groovy.ast.expr.NotExpression;
import org.codehaus.groovy.ast.expr.PostfixExpression;
import org.codehaus.groovy.ast.expr.PrefixExpression;
import org.codehaus.groovy.ast.expr.PropertyExpression;
import org.codehaus.groovy.ast.expr.RangeExpression;
import org.codehaus.groovy.ast.expr.SpreadExpression;
import org.codehaus.groovy.ast.expr.SpreadMapExpression;
import org.codehaus.groovy.ast.expr.TernaryExpression;
import org.codehaus.groovy.ast.expr.TupleExpression;
import org.codehaus.groovy.ast.expr.UnaryMinusExpression;
import org.codehaus.groovy.ast.expr.UnaryPlusExpression;
import org.codehaus.groovy.ast.expr.VariableExpression;
import org.codehaus.groovy.ast.stmt.AssertStatement;
import org.codehaus.groovy.ast.stmt.BlockStatement;
import org.codehaus.groovy.ast.stmt.BreakStatement;
import org.codehaus.groovy.ast.stmt.CaseStatement;
import org.codehaus.groovy.ast.stmt.CatchStatement;
import org.codehaus.groovy.ast.stmt.ContinueStatement;
import org.codehaus.groovy.ast.stmt.DoWhileStatement;
import org.codehaus.groovy.ast.stmt.EmptyStatement;
import org.codehaus.groovy.ast.stmt.ExpressionStatement;
import org.codehaus.groovy.ast.stmt.ForStatement;
import org.codehaus.groovy.ast.stmt.IfStatement;
import org.codehaus.groovy.ast.stmt.ReturnStatement;
import org.codehaus.groovy.ast.stmt.Statement;
import org.codehaus.groovy.ast.stmt.SwitchStatement;
import org.codehaus.groovy.ast.stmt.SynchronizedStatement;
import org.codehaus.groovy.ast.stmt.ThrowStatement;
import org.codehaus.groovy.ast.stmt.TryCatchStatement;
import org.codehaus.groovy.ast.stmt.WhileStatement;
import org.codehaus.groovy.control.CompilationFailedException;
import org.codehaus.groovy.control.CompilePhase;
import org.codehaus.groovy.control.SourceUnit;
import org.codehaus.groovy.control.messages.SyntaxErrorMessage;
import org.codehaus.groovy.runtime.IOGroovyMethods;
import org.codehaus.groovy.runtime.StringGroovyMethods;
import org.codehaus.groovy.syntax.Numbers;
import org.codehaus.groovy.syntax.SyntaxException;
import org.codehaus.groovy.syntax.Types;
import org.objectweb.asm.Opcodes;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.Field;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Deque;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.logging.Logger;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static org.apache.groovy.parser.antlr4.GroovyLangParser.*;
import static org.codehaus.groovy.runtime.DefaultGroovyMethods.asBoolean;
import static org.codehaus.groovy.runtime.DefaultGroovyMethods.last;
/**
* Building the AST from the parse tree generated by Antlr4
*
* @author <a href="mailto:[email protected]">Daniel.Sun</a>
* Created on 2016/08/14
*/
public class AstBuilder extends GroovyParserBaseVisitor<Object> implements GroovyParserVisitor<Object> {
public AstBuilder(SourceUnit sourceUnit, ClassLoader classLoader) {
this.sourceUnit = sourceUnit;
this.moduleNode = new ModuleNode(sourceUnit);
this.classLoader = classLoader; // unused for the time being
this.lexer = new GroovyLangLexer(
new ANTLRInputStream(
this.readSourceCode(sourceUnit)));
this.parser = new GroovyLangParser(
new CommonTokenStream(this.lexer));
this.parser.setErrorHandler(new DescriptiveErrorStrategy());
this.tryWithResourcesASTTransformation = new TryWithResourcesASTTransformation(this);
this.groovydocManager = new GroovydocManager(this);
}
private GroovyParserRuleContext buildCST() {
GroovyParserRuleContext result;
// parsing have to wait util clearing is complete.
AtnManager.RRWL.readLock().lock();
try {
result = buildCST(PredictionMode.SLL);
} catch (Throwable t) {
// if some syntax error occurred in the lexer, no need to retry the powerful LL mode
if (t instanceof GroovySyntaxError && GroovySyntaxError.LEXER == ((GroovySyntaxError) t).getSource()) {
throw t;
}
result = buildCST(PredictionMode.LL);
} finally {
AtnManager.RRWL.readLock().unlock();
}
return result;
}
private GroovyParserRuleContext buildCST(PredictionMode predictionMode) {
parser.getInterpreter().setPredictionMode(predictionMode);
if (PredictionMode.SLL.equals(predictionMode)) {
this.removeErrorListeners();
} else {
((CommonTokenStream) parser.getInputStream()).reset();
this.addErrorListeners();
}
return parser.compilationUnit();
}
public ModuleNode buildAST() {
try {
return (ModuleNode) this.visit(this.buildCST());
} catch (Throwable t) {
CompilationFailedException cfe;
if (t instanceof CompilationFailedException) {
cfe = (CompilationFailedException) t;
} else if (t instanceof ParseCancellationException) {
cfe = createParsingFailedException(t.getCause());
} else {
cfe = createParsingFailedException(t);
}
// LOGGER.log(Level.SEVERE, "Failed to build AST", cfe);
throw cfe;
}
}
@Override
public ModuleNode visitCompilationUnit(CompilationUnitContext ctx) {
this.visit(ctx.packageDeclaration());
ctx.statement().stream()
.map(this::visit)
// .filter(e -> e instanceof Statement)
.forEach(e -> {
if (e instanceof DeclarationListStatement) { // local variable declaration
((DeclarationListStatement) e).getDeclarationStatements().forEach(moduleNode::addStatement);
} else if (e instanceof Statement) {
moduleNode.addStatement((Statement) e);
} else if (e instanceof MethodNode) { // script method
moduleNode.addMethod((MethodNode) e);
}
});
this.classNodeList.forEach(moduleNode::addClass);
if (this.isPackageInfoDeclaration()) {
this.addPackageInfoClassNode();
} else {
// if groovy source file only contains blank(including EOF), add "return null" to the AST
if (this.isBlankScript(ctx)) {
this.addEmptyReturnStatement();
}
}
this.configureScriptClassNode();
return moduleNode;
}
@Override
public PackageNode visitPackageDeclaration(PackageDeclarationContext ctx) {
String packageName = this.visitQualifiedName(ctx.qualifiedName());
moduleNode.setPackageName(packageName + DOT_STR);
PackageNode packageNode = moduleNode.getPackage();
this.visitAnnotationsOpt(ctx.annotationsOpt()).forEach(packageNode::addAnnotation);
return this.configureAST(packageNode, ctx);
}
@Override
public ImportNode visitImportDeclaration(ImportDeclarationContext ctx) {
ImportNode importNode;
boolean hasStatic = asBoolean(ctx.STATIC());
boolean hasStar = asBoolean(ctx.MUL());
boolean hasAlias = asBoolean(ctx.alias);
List<AnnotationNode> annotationNodeList = this.visitAnnotationsOpt(ctx.annotationsOpt());
if (hasStatic) {
if (hasStar) { // e.g. import static java.lang.Math.*
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
ClassNode type = ClassHelper.make(qualifiedName);
moduleNode.addStaticStarImport(type.getText(), type, annotationNodeList);
importNode = last(moduleNode.getStaticStarImports().values());
} else { // e.g. import static java.lang.Math.pow
List<GroovyParserRuleContext> identifierList = new LinkedList<>(ctx.qualifiedName().qualifiedNameElement());
int identifierListSize = identifierList.size();
String name = identifierList.get(identifierListSize - 1).getText();
ClassNode classNode =
ClassHelper.make(
identifierList.stream()
.limit(identifierListSize - 1)
.map(ParseTree::getText)
.collect(Collectors.joining(DOT_STR)));
String alias = hasAlias
? ctx.alias.getText()
: name;
moduleNode.addStaticImport(classNode, name, alias, annotationNodeList);
importNode = last(moduleNode.getStaticImports().values());
}
} else {
if (hasStar) { // e.g. import java.util.*
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
moduleNode.addStarImport(qualifiedName + DOT_STR, annotationNodeList);
importNode = last(moduleNode.getStarImports());
} else { // e.g. import java.util.Map
String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
String name = last(ctx.qualifiedName().qualifiedNameElement()).getText();
ClassNode classNode = ClassHelper.make(qualifiedName);
String alias = hasAlias
? ctx.alias.getText()
: name;
moduleNode.addImport(alias, classNode, annotationNodeList);
importNode = last(moduleNode.getImports());
}
}
return this.configureAST(importNode, ctx);
}
// statement { --------------------------------------------------------------------
@Override
public AssertStatement visitAssertStatement(AssertStatementContext ctx) {
Expression conditionExpression = (Expression) this.visit(ctx.ce);
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
if (!asBoolean(ctx.me)) {
return this.configureAST(
new AssertStatement(booleanExpression), ctx);
}
return this.configureAST(new AssertStatement(booleanExpression,
(Expression) this.visit(ctx.me)),
ctx);
}
@Override
public AssertStatement visitAssertStmtAlt(AssertStmtAltContext ctx) {
return this.configureAST(this.visitAssertStatement(ctx.assertStatement()), ctx);
}
@Override
public IfStatement visitIfElseStmtAlt(IfElseStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
Statement ifBlock =
this.unpackStatement(
(Statement) this.visit(ctx.tb));
Statement elseBlock =
this.unpackStatement(
asBoolean(ctx.ELSE())
? (Statement) this.visit(ctx.fb)
: EmptyStatement.INSTANCE);
return this.configureAST(new IfStatement(booleanExpression, ifBlock, elseBlock), ctx);
}
@Override
public Statement visitLoopStmtAlt(LoopStmtAltContext ctx) {
return this.configureAST((Statement) this.visit(ctx.loopStatement()), ctx);
}
@Override
public ForStatement visitForStmtAlt(ForStmtAltContext ctx) {
Pair<Parameter, Expression> controlPair = this.visitForControl(ctx.forControl());
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new ForStatement(controlPair.getKey(), controlPair.getValue(), asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public Pair<Parameter, Expression> visitForControl(ForControlContext ctx) {
if (asBoolean(ctx.enhancedForControl())) { // e.g. for(int i in 0..<10) {}
return this.visitEnhancedForControl(ctx.enhancedForControl());
}
if (asBoolean(ctx.classicalForControl())) { // e.g. for(int i = 0; i < 10; i++) {}
return this.visitClassicalForControl(ctx.classicalForControl());
}
throw createParsingFailedException("Unsupported for control: " + ctx.getText(), ctx);
}
@Override
public Expression visitForInit(ForInitContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
if (asBoolean(ctx.localVariableDeclaration())) {
DeclarationListStatement declarationListStatement = this.visitLocalVariableDeclaration(ctx.localVariableDeclaration());
List<?> declarationExpressionList = declarationListStatement.getDeclarationExpressions();
if (declarationExpressionList.size() == 1) {
return this.configureAST((Expression) declarationExpressionList.get(0), ctx);
} else {
return this.configureAST(new ClosureListExpression((List<Expression>) declarationExpressionList), ctx);
}
}
if (asBoolean(ctx.expressionList())) {
return this.translateExpressionList(ctx.expressionList());
}
throw createParsingFailedException("Unsupported for init: " + ctx.getText(), ctx);
}
@Override
public Expression visitForUpdate(ForUpdateContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
return this.translateExpressionList(ctx.expressionList());
}
private Expression translateExpressionList(ExpressionListContext ctx) {
List<Expression> expressionList = this.visitExpressionList(ctx);
if (expressionList.size() == 1) {
return this.configureAST(expressionList.get(0), ctx);
} else {
return this.configureAST(new ClosureListExpression(expressionList), ctx);
}
}
@Override
public Pair<Parameter, Expression> visitEnhancedForControl(EnhancedForControlContext ctx) {
Parameter parameter = this.configureAST(
new Parameter(this.visitType(ctx.type()), this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName()),
ctx.variableDeclaratorId());
// FIXME Groovy will ignore variableModifier of parameter in the for control
// In order to make the new parser behave same with the old one, we do not process variableModifier*
return new Pair<>(parameter, (Expression) this.visit(ctx.expression()));
}
@Override
public Pair<Parameter, Expression> visitClassicalForControl(ClassicalForControlContext ctx) {
ClosureListExpression closureListExpression = new ClosureListExpression();
closureListExpression.addExpression(this.visitForInit(ctx.forInit()));
closureListExpression.addExpression(asBoolean(ctx.expression()) ? (Expression) this.visit(ctx.expression()) : EmptyExpression.INSTANCE);
closureListExpression.addExpression(this.visitForUpdate(ctx.forUpdate()));
return new Pair<>(ForStatement.FOR_LOOP_DUMMY, closureListExpression);
}
@Override
public WhileStatement visitWhileStmtAlt(WhileStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression), conditionExpression);
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new WhileStatement(booleanExpression, asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public DoWhileStatement visitDoWhileStmtAlt(DoWhileStmtAltContext ctx) {
Expression conditionExpression = this.visitParExpression(ctx.parExpression());
BooleanExpression booleanExpression =
this.configureAST(
new BooleanExpression(conditionExpression),
conditionExpression
);
Statement loopBlock = this.unpackStatement((Statement) this.visit(ctx.statement()));
return this.configureAST(
new DoWhileStatement(booleanExpression, asBoolean(loopBlock) ? loopBlock : EmptyStatement.INSTANCE),
ctx);
}
@Override
public Statement visitTryCatchStmtAlt(TryCatchStmtAltContext ctx) {
return this.configureAST(this.visitTryCatchStatement(ctx.tryCatchStatement()), ctx);
}
@Override
public Statement visitTryCatchStatement(TryCatchStatementContext ctx) {
TryCatchStatement tryCatchStatement =
new TryCatchStatement((Statement) this.visit(ctx.block()),
this.visitFinallyBlock(ctx.finallyBlock()));
if (asBoolean(ctx.resources())) {
this.visitResources(ctx.resources()).forEach(tryCatchStatement::addResource);
}
ctx.catchClause().stream().map(this::visitCatchClause)
.reduce(new LinkedList<CatchStatement>(), (r, e) -> {
r.addAll(e); // merge several LinkedList<CatchStatement> instances into one LinkedList<CatchStatement> instance
return r;
})
.forEach(tryCatchStatement::addCatch);
return this.configureAST(
tryWithResourcesASTTransformation.transform(
this.configureAST(tryCatchStatement, ctx)),
ctx);
}
@Override
public List<ExpressionStatement> visitResources(ResourcesContext ctx) {
return this.visitResourceList(ctx.resourceList());
}
@Override
public List<ExpressionStatement> visitResourceList(ResourceListContext ctx) {
return ctx.resource().stream().map(this::visitResource).collect(Collectors.toList());
}
@Override
public ExpressionStatement visitResource(ResourceContext ctx) {
if (asBoolean(ctx.localVariableDeclaration())) {
List<ExpressionStatement> declarationStatements = this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()).getDeclarationStatements();
if (declarationStatements.size() > 1) {
throw createParsingFailedException("Multi resources can not be declared in one statement", ctx);
}
return declarationStatements.get(0);
} else if (asBoolean(ctx.expression())) {
Expression expression = (Expression) this.visit(ctx.expression());
if (!(expression instanceof BinaryExpression
&& Types.ASSIGN == ((BinaryExpression) expression).getOperation().getType()
&& ((BinaryExpression) expression).getLeftExpression() instanceof VariableExpression)) {
throw createParsingFailedException("Only variable declarations are allowed to declare resource", ctx);
}
BinaryExpression assignmentExpression = (BinaryExpression) expression;
return this.configureAST(
new ExpressionStatement(
this.configureAST(
new DeclarationExpression(
this.configureAST(
new VariableExpression(assignmentExpression.getLeftExpression().getText()),
assignmentExpression.getLeftExpression()
),
assignmentExpression.getOperation(),
assignmentExpression.getRightExpression()
), ctx)
), ctx);
}
throw createParsingFailedException("Unsupported resource declaration: " + ctx.getText(), ctx);
}
/**
* Multi-catch(1..*) clause will be unpacked to several normal catch clauses, so the return type is List
*
* @param ctx the parse tree
* @return
*/
@Override
public List<CatchStatement> visitCatchClause(CatchClauseContext ctx) {
// FIXME Groovy will ignore variableModifier of parameter in the catch clause
// In order to make the new parser behave same with the old one, we do not process variableModifier*
return this.visitCatchType(ctx.catchType()).stream()
.map(e -> this.configureAST(
new CatchStatement(
// FIXME The old parser does not set location info for the parameter of the catch clause.
// we could make it better
//this.configureAST(new Parameter(e, this.visitIdentifier(ctx.identifier())), ctx.Identifier()),
new Parameter(e, this.visitIdentifier(ctx.identifier())),
this.visitBlock(ctx.block())),
ctx.block()))
.collect(Collectors.toList());
}
@Override
public List<ClassNode> visitCatchType(CatchTypeContext ctx) {
if (!asBoolean(ctx)) {
return Collections.singletonList(ClassHelper.OBJECT_TYPE);
}
return ctx.qualifiedClassName().stream()
.map(this::visitQualifiedClassName)
.collect(Collectors.toList());
}
@Override
public Statement visitFinallyBlock(FinallyBlockContext ctx) {
if (!asBoolean(ctx)) {
return EmptyStatement.INSTANCE;
}
return this.configureAST(
this.createBlockStatement((Statement) this.visit(ctx.block())),
ctx);
}
@Override
public SwitchStatement visitSwitchStmtAlt(SwitchStmtAltContext ctx) {
return this.configureAST(this.visitSwitchStatement(ctx.switchStatement()), ctx);
}
public SwitchStatement visitSwitchStatement(SwitchStatementContext ctx) {
List<Statement> statementList =
ctx.switchBlockStatementGroup().stream()
.map(this::visitSwitchBlockStatementGroup)
.reduce(new LinkedList<>(), (r, e) -> {
r.addAll(e);
return r;
});
List<CaseStatement> caseStatementList = new LinkedList<>();
List<Statement> defaultStatementList = new LinkedList<>();
statementList.forEach(e -> {
if (e instanceof CaseStatement) {
caseStatementList.add((CaseStatement) e);
} else if (isTrue(e, IS_SWITCH_DEFAULT)) {
defaultStatementList.add(e);
}
});
int defaultStatementListSize = defaultStatementList.size();
if (defaultStatementListSize > 1) {
throw createParsingFailedException("switch statement should have only one default case, which should appear at last", defaultStatementList.get(0));
}
if (defaultStatementListSize > 0 && last(statementList) instanceof CaseStatement) {
throw createParsingFailedException("default case should appear at last", defaultStatementList.get(0));
}
return this.configureAST(
new SwitchStatement(
this.visitParExpression(ctx.parExpression()),
caseStatementList,
defaultStatementListSize == 0 ? EmptyStatement.INSTANCE : defaultStatementList.get(0)
),
ctx);
}
@Override
@SuppressWarnings({"unchecked"})
public List<Statement> visitSwitchBlockStatementGroup(SwitchBlockStatementGroupContext ctx) {
int labelCnt = ctx.switchLabel().size();
List<Token> firstLabelHolder = new ArrayList<>(1);
return (List<Statement>) ctx.switchLabel().stream()
.map(e -> (Object) this.visitSwitchLabel(e))
.reduce(new ArrayList<Statement>(4), (r, e) -> {
List<Statement> statementList = (List<Statement>) r;
Pair<Token, Expression> pair = (Pair<Token, Expression>) e;
boolean isLast = labelCnt - 1 == statementList.size();
switch (pair.getKey().getType()) {
case CASE: {
if (!asBoolean(statementList)) {
firstLabelHolder.add(pair.getKey());
}
statementList.add(
this.configureAST(
new CaseStatement(
pair.getValue(),
// check whether processing the last label. if yes, block statement should be attached.
isLast ? this.visitBlockStatements(ctx.blockStatements())
: EmptyStatement.INSTANCE
),
firstLabelHolder.get(0)));
break;
}
case DEFAULT: {
BlockStatement blockStatement = this.visitBlockStatements(ctx.blockStatements());
blockStatement.putNodeMetaData(IS_SWITCH_DEFAULT, true);
statementList.add(
// this.configureAST(blockStatement, pair.getKey())
blockStatement
);
break;
}
}
return statementList;
});
}
@Override
public Pair<Token, Expression> visitSwitchLabel(SwitchLabelContext ctx) {
if (asBoolean(ctx.CASE())) {
return new Pair<>(ctx.CASE().getSymbol(), (Expression) this.visit(ctx.expression()));
} else if (asBoolean(ctx.DEFAULT())) {
return new Pair<>(ctx.DEFAULT().getSymbol(), EmptyExpression.INSTANCE);
}
throw createParsingFailedException("Unsupported switch label: " + ctx.getText(), ctx);
}
@Override
public SynchronizedStatement visitSynchronizedStmtAlt(SynchronizedStmtAltContext ctx) {
return this.configureAST(
new SynchronizedStatement(this.visitParExpression(ctx.parExpression()), this.visitBlock(ctx.block())),
ctx);
}
@Override
public ExpressionStatement visitExpressionStmtAlt(ExpressionStmtAltContext ctx) {
return (ExpressionStatement) this.visit(ctx.statementExpression());
}
@Override
public ReturnStatement visitReturnStmtAlt(ReturnStmtAltContext ctx) {
return this.configureAST(new ReturnStatement(asBoolean(ctx.expression())
? (Expression) this.visit(ctx.expression())
: ConstantExpression.EMPTY_EXPRESSION),
ctx);
}
@Override
public ThrowStatement visitThrowStmtAlt(ThrowStmtAltContext ctx) {
return this.configureAST(
new ThrowStatement((Expression) this.visit(ctx.expression())),
ctx);
}
@Override
public Statement visitLabeledStmtAlt(LabeledStmtAltContext ctx) {
Statement statement = (Statement) this.visit(ctx.statement());
statement.addStatementLabel(this.visitIdentifier(ctx.identifier()));
return statement; // this.configureAST(statement, ctx);
}
@Override
public BreakStatement visitBreakStatement(BreakStatementContext ctx) {
String label = asBoolean(ctx.identifier())
? this.visitIdentifier(ctx.identifier())
: null;
return this.configureAST(new BreakStatement(label), ctx);
}
@Override
public BreakStatement visitBreakStmtAlt(BreakStmtAltContext ctx) {
return this.configureAST(this.visitBreakStatement(ctx.breakStatement()), ctx);
}
@Override
public ContinueStatement visitContinueStatement(ContinueStatementContext ctx) {
String label = asBoolean(ctx.identifier())
? this.visitIdentifier(ctx.identifier())
: null;
return this.configureAST(new ContinueStatement(label), ctx);
}
@Override
public ContinueStatement visitContinueStmtAlt(ContinueStmtAltContext ctx) {
return this.configureAST(this.visitContinueStatement(ctx.continueStatement()), ctx);
}
@Override
public ImportNode visitImportStmtAlt(ImportStmtAltContext ctx) {
return this.configureAST(this.visitImportDeclaration(ctx.importDeclaration()), ctx);
}
@Override
public ClassNode visitTypeDeclarationStmtAlt(TypeDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitTypeDeclaration(ctx.typeDeclaration()), ctx);
}
@Override
public Statement visitLocalVariableDeclarationStmtAlt(LocalVariableDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()), ctx);
}
@Override
public MethodNode visitMethodDeclarationStmtAlt(MethodDeclarationStmtAltContext ctx) {
return this.configureAST(this.visitMethodDeclaration(ctx.methodDeclaration()), ctx);
}
// } statement --------------------------------------------------------------------
@Override
public ClassNode visitTypeDeclaration(TypeDeclarationContext ctx) {
if (asBoolean(ctx.classDeclaration())) { // e.g. class A {}
ctx.classDeclaration().putNodeMetaData(TYPE_DECLARATION_MODIFIERS, this.visitClassOrInterfaceModifiersOpt(ctx.classOrInterfaceModifiersOpt()));
return this.configureAST(this.visitClassDeclaration(ctx.classDeclaration()), ctx);
}
throw createParsingFailedException("Unsupported type declaration: " + ctx.getText(), ctx);
}
private void initUsingGenerics(ClassNode classNode) {
if (classNode.isUsingGenerics()) {
return;
}
if (!classNode.isEnum()) {
classNode.setUsingGenerics(classNode.getSuperClass().isUsingGenerics());
}
if (!classNode.isUsingGenerics() && asBoolean((Object) classNode.getInterfaces())) {
for (ClassNode anInterface : classNode.getInterfaces()) {
classNode.setUsingGenerics(classNode.isUsingGenerics() || anInterface.isUsingGenerics());
if (classNode.isUsingGenerics())
break;
}
}
}
@Override
public ClassNode visitClassDeclaration(ClassDeclarationContext ctx) {
String packageName = moduleNode.getPackageName();
packageName = asBoolean((Object) packageName) ? packageName : "";
List<ModifierNode> modifierNodeList = ctx.getNodeMetaData(TYPE_DECLARATION_MODIFIERS);
Objects.requireNonNull(modifierNodeList, "modifierNodeList should not be null");
ModifierManager modifierManager = new ModifierManager(this, modifierNodeList);
int modifiers = modifierManager.getClassModifiersOpValue();
boolean syntheticPublic = ((modifiers & Opcodes.ACC_SYNTHETIC) != 0);
modifiers &= ~Opcodes.ACC_SYNTHETIC;
final ClassNode outerClass = classNodeStack.peek();
ClassNode classNode;
String className = this.visitIdentifier(ctx.identifier());
if (asBoolean(ctx.ENUM())) {
classNode =
EnumHelper.makeEnumNode(
asBoolean(outerClass) ? className : packageName + className,
modifiers, null, outerClass);
} else {
if (asBoolean(outerClass)) {
classNode =
new InnerClassNode(
outerClass,
outerClass.getName() + "$" + className,
modifiers | (outerClass.isInterface() ? Opcodes.ACC_STATIC : 0),
ClassHelper.OBJECT_TYPE);
} else {
classNode =
new ClassNode(
packageName + className,
modifiers,
ClassHelper.OBJECT_TYPE);
}
}
this.configureAST(classNode, ctx);
classNode.putNodeMetaData(CLASS_NAME, className);
classNode.setSyntheticPublic(syntheticPublic);
if (asBoolean(ctx.TRAIT())) {
classNode.addAnnotation(new AnnotationNode(ClassHelper.make(GROOVY_TRANSFORM_TRAIT)));
}
classNode.addAnnotations(modifierManager.getAnnotations());
classNode.setGenericsTypes(this.visitTypeParameters(ctx.typeParameters()));
boolean isInterface = asBoolean(ctx.INTERFACE()) && !asBoolean(ctx.AT());
boolean isInterfaceWithDefaultMethods = false;
// declaring interface with default method
if (isInterface && this.containsDefaultMethods(ctx)) {
isInterfaceWithDefaultMethods = true;
classNode.addAnnotation(new AnnotationNode(ClassHelper.make(GROOVY_TRANSFORM_TRAIT)));
classNode.putNodeMetaData(IS_INTERFACE_WITH_DEFAULT_METHODS, true);
}
if (asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT()) || isInterfaceWithDefaultMethods) { // class OR trait OR interface with default methods
classNode.setSuperClass(this.visitType(ctx.sc));
classNode.setInterfaces(this.visitTypeList(ctx.is));
this.initUsingGenerics(classNode);
} else if (isInterface) { // interface(NOT annotation)
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_INTERFACE | Opcodes.ACC_ABSTRACT);
classNode.setSuperClass(ClassHelper.OBJECT_TYPE);
classNode.setInterfaces(this.visitTypeList(ctx.scs));
this.initUsingGenerics(classNode);
this.hackMixins(classNode);
} else if (asBoolean(ctx.ENUM())) { // enum
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_ENUM | Opcodes.ACC_FINAL);
classNode.setInterfaces(this.visitTypeList(ctx.is));
this.initUsingGenerics(classNode);
} else if (asBoolean(ctx.AT())) { // annotation
classNode.setModifiers(classNode.getModifiers() | Opcodes.ACC_INTERFACE | Opcodes.ACC_ABSTRACT | Opcodes.ACC_ANNOTATION);
classNode.addInterface(ClassHelper.Annotation_TYPE);
this.hackMixins(classNode);
} else {
throw createParsingFailedException("Unsupported class declaration: " + ctx.getText(), ctx);
}
// we put the class already in output to avoid the most inner classes
// will be used as first class later in the loader. The first class
// there determines what GCL#parseClass for example will return, so we
// have here to ensure it won't be the inner class
if (asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT())) {
classNodeList.add(classNode);
}
int oldAnonymousInnerClassCounter = this.anonymousInnerClassCounter;
classNodeStack.push(classNode);
ctx.classBody().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassBody(ctx.classBody());
classNodeStack.pop();
this.anonymousInnerClassCounter = oldAnonymousInnerClassCounter;
if (!(asBoolean(ctx.CLASS()) || asBoolean(ctx.TRAIT()))) {
classNodeList.add(classNode);
}
groovydocManager.handle(classNode, ctx);
return classNode;
}
@SuppressWarnings({"unchecked"})
private boolean containsDefaultMethods(ClassDeclarationContext ctx) {
List<MethodDeclarationContext> methodDeclarationContextList =
(List<MethodDeclarationContext>) ctx.classBody().classBodyDeclaration().stream()
.map(ClassBodyDeclarationContext::memberDeclaration)
.filter(Objects::nonNull)
.map(e -> (Object) e.methodDeclaration())
.filter(Objects::nonNull).reduce(new LinkedList<MethodDeclarationContext>(), (r, e) -> {
MethodDeclarationContext methodDeclarationContext = (MethodDeclarationContext) e;
if (createModifierManager(methodDeclarationContext).contains(DEFAULT)) {
((List) r).add(methodDeclarationContext);
}
return r;
});
return !methodDeclarationContextList.isEmpty();
}
@Override
public Void visitClassBody(ClassBodyContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.enumConstants())) {
ctx.enumConstants().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitEnumConstants(ctx.enumConstants());
}
ctx.classBodyDeclaration().forEach(e -> {
e.putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassBodyDeclaration(e);
});
return null;
}
@Override
public List<FieldNode> visitEnumConstants(EnumConstantsContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
return ctx.enumConstant().stream()
.map(e -> {
e.putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
return this.visitEnumConstant(e);
})
.collect(Collectors.toList());
}
@Override
public FieldNode visitEnumConstant(EnumConstantContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
InnerClassNode anonymousInnerClassNode = null;
if (asBoolean(ctx.anonymousInnerClassDeclaration())) {
ctx.anonymousInnerClassDeclaration().putNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS, classNode);
anonymousInnerClassNode = this.visitAnonymousInnerClassDeclaration(ctx.anonymousInnerClassDeclaration());
}
FieldNode enumConstant =
EnumHelper.addEnumConstant(
classNode,
this.visitIdentifier(ctx.identifier()),
createEnumConstantInitExpression(ctx.arguments(), anonymousInnerClassNode));
this.visitAnnotationsOpt(ctx.annotationsOpt()).forEach(enumConstant::addAnnotation);
groovydocManager.handle(enumConstant, ctx);
return this.configureAST(enumConstant, ctx);
}
private Expression createEnumConstantInitExpression(ArgumentsContext ctx, InnerClassNode anonymousInnerClassNode) {
if (!asBoolean(ctx) && !asBoolean(anonymousInnerClassNode)) {
return null;
}
TupleExpression argumentListExpression = (TupleExpression) this.visitArguments(ctx);
List<Expression> expressions = argumentListExpression.getExpressions();
if (expressions.size() == 1) {
Expression expression = expressions.get(0);
if (expression instanceof NamedArgumentListExpression) { // e.g. SOME_ENUM_CONSTANT(a: "1", b: "2")
List<MapEntryExpression> mapEntryExpressionList = ((NamedArgumentListExpression) expression).getMapEntryExpressions();
ListExpression listExpression =
new ListExpression(
mapEntryExpressionList.stream()
.map(e -> (Expression) e)
.collect(Collectors.toList()));
if (asBoolean(anonymousInnerClassNode)) {
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
}
if (mapEntryExpressionList.size() > 1) {
listExpression.setWrapped(true);
}
return this.configureAST(listExpression, ctx);
}
if (!asBoolean(anonymousInnerClassNode)) {
if (expression instanceof ListExpression) {
ListExpression listExpression = new ListExpression();
listExpression.addExpression(expression);
return this.configureAST(listExpression, ctx);
}
return expression;
}
ListExpression listExpression = new ListExpression();
if (expression instanceof ListExpression) {
((ListExpression) expression).getExpressions().forEach(listExpression::addExpression);
} else {
listExpression.addExpression(expression);
}
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
return this.configureAST(listExpression, ctx);
}
ListExpression listExpression = new ListExpression(expressions);
if (asBoolean(anonymousInnerClassNode)) {
listExpression.addExpression(
this.configureAST(
new ClassExpression(anonymousInnerClassNode),
anonymousInnerClassNode));
}
if (asBoolean(ctx)) {
listExpression.setWrapped(true);
}
return asBoolean(ctx)
? this.configureAST(listExpression, ctx)
: this.configureAST(listExpression, anonymousInnerClassNode);
}
@Override
public Void visitClassBodyDeclaration(ClassBodyDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.memberDeclaration())) {
ctx.memberDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitMemberDeclaration(ctx.memberDeclaration());
} else if (asBoolean(ctx.block())) {
Statement statement = this.visitBlock(ctx.block());
if (asBoolean(ctx.STATIC())) { // e.g. static { }
classNode.addStaticInitializerStatements(Collections.singletonList(statement), false);
} else { // e.g. { }
classNode.addObjectInitializerStatements(
this.configureAST(
this.createBlockStatement(statement),
statement));
}
}
return null;
}
@Override
public Void visitMemberDeclaration(MemberDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
if (asBoolean(ctx.methodDeclaration())) {
ctx.methodDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitMethodDeclaration(ctx.methodDeclaration());
} else if (asBoolean(ctx.fieldDeclaration())) {
ctx.fieldDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitFieldDeclaration(ctx.fieldDeclaration());
} else if (asBoolean(ctx.classDeclaration())) {
ctx.classDeclaration().putNodeMetaData(TYPE_DECLARATION_MODIFIERS, this.visitModifiersOpt(ctx.modifiersOpt()));
ctx.classDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitClassDeclaration(ctx.classDeclaration());
}
return null;
}
@Override
public GenericsType[] visitTypeParameters(TypeParametersContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return ctx.typeParameter().stream()
.map(this::visitTypeParameter)
.toArray(GenericsType[]::new);
}
@Override
public GenericsType visitTypeParameter(TypeParameterContext ctx) {
return this.configureAST(
new GenericsType(
ClassHelper.make(this.visitClassName(ctx.className())),
this.visitTypeBound(ctx.typeBound()),
null
),
ctx);
}
@Override
public ClassNode[] visitTypeBound(TypeBoundContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return ctx.type().stream()
.map(this::visitType)
.toArray(ClassNode[]::new);
}
@Override
public Void visitFieldDeclaration(FieldDeclarationContext ctx) {
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
Objects.requireNonNull(classNode, "classNode should not be null");
ctx.variableDeclaration().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, classNode);
this.visitVariableDeclaration(ctx.variableDeclaration());
return null;
}
private ConstructorCallExpression checkThisAndSuperConstructorCall(Statement statement) {
if (!(statement instanceof BlockStatement)) { // method code must be a BlockStatement
return null;
}
BlockStatement blockStatement = (BlockStatement) statement;
List<Statement> statementList = blockStatement.getStatements();
for (int i = 0, n = statementList.size(); i < n; i++) {
Statement s = statementList.get(i);
if (s instanceof ExpressionStatement) {
Expression expression = ((ExpressionStatement) s).getExpression();
if ((expression instanceof ConstructorCallExpression) && 0 != i) {
return (ConstructorCallExpression) expression;
}
}
}
return null;
}
private ModifierManager createModifierManager(MethodDeclarationContext ctx) {
List<ModifierNode> modifierNodeList = Collections.emptyList();
if (asBoolean(ctx.modifiers())) {
modifierNodeList = this.visitModifiers(ctx.modifiers());
} else if (asBoolean(ctx.modifiersOpt())) {
modifierNodeList = this.visitModifiersOpt(ctx.modifiersOpt());
}
return new ModifierManager(this, modifierNodeList);
}
private void validateParametersOfMethodDeclaration(Parameter[] parameters, ClassNode classNode) {
if (!classNode.isInterface()) {
return;
}
Arrays.stream(parameters).forEach(e -> {
if (e.hasInitialExpression()) {
throw createParsingFailedException("Cannot specify default value for method parameter '" + e.getName() + " = " + e.getInitialExpression().getText() + "' inside an interface", e);
}
});
}
@Override
public MethodNode visitMethodDeclaration(MethodDeclarationContext ctx) {
ModifierManager modifierManager = createModifierManager(ctx);
String methodName = this.visitMethodName(ctx.methodName());
ClassNode returnType = this.visitReturnType(ctx.returnType());
Parameter[] parameters = this.visitFormalParameters(ctx.formalParameters());
ClassNode[] exceptions = this.visitQualifiedClassNameList(ctx.qualifiedClassNameList());
anonymousInnerClassesDefinedInMethodStack.push(new LinkedList<>());
Statement code = this.visitMethodBody(ctx.methodBody());
List<InnerClassNode> anonymousInnerClassList = anonymousInnerClassesDefinedInMethodStack.pop();
MethodNode methodNode;
// if classNode is not null, the method declaration is for class declaration
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
if (asBoolean(classNode)) {
validateParametersOfMethodDeclaration(parameters, classNode);
methodNode = createConstructorOrMethodNodeForClass(ctx, modifierManager, methodName, returnType, parameters, exceptions, code, classNode);
} else { // script method declaration
methodNode = createScriptMethodNode(modifierManager, methodName, returnType, parameters, exceptions, code);
}
anonymousInnerClassList.forEach(e -> e.setEnclosingMethod(methodNode));
methodNode.setGenericsTypes(this.visitTypeParameters(ctx.typeParameters()));
methodNode.setSyntheticPublic(
this.isSyntheticPublic(
this.isAnnotationDeclaration(classNode),
classNode instanceof EnumConstantClassNode,
asBoolean(ctx.returnType()),
modifierManager));
if (modifierManager.contains(STATIC)) {
Arrays.stream(methodNode.getParameters()).forEach(e -> e.setInStaticContext(true));
methodNode.getVariableScope().setInStaticContext(true);
}
this.configureAST(methodNode, ctx);
validateMethodDeclaration(ctx, methodNode, modifierManager, classNode);
groovydocManager.handle(methodNode, ctx);
return methodNode;
}
private void validateMethodDeclaration(MethodDeclarationContext ctx, MethodNode methodNode, ModifierManager modifierManager, ClassNode classNode) {
boolean isAbstractMethod = methodNode.isAbstract();
boolean hasMethodBody = asBoolean(methodNode.getCode());
if (9 == ctx.ct) { // script
if (isAbstractMethod || !hasMethodBody) { // method should not be declared abstract in the script
throw createParsingFailedException("You can not define a " + (isAbstractMethod ? "abstract" : "") + " method[" + methodNode.getName() + "] " + (!hasMethodBody ? "without method body" : "") + " in the script. Try " + (isAbstractMethod ? "removing the 'abstract'" : "") + (isAbstractMethod && !hasMethodBody ? " and" : "") + (!hasMethodBody ? " adding a method body" : ""), methodNode);
}
} else {
if (!isAbstractMethod && !hasMethodBody) { // non-abstract method without body in the non-script(e.g. class, enum, trait) is not allowed!
throw createParsingFailedException("You defined a method[" + methodNode.getName() + "] without body. Try adding a method body, or declare it abstract", methodNode);
}
boolean isInterfaceOrAbstractClass = asBoolean(classNode) && classNode.isAbstract() && !classNode.isAnnotationDefinition();
if (isInterfaceOrAbstractClass && !modifierManager.contains(DEFAULT) && isAbstractMethod && hasMethodBody) {
throw createParsingFailedException("You defined an abstract method[" + methodNode.getName() + "] with body. Try removing the method body" + (classNode.isInterface() ? ", or declare it default" : ""), methodNode);
}
}
modifierManager.validate(methodNode);
if (methodNode instanceof ConstructorNode) {
modifierManager.validate((ConstructorNode) methodNode);
}
}
private MethodNode createScriptMethodNode(ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code) {
MethodNode methodNode;
methodNode =
new MethodNode(
methodName,
modifierManager.contains(PRIVATE) ? Opcodes.ACC_PRIVATE : Opcodes.ACC_PUBLIC,
returnType,
parameters,
exceptions,
code);
modifierManager.processMethodNode(methodNode);
return methodNode;
}
private MethodNode createConstructorOrMethodNodeForClass(MethodDeclarationContext ctx, ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode) {
MethodNode methodNode;
String className = classNode.getNodeMetaData(CLASS_NAME);
int modifiers = modifierManager.getClassMemberModifiersOpValue();
if (!asBoolean(ctx.returnType())
&& asBoolean(ctx.methodBody())
&& methodName.equals(className)) { // constructor declaration
methodNode = createConstructorNodeForClass(methodName, parameters, exceptions, code, classNode, modifiers);
} else { // class memeber method declaration
methodNode = createMethodNodeForClass(ctx, modifierManager, methodName, returnType, parameters, exceptions, code, classNode, modifiers);
}
modifierManager.attachAnnotations(methodNode);
return methodNode;
}
private MethodNode createMethodNodeForClass(MethodDeclarationContext ctx, ModifierManager modifierManager, String methodName, ClassNode returnType, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode, int modifiers) {
MethodNode methodNode;
if (asBoolean(ctx.elementValue())) { // the code of annotation method
code = this.configureAST(
new ExpressionStatement(
this.visitElementValue(ctx.elementValue())),
ctx.elementValue());
}
modifiers |= !modifierManager.contains(STATIC) && (classNode.isInterface() || (isTrue(classNode, IS_INTERFACE_WITH_DEFAULT_METHODS) && !modifierManager.contains(DEFAULT))) ? Opcodes.ACC_ABSTRACT : 0;
checkWhetherMethodNodeWithSameSignatureExists(classNode, methodName, parameters, ctx);
methodNode = classNode.addMethod(methodName, modifiers, returnType, parameters, exceptions, code);
methodNode.setAnnotationDefault(asBoolean(ctx.elementValue()));
return methodNode;
}
private void checkWhetherMethodNodeWithSameSignatureExists(ClassNode classNode, String methodName, Parameter[] parameters, MethodDeclarationContext ctx) {
MethodNode sameSigMethodNode = classNode.getDeclaredMethod(methodName, parameters);
if (null == sameSigMethodNode) {
return;
}
throw createParsingFailedException("The method " + sameSigMethodNode.getText() + " duplicates another method of the same signature", ctx);
}
private ConstructorNode createConstructorNodeForClass(String methodName, Parameter[] parameters, ClassNode[] exceptions, Statement code, ClassNode classNode, int modifiers) {
ConstructorCallExpression thisOrSuperConstructorCallExpression = this.checkThisAndSuperConstructorCall(code);
if (asBoolean(thisOrSuperConstructorCallExpression)) {
throw createParsingFailedException(thisOrSuperConstructorCallExpression.getText() + " should be the first statement in the constructor[" + methodName + "]", thisOrSuperConstructorCallExpression);
}
return classNode.addConstructor(
modifiers,
parameters,
exceptions,
code);
}
@Override
public String visitMethodName(MethodNameContext ctx) {
if (asBoolean(ctx.identifier())) {
return this.visitIdentifier(ctx.identifier());
}
if (asBoolean(ctx.stringLiteral())) {
return this.visitStringLiteral(ctx.stringLiteral()).getText();
}
throw createParsingFailedException("Unsupported method name: " + ctx.getText(), ctx);
}
@Override
public ClassNode visitReturnType(ReturnTypeContext ctx) {
if (!asBoolean(ctx)) {
return ClassHelper.OBJECT_TYPE;
}
if (asBoolean(ctx.type())) {
return this.visitType(ctx.type());
}
if (asBoolean(ctx.VOID())) {
return ClassHelper.VOID_TYPE;
}
throw createParsingFailedException("Unsupported return type: " + ctx.getText(), ctx);
}
@Override
public Statement visitMethodBody(MethodBodyContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return this.configureAST(this.visitBlock(ctx.block()), ctx);
}
@Override
public DeclarationListStatement visitLocalVariableDeclaration(LocalVariableDeclarationContext ctx) {
return this.configureAST(this.visitVariableDeclaration(ctx.variableDeclaration()), ctx);
}
private ModifierManager createModifierManager(VariableDeclarationContext ctx) {
List<ModifierNode> modifierNodeList = Collections.emptyList();
if (asBoolean(ctx.variableModifiers())) {
modifierNodeList = this.visitVariableModifiers(ctx.variableModifiers());
} else if (asBoolean(ctx.variableModifiersOpt())) {
modifierNodeList = this.visitVariableModifiersOpt(ctx.variableModifiersOpt());
} else if (asBoolean(ctx.modifiers())) {
modifierNodeList = this.visitModifiers(ctx.modifiers());
} else if (asBoolean(ctx.modifiersOpt())) {
modifierNodeList = this.visitModifiersOpt(ctx.modifiersOpt());
}
return new ModifierManager(this, modifierNodeList);
}
private DeclarationListStatement createMultiAssignmentDeclarationListStatement(VariableDeclarationContext ctx, ModifierManager modifierManager) {
if (!modifierManager.contains(DEF)) {
throw createParsingFailedException("keyword def is required to declare tuple, e.g. def (int a, int b) = [1, 2]", ctx);
}
return this.configureAST(
new DeclarationListStatement(
this.configureAST(
modifierManager.attachAnnotations(
new DeclarationExpression(
new ArgumentListExpression(
this.visitTypeNamePairs(ctx.typeNamePairs()).stream()
.peek(e -> modifierManager.processVariableExpression((VariableExpression) e))
.collect(Collectors.toList())
),
this.createGroovyTokenByType(ctx.ASSIGN().getSymbol(), Types.ASSIGN),
this.visitVariableInitializer(ctx.variableInitializer())
)
),
ctx
)
),
ctx
);
}
@Override
public DeclarationListStatement visitVariableDeclaration(VariableDeclarationContext ctx) {
ModifierManager modifierManager = this.createModifierManager(ctx);
if (asBoolean(ctx.typeNamePairs())) { // e.g. def (int a, int b) = [1, 2]
return this.createMultiAssignmentDeclarationListStatement(ctx, modifierManager);
}
ClassNode variableType = this.visitType(ctx.type());
ctx.variableDeclarators().putNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE, variableType);
List<DeclarationExpression> declarationExpressionList = this.visitVariableDeclarators(ctx.variableDeclarators());
// if classNode is not null, the variable declaration is for class declaration. In other words, it is a field declaration
ClassNode classNode = ctx.getNodeMetaData(CLASS_DECLARATION_CLASS_NODE);
if (asBoolean(classNode)) {
return createFieldDeclarationListStatement(ctx, modifierManager, variableType, declarationExpressionList, classNode);
}
declarationExpressionList.forEach(e -> {
VariableExpression variableExpression = (VariableExpression) e.getLeftExpression();
modifierManager.processVariableExpression(variableExpression);
modifierManager.attachAnnotations(e);
});
int size = declarationExpressionList.size();
if (size > 0) {
DeclarationExpression declarationExpression = declarationExpressionList.get(0);
if (1 == size) {
this.configureAST(declarationExpression, ctx);
} else {
// Tweak start of first declaration
declarationExpression.setLineNumber(ctx.getStart().getLine());
declarationExpression.setColumnNumber(ctx.getStart().getCharPositionInLine() + 1);
}
}
return this.configureAST(new DeclarationListStatement(declarationExpressionList), ctx);
}
private DeclarationListStatement createFieldDeclarationListStatement(VariableDeclarationContext ctx, ModifierManager modifierManager, ClassNode variableType, List<DeclarationExpression> declarationExpressionList, ClassNode classNode) {
for (int i = 0, n = declarationExpressionList.size(); i < n; i++) {
DeclarationExpression declarationExpression = declarationExpressionList.get(i);
VariableExpression variableExpression = (VariableExpression) declarationExpression.getLeftExpression();
int modifiers = modifierManager.getClassMemberModifiersOpValue();
Expression initialValue = EmptyExpression.INSTANCE.equals(declarationExpression.getRightExpression()) ? null : declarationExpression.getRightExpression();
Object defaultValue = findDefaultValueByType(variableType);
if (classNode.isInterface()) {
if (!asBoolean(initialValue)) {
initialValue = !asBoolean(defaultValue) ? null : new ConstantExpression(defaultValue);
}
modifiers |= Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC | Opcodes.ACC_FINAL;
}
if (classNode.isInterface() || modifierManager.containsVisibilityModifier()) {
FieldNode fieldNode =
classNode.addField(
variableExpression.getName(),
modifiers,
variableType,
initialValue);
modifierManager.attachAnnotations(fieldNode);
groovydocManager.handle(fieldNode, ctx);
if (0 == i) {
this.configureAST(fieldNode, ctx, initialValue);
} else {
this.configureAST(fieldNode, variableExpression, initialValue);
}
} else {
PropertyNode propertyNode =
classNode.addProperty(
variableExpression.getName(),
modifiers | Opcodes.ACC_PUBLIC,
variableType,
initialValue,
null,
null);
FieldNode fieldNode = propertyNode.getField();
fieldNode.setModifiers(modifiers & ~Opcodes.ACC_PUBLIC | Opcodes.ACC_PRIVATE);
fieldNode.setSynthetic(!classNode.isInterface());
modifierManager.attachAnnotations(fieldNode);
groovydocManager.handle(fieldNode, ctx);
groovydocManager.handle(propertyNode, ctx);
if (0 == i) {
this.configureAST(fieldNode, ctx, initialValue);
this.configureAST(propertyNode, ctx, initialValue);
} else {
this.configureAST(fieldNode, variableExpression, initialValue);
this.configureAST(propertyNode, variableExpression, initialValue);
}
}
}
return null;
}
@Override
public List<Expression> visitTypeNamePairs(TypeNamePairsContext ctx) {
return ctx.typeNamePair().stream().map(this::visitTypeNamePair).collect(Collectors.toList());
}
@Override
public VariableExpression visitTypeNamePair(TypeNamePairContext ctx) {
return this.configureAST(
new VariableExpression(
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName(),
this.visitType(ctx.type())),
ctx);
}
@Override
public List<DeclarationExpression> visitVariableDeclarators(VariableDeclaratorsContext ctx) {
ClassNode variableType = ctx.getNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE);
Objects.requireNonNull(variableType, "variableType should not be null");
return ctx.variableDeclarator().stream()
.map(e -> {
e.putNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE, variableType);
return this.visitVariableDeclarator(e);
// return this.configureAST(this.visitVariableDeclarator(e), ctx);
})
.collect(Collectors.toList());
}
@Override
public DeclarationExpression visitVariableDeclarator(VariableDeclaratorContext ctx) {
ClassNode variableType = ctx.getNodeMetaData(VARIABLE_DECLARATION_VARIABLE_TYPE);
Objects.requireNonNull(variableType, "variableType should not be null");
org.codehaus.groovy.syntax.Token token;
if (asBoolean(ctx.ASSIGN())) {
token = createGroovyTokenByType(ctx.ASSIGN().getSymbol(), Types.ASSIGN);
} else {
token = new org.codehaus.groovy.syntax.Token(Types.ASSIGN, ASSIGN_STR, ctx.start.getLine(), 1);
}
return this.configureAST(
new DeclarationExpression(
this.configureAST(
new VariableExpression(
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName(),
variableType
),
ctx.variableDeclaratorId()),
token,
this.visitVariableInitializer(ctx.variableInitializer())),
ctx);
}
@Override
public Expression visitVariableInitializer(VariableInitializerContext ctx) {
if (!asBoolean(ctx)) {
return EmptyExpression.INSTANCE;
}
if (asBoolean(ctx.statementExpression())) {
return this.configureAST(
((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression(),
ctx);
}
if (asBoolean(ctx.standardLambda())) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
throw createParsingFailedException("Unsupported variable initializer: " + ctx.getText(), ctx);
}
@Override
public List<Expression> visitVariableInitializers(VariableInitializersContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return ctx.variableInitializer().stream()
.map(this::visitVariableInitializer)
.collect(Collectors.toList());
}
@Override
public List<Expression> visitArrayInitializer(ArrayInitializerContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.visitVariableInitializers(ctx.variableInitializers());
}
@Override
public Statement visitBlock(BlockContext ctx) {
if (!asBoolean(ctx)) {
return this.createBlockStatement();
}
return this.configureAST(
this.visitBlockStatementsOpt(ctx.blockStatementsOpt()),
ctx);
}
@Override
public ExpressionStatement visitNormalExprAlt(NormalExprAltContext ctx) {
return this.configureAST(new ExpressionStatement((Expression) this.visit(ctx.expression())), ctx);
}
@Override
public ExpressionStatement visitCommandExprAlt(CommandExprAltContext ctx) {
return this.configureAST(new ExpressionStatement(this.visitCommandExpression(ctx.commandExpression())), ctx);
}
@Override
public Expression visitCommandExpression(CommandExpressionContext ctx) {
Expression baseExpr = this.visitPathExpression(ctx.pathExpression());
Expression arguments = this.visitEnhancedArgumentList(ctx.enhancedArgumentList());
MethodCallExpression methodCallExpression;
if (baseExpr instanceof PropertyExpression) { // e.g. obj.a 1, 2
methodCallExpression =
this.configureAST(
this.createMethodCallExpression(
(PropertyExpression) baseExpr, arguments),
arguments);
} else if (baseExpr instanceof MethodCallExpression && !isTrue(baseExpr, IS_INSIDE_PARENTHESES)) { // e.g. m {} a, b OR m(...) a, b
if (asBoolean(arguments)) {
// The error should never be thrown.
throw new GroovyBugError("When baseExpr is a instance of MethodCallExpression, which should follow NO argumentList");
}
methodCallExpression = (MethodCallExpression) baseExpr;
} else if (
!isTrue(baseExpr, IS_INSIDE_PARENTHESES)
&& (baseExpr instanceof VariableExpression /* e.g. m 1, 2 */
|| baseExpr instanceof GStringExpression /* e.g. "$m" 1, 2 */
|| (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_STRING)) /* e.g. "m" 1, 2 */)
) {
methodCallExpression =
this.configureAST(
this.createMethodCallExpression(baseExpr, arguments),
arguments);
} else { // e.g. a[x] b, new A() b, etc.
methodCallExpression =
this.configureAST(
new MethodCallExpression(
baseExpr,
CALL_STR,
arguments
),
arguments
);
methodCallExpression.setImplicitThis(false);
}
if (!asBoolean(ctx.commandArgument())) {
return this.configureAST(methodCallExpression, ctx);
}
return this.configureAST(
(Expression) ctx.commandArgument().stream()
.map(e -> (Object) e)
.reduce(methodCallExpression,
(r, e) -> {
CommandArgumentContext commandArgumentContext = (CommandArgumentContext) e;
commandArgumentContext.putNodeMetaData(CMD_EXPRESSION_BASE_EXPR, r);
return this.visitCommandArgument(commandArgumentContext);
}
),
ctx);
}
@Override
public Expression visitCommandArgument(CommandArgumentContext ctx) {
// e.g. x y a b we call "x y" as the base expression
Expression baseExpr = ctx.getNodeMetaData(CMD_EXPRESSION_BASE_EXPR);
Expression primaryExpr = (Expression) this.visit(ctx.primary());
if (asBoolean(ctx.enhancedArgumentList())) { // e.g. x y a b
if (baseExpr instanceof PropertyExpression) { // the branch should never reach, because a.b.c will be parsed as a path expression, not a method call
throw createParsingFailedException("Unsupported command argument: " + ctx.getText(), ctx);
}
// the following code will process "a b" of "x y a b"
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
this.createConstantExpression(primaryExpr),
this.visitEnhancedArgumentList(ctx.enhancedArgumentList())
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
} else if (asBoolean(ctx.pathElement())) { // e.g. x y a.b
Expression pathExpression =
this.createPathExpression(
this.configureAST(
new PropertyExpression(baseExpr, this.createConstantExpression(primaryExpr)),
primaryExpr
),
ctx.pathElement()
);
return this.configureAST(pathExpression, ctx);
}
// e.g. x y a
return this.configureAST(
new PropertyExpression(
baseExpr,
primaryExpr instanceof VariableExpression
? this.createConstantExpression(primaryExpr)
: primaryExpr
),
primaryExpr
);
}
// expression { --------------------------------------------------------------------
@Override
public ClassNode visitCastParExpression(CastParExpressionContext ctx) {
return this.visitType(ctx.type());
}
@Override
public Expression visitParExpression(ParExpressionContext ctx) {
Expression expression;
if (asBoolean(ctx.statementExpression())) {
expression = ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression();
} else if (asBoolean(ctx.standardLambda())) {
expression = this.visitStandardLambda(ctx.standardLambda());
} else {
throw createParsingFailedException("Unsupported parentheses expression: " + ctx.getText(), ctx);
}
expression.putNodeMetaData(IS_INSIDE_PARENTHESES, true);
Integer insideParenLevel = expression.getNodeMetaData(INSIDE_PARENTHESES_LEVEL);
if (asBoolean((Object) insideParenLevel)) {
insideParenLevel++;
} else {
insideParenLevel = 1;
}
expression.putNodeMetaData(INSIDE_PARENTHESES_LEVEL, insideParenLevel);
return this.configureAST(expression, ctx);
}
@Override
public Expression visitPathExpression(PathExpressionContext ctx) {
return this.configureAST(
this.createPathExpression((Expression) this.visit(ctx.primary()), ctx.pathElement()),
ctx);
}
@Override
public Expression visitPathElement(PathElementContext ctx) {
Expression baseExpr = ctx.getNodeMetaData(PATH_EXPRESSION_BASE_EXPR);
Objects.requireNonNull(baseExpr, "baseExpr is required!");
if (asBoolean(ctx.namePart())) {
Expression namePartExpr = this.visitNamePart(ctx.namePart());
GenericsType[] genericsTypes = this.visitNonWildcardTypeArguments(ctx.nonWildcardTypeArguments());
if (asBoolean(ctx.DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj.@a
return this.configureAST(new AttributeExpression(baseExpr, namePartExpr), ctx);
} else { // e.g. obj.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
return this.configureAST(propertyExpression, ctx);
}
} else if (asBoolean(ctx.SAFE_DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj?.@a
return this.configureAST(new AttributeExpression(baseExpr, namePartExpr, true), ctx);
} else { // e.g. obj?.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr, true);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
return this.configureAST(propertyExpression, ctx);
}
} else if (asBoolean(ctx.METHOD_POINTER())) { // e.g. obj.&m
return this.configureAST(new MethodPointerExpression(baseExpr, namePartExpr), ctx);
} else if (asBoolean(ctx.METHOD_REFERENCE())) { // e.g. obj::m
return this.configureAST(new MethodReferenceExpression(baseExpr, namePartExpr), ctx);
} else if (asBoolean(ctx.SPREAD_DOT())) {
if (asBoolean(ctx.AT())) { // e.g. obj*.@a
AttributeExpression attributeExpression = new AttributeExpression(baseExpr, namePartExpr, true);
attributeExpression.setSpreadSafe(true);
return this.configureAST(attributeExpression, ctx);
} else { // e.g. obj*.p
PropertyExpression propertyExpression = new PropertyExpression(baseExpr, namePartExpr, true);
propertyExpression.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES, genericsTypes);
propertyExpression.setSpreadSafe(true);
return this.configureAST(propertyExpression, ctx);
}
}
}
if (asBoolean(ctx.indexPropertyArgs())) { // e.g. list[1, 3, 5]
Pair<Token, Expression> pair = this.visitIndexPropertyArgs(ctx.indexPropertyArgs());
return this.configureAST(
new BinaryExpression(baseExpr, createGroovyToken(pair.getKey()), pair.getValue(), asBoolean(ctx.indexPropertyArgs().QUESTION())),
ctx);
}
if (asBoolean(ctx.namedPropertyArgs())) { // this is a special way to new instance, e.g. Person(name: 'Daniel.Sun', location: 'Shanghai')
List<MapEntryExpression> mapEntryExpressionList =
this.visitNamedPropertyArgs(ctx.namedPropertyArgs());
Expression right;
if (mapEntryExpressionList.size() == 1) {
MapEntryExpression mapEntryExpression = mapEntryExpressionList.get(0);
if (mapEntryExpression.getKeyExpression() instanceof SpreadMapExpression) {
right = mapEntryExpression.getKeyExpression();
} else {
right = mapEntryExpression;
}
} else {
ListExpression listExpression =
this.configureAST(
new ListExpression(
mapEntryExpressionList.stream()
.map(
e -> {
if (e.getKeyExpression() instanceof SpreadMapExpression) {
return e.getKeyExpression();
}
return e;
}
)
.collect(Collectors.toList())),
ctx.namedPropertyArgs()
);
listExpression.setWrapped(true);
right = listExpression;
}
return this.configureAST(
new BinaryExpression(baseExpr, createGroovyToken(ctx.namedPropertyArgs().LBRACK().getSymbol()), right),
ctx);
}
if (asBoolean(ctx.arguments())) {
Expression argumentsExpr = this.visitArguments(ctx.arguments());
if (isTrue(baseExpr, IS_INSIDE_PARENTHESES)) { // e.g. (obj.x)(), (obj.@x)()
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
CALL_STR,
argumentsExpr
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof AttributeExpression) { // e.g. obj.@a(1, 2)
AttributeExpression attributeExpression = (AttributeExpression) baseExpr;
attributeExpression.setSpreadSafe(false); // whether attributeExpression is spread safe or not, we must reset it as false
MethodCallExpression methodCallExpression =
new MethodCallExpression(
attributeExpression,
CALL_STR,
argumentsExpr
);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof PropertyExpression) { // e.g. obj.a(1, 2)
MethodCallExpression methodCallExpression =
this.createMethodCallExpression((PropertyExpression) baseExpr, argumentsExpr);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof VariableExpression) { // void and primitive type AST node must be an instance of VariableExpression
String baseExprText = baseExpr.getText();
if (VOID_STR.equals(baseExprText)) { // e.g. void()
MethodCallExpression methodCallExpression =
new MethodCallExpression(
this.createConstantExpression(baseExpr),
CALL_STR,
argumentsExpr
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
} else if (PRIMITIVE_TYPE_SET.contains(baseExprText)) { // e.g. int(), long(), float(), etc.
throw createParsingFailedException("Primitive type literal: " + baseExprText + " cannot be used as a method name", ctx);
}
}
if (baseExpr instanceof VariableExpression
|| baseExpr instanceof GStringExpression
|| (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_STRING))) { // e.g. m(), "$m"(), "m"()
String baseExprText = baseExpr.getText();
if (SUPER_STR.equals(baseExprText) || THIS_STR.equals(baseExprText)) { // e.g. this(...), super(...)
// class declaration is not allowed in the closure,
// so if this and super is inside the closure, it will not be constructor call.
// e.g. src/test/org/codehaus/groovy/transform/MapConstructorTransformTest.groovy:
// @MapConstructor(pre={ super(args?.first, args?.last); args = args ?: [:] }, post = { first = first?.toUpperCase() })
if (ctx.isInsideClosure) {
return this.configureAST(
new MethodCallExpression(
baseExpr,
baseExprText,
argumentsExpr
),
ctx);
}
return this.configureAST(
new ConstructorCallExpression(
SUPER_STR.equals(baseExprText)
? ClassNode.SUPER
: ClassNode.THIS,
argumentsExpr
),
ctx);
}
MethodCallExpression methodCallExpression =
this.createMethodCallExpression(baseExpr, argumentsExpr);
return this.configureAST(methodCallExpression, ctx);
}
// e.g. 1(), 1.1(), ((int) 1 / 2)(1, 2), {a, b -> a + b }(1, 2), m()()
MethodCallExpression methodCallExpression =
new MethodCallExpression(baseExpr, CALL_STR, argumentsExpr);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (asBoolean(ctx.closure())) {
ClosureExpression closureExpression = this.visitClosure(ctx.closure());
if (baseExpr instanceof MethodCallExpression) {
MethodCallExpression methodCallExpression = (MethodCallExpression) baseExpr;
Expression argumentsExpression = methodCallExpression.getArguments();
if (argumentsExpression instanceof ArgumentListExpression) { // normal arguments, e.g. 1, 2
ArgumentListExpression argumentListExpression = (ArgumentListExpression) argumentsExpression;
argumentListExpression.getExpressions().add(closureExpression);
return this.configureAST(methodCallExpression, ctx);
}
if (argumentsExpression instanceof TupleExpression) { // named arguments, e.g. x: 1, y: 2
TupleExpression tupleExpression = (TupleExpression) argumentsExpression;
NamedArgumentListExpression namedArgumentListExpression = (NamedArgumentListExpression) tupleExpression.getExpression(0);
if (asBoolean(tupleExpression.getExpressions())) {
methodCallExpression.setArguments(
this.configureAST(
new ArgumentListExpression(
Stream.of(
this.configureAST(
new MapExpression(namedArgumentListExpression.getMapEntryExpressions()),
namedArgumentListExpression
),
closureExpression
).collect(Collectors.toList())
),
tupleExpression
)
);
} else {
// the branch should never reach, because named arguments must not be empty
methodCallExpression.setArguments(
this.configureAST(
new ArgumentListExpression(closureExpression),
tupleExpression));
}
return this.configureAST(methodCallExpression, ctx);
}
}
// e.g. 1 {}, 1.1 {}
if (baseExpr instanceof ConstantExpression && isTrue(baseExpr, IS_NUMERIC)) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
baseExpr,
CALL_STR,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression
)
);
methodCallExpression.setImplicitThis(false);
return this.configureAST(methodCallExpression, ctx);
}
if (baseExpr instanceof PropertyExpression) { // e.g. obj.m { }
PropertyExpression propertyExpression = (PropertyExpression) baseExpr;
MethodCallExpression methodCallExpression =
this.createMethodCallExpression(
propertyExpression,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression
)
);
return this.configureAST(methodCallExpression, ctx);
}
// e.g. m { return 1; }
MethodCallExpression methodCallExpression =
new MethodCallExpression(
VariableExpression.THIS_EXPRESSION,
(baseExpr instanceof VariableExpression)
? this.createConstantExpression((VariableExpression) baseExpr)
: baseExpr,
this.configureAST(
new ArgumentListExpression(closureExpression),
closureExpression)
);
return this.configureAST(methodCallExpression, ctx);
}
throw createParsingFailedException("Unsupported path element: " + ctx.getText(), ctx);
}
@Override
public GenericsType[] visitNonWildcardTypeArguments(NonWildcardTypeArgumentsContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
return Arrays.stream(this.visitTypeList(ctx.typeList()))
.map(this::createGenericsType)
.toArray(GenericsType[]::new);
}
@Override
public ClassNode[] visitTypeList(TypeListContext ctx) {
if (!asBoolean(ctx)) {
return new ClassNode[0];
}
return ctx.type().stream()
.map(this::visitType)
.toArray(ClassNode[]::new);
}
@Override
public Expression visitArguments(ArgumentsContext ctx) {
if (!asBoolean(ctx) || !asBoolean(ctx.enhancedArgumentList())) {
return new ArgumentListExpression();
}
return this.configureAST(this.visitEnhancedArgumentList(ctx.enhancedArgumentList()), ctx);
}
@Override
public Expression visitEnhancedArgumentList(EnhancedArgumentListContext ctx) {
if (!asBoolean(ctx)) {
return null;
}
List<Expression> expressionList = new LinkedList<>();
List<MapEntryExpression> mapEntryExpressionList = new LinkedList<>();
ctx.enhancedArgumentListElement().stream()
.map(this::visitEnhancedArgumentListElement)
.forEach(e -> {
if (e instanceof MapEntryExpression) {
mapEntryExpressionList.add((MapEntryExpression) e);
} else {
expressionList.add(e);
}
});
if (!asBoolean(mapEntryExpressionList)) { // e.g. arguments like 1, 2 OR someArg, e -> e
return this.configureAST(
new ArgumentListExpression(expressionList),
ctx);
}
if (!asBoolean(expressionList)) { // e.g. arguments like x: 1, y: 2
return this.configureAST(
new TupleExpression(
this.configureAST(
new NamedArgumentListExpression(mapEntryExpressionList),
ctx)),
ctx);
}
if (asBoolean(mapEntryExpressionList) && asBoolean(expressionList)) { // e.g. arguments like x: 1, 'a', y: 2, 'b', z: 3
ArgumentListExpression argumentListExpression = new ArgumentListExpression(expressionList);
argumentListExpression.getExpressions().add(0, new MapExpression(mapEntryExpressionList)); // TODO: confirm BUG OR NOT? All map entries will be put at first, which is not friendly to Groovy developers
return this.configureAST(argumentListExpression, ctx);
}
throw createParsingFailedException("Unsupported argument list: " + ctx.getText(), ctx);
}
@Override
public Expression visitEnhancedArgumentListElement(EnhancedArgumentListElementContext ctx) {
if (asBoolean(ctx.expressionListElement())) {
return this.configureAST(this.visitExpressionListElement(ctx.expressionListElement()), ctx);
}
if (asBoolean(ctx.standardLambda())) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
if (asBoolean(ctx.mapEntry())) {
return this.configureAST(this.visitMapEntry(ctx.mapEntry()), ctx);
}
throw createParsingFailedException("Unsupported enhanced argument list element: " + ctx.getText(), ctx);
}
@Override
public ConstantExpression visitStringLiteral(StringLiteralContext ctx) {
String text = ctx.StringLiteral().getText();
int slashyType = text.startsWith("/") ? StringUtils.SLASHY :
text.startsWith("$/") ? StringUtils.DOLLAR_SLASHY : StringUtils.NONE_SLASHY;
if (text.startsWith("'''") || text.startsWith("\"\"\"")) {
text = StringUtils.removeCR(text); // remove CR in the multiline string
text = text.length() == 6 ? "" : text.substring(3, text.length() - 3);
} else if (text.startsWith("'") || text.startsWith("/") || text.startsWith("\"")) {
if (text.startsWith("/")) { // the slashy string can span rows, so we have to remove CR for it
text = StringUtils.removeCR(text); // remove CR in the multiline string
}
text = text.length() == 2 ? "" : text.substring(1, text.length() - 1);
} else if (text.startsWith("$/")) {
text = StringUtils.removeCR(text);
text = text.length() == 4 ? "" : text.substring(2, text.length() - 2);
}
//handle escapes.
text = StringUtils.replaceEscapes(text, slashyType);
ConstantExpression constantExpression = new ConstantExpression(text, true);
constantExpression.putNodeMetaData(IS_STRING, true);
return this.configureAST(constantExpression, ctx);
}
@Override
public Pair<Token, Expression> visitIndexPropertyArgs(IndexPropertyArgsContext ctx) {
List<Expression> expressionList = this.visitExpressionList(ctx.expressionList());
if (expressionList.size() == 1) {
Expression expr = expressionList.get(0);
Expression indexExpr;
if (expr instanceof SpreadExpression) { // e.g. a[*[1, 2]]
ListExpression listExpression = new ListExpression(expressionList);
listExpression.setWrapped(false);
indexExpr = listExpression;
} else { // e.g. a[1]
indexExpr = expr;
}
return new Pair<>(ctx.LBRACK().getSymbol(), indexExpr);
}
// e.g. a[1, 2]
ListExpression listExpression = new ListExpression(expressionList);
listExpression.setWrapped(true);
return new Pair<>(ctx.LBRACK().getSymbol(), this.configureAST(listExpression, ctx));
}
@Override
public List<MapEntryExpression> visitNamedPropertyArgs(NamedPropertyArgsContext ctx) {
return this.visitMapEntryList(ctx.mapEntryList());
}
@Override
public Expression visitNamePart(NamePartContext ctx) {
if (asBoolean(ctx.identifier())) {
return this.configureAST(new ConstantExpression(this.visitIdentifier(ctx.identifier())), ctx);
} else if (asBoolean(ctx.stringLiteral())) {
return this.configureAST(this.visitStringLiteral(ctx.stringLiteral()), ctx);
} else if (asBoolean(ctx.dynamicMemberName())) {
return this.configureAST(this.visitDynamicMemberName(ctx.dynamicMemberName()), ctx);
} else if (asBoolean(ctx.keywords())) {
return this.configureAST(new ConstantExpression(ctx.keywords().getText()), ctx);
}
throw createParsingFailedException("Unsupported name part: " + ctx.getText(), ctx);
}
@Override
public Expression visitDynamicMemberName(DynamicMemberNameContext ctx) {
if (asBoolean(ctx.parExpression())) {
return this.configureAST(this.visitParExpression(ctx.parExpression()), ctx);
} else if (asBoolean(ctx.gstring())) {
return this.configureAST(this.visitGstring(ctx.gstring()), ctx);
}
throw createParsingFailedException("Unsupported dynamic member name: " + ctx.getText(), ctx);
}
@Override
public Expression visitPostfixExpression(PostfixExpressionContext ctx) {
Expression pathExpr = this.visitPathExpression(ctx.pathExpression());
if (asBoolean(ctx.op)) {
PostfixExpression postfixExpression = new PostfixExpression(pathExpr, createGroovyToken(ctx.op));
if (ctx.isInsideAssert) {
// powerassert requires different column for values, so we have to copy the location of op
return this.configureAST(postfixExpression, ctx.op);
} else {
return this.configureAST(postfixExpression, ctx);
}
}
return this.configureAST(pathExpr, ctx);
}
@Override
public Expression visitPostfixExprAlt(PostfixExprAltContext ctx) {
return this.visitPostfixExpression(ctx.postfixExpression());
}
@Override
public Expression visitUnaryNotExprAlt(UnaryNotExprAltContext ctx) {
if (asBoolean(ctx.NOT())) {
return this.configureAST(
new NotExpression((Expression) this.visit(ctx.expression())),
ctx);
}
if (asBoolean(ctx.BITNOT())) {
return this.configureAST(
new BitwiseNegationExpression((Expression) this.visit(ctx.expression())),
ctx);
}
throw createParsingFailedException("Unsupported unary expression: " + ctx.getText(), ctx);
}
@Override
public CastExpression visitCastExprAlt(CastExprAltContext ctx) {
return this.configureAST(
new CastExpression(
this.visitCastParExpression(ctx.castParExpression()),
(Expression) this.visit(ctx.expression())
),
ctx
);
}
@Override
public BinaryExpression visitPowerExprAlt(PowerExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitUnaryAddExprAlt(UnaryAddExprAltContext ctx) {
ExpressionContext expressionCtx = ctx.expression();
Expression expression = (Expression) this.visit(expressionCtx);
Boolean insidePar = isTrue(expression, IS_INSIDE_PARENTHESES);
switch (ctx.op.getType()) {
case ADD: {
if (expression instanceof ConstantExpression && !insidePar) {
return this.configureAST(expression, ctx);
}
return this.configureAST(new UnaryPlusExpression(expression), ctx);
}
case SUB: {
if (expression instanceof ConstantExpression && !insidePar) {
ConstantExpression constantExpression = (ConstantExpression) expression;
String integerLiteralText = constantExpression.getNodeMetaData(INTEGER_LITERAL_TEXT);
if (asBoolean((Object) integerLiteralText)) {
return this.configureAST(new ConstantExpression(Numbers.parseInteger(null, SUB_STR + integerLiteralText)), ctx);
}
String floatingPointLiteralText = constantExpression.getNodeMetaData(FLOATING_POINT_LITERAL_TEXT);
if (asBoolean((Object) floatingPointLiteralText)) {
return this.configureAST(new ConstantExpression(Numbers.parseDecimal(SUB_STR + floatingPointLiteralText)), ctx);
}
throw new GroovyBugError("Failed to find the original number literal text: " + constantExpression.getText());
}
return this.configureAST(new UnaryMinusExpression(expression), ctx);
}
case INC:
case DEC:
return this.configureAST(new PrefixExpression(this.createGroovyToken(ctx.op), expression), ctx);
default:
throw createParsingFailedException("Unsupported unary operation: " + ctx.getText(), ctx);
}
}
@Override
public BinaryExpression visitMultiplicativeExprAlt(MultiplicativeExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitAdditiveExprAlt(AdditiveExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitShiftExprAlt(ShiftExprAltContext ctx) {
Expression left = (Expression) this.visit(ctx.left);
Expression right = (Expression) this.visit(ctx.right);
if (asBoolean(ctx.rangeOp)) {
return this.configureAST(new RangeExpression(left, right, !ctx.rangeOp.getText().endsWith("<")), ctx);
}
org.codehaus.groovy.syntax.Token op = null;
if (asBoolean(ctx.dlOp)) {
op = this.createGroovyToken(ctx.dlOp, 2);
} else if (asBoolean(ctx.dgOp)) {
op = this.createGroovyToken(ctx.dgOp, 2);
} else if (asBoolean(ctx.tgOp)) {
op = this.createGroovyToken(ctx.tgOp, 3);
} else {
throw createParsingFailedException("Unsupported shift expression: " + ctx.getText(), ctx);
}
return this.configureAST(
new BinaryExpression(left, op, right),
ctx);
}
@Override
public Expression visitRelationalExprAlt(RelationalExprAltContext ctx) {
switch (ctx.op.getType()) {
case AS:
return this.configureAST(
CastExpression.asExpression(this.visitType(ctx.type()), (Expression) this.visit(ctx.left)),
ctx);
case INSTANCEOF:
case NOT_INSTANCEOF:
ctx.type().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, true);
return this.configureAST(
new BinaryExpression((Expression) this.visit(ctx.left),
this.createGroovyToken(ctx.op),
this.configureAST(new ClassExpression(this.visitType(ctx.type())), ctx.type())),
ctx);
case LE:
case GE:
case GT:
case LT:
case IN:
case NOT_IN:
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
default:
throw createParsingFailedException("Unsupported relational expression: " + ctx.getText(), ctx);
}
}
@Override
public Expression visitEqualityExprAlt(EqualityExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitRegexExprAlt(RegexExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitAndExprAlt(AndExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitExclusiveOrExprAlt(ExclusiveOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitInclusiveOrExprAlt(InclusiveOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitLogicalAndExprAlt(LogicalAndExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public BinaryExpression visitLogicalOrExprAlt(LogicalOrExprAltContext ctx) {
return this.configureAST(
this.createBinaryExpression(ctx.left, ctx.op, ctx.right),
ctx);
}
@Override
public Expression visitConditionalExprAlt(ConditionalExprAltContext ctx) {
if (asBoolean(ctx.ELVIS())) { // e.g. a == 6 ?: 0
return this.configureAST(
new ElvisOperatorExpression((Expression) this.visit(ctx.con), (Expression) this.visit(ctx.fb)),
ctx);
}
return this.configureAST(
new TernaryExpression(
this.configureAST(new BooleanExpression((Expression) this.visit(ctx.con)),
ctx.con),
(Expression) this.visit(ctx.tb),
(Expression) this.visit(ctx.fb)),
ctx);
}
@Override
public BinaryExpression visitMultipleAssignmentExprAlt(MultipleAssignmentExprAltContext ctx) {
return this.configureAST(
new BinaryExpression(
this.visitVariableNames(ctx.left),
this.createGroovyToken(ctx.op),
((ExpressionStatement) this.visit(ctx.right)).getExpression()),
ctx);
}
@Override
public BinaryExpression visitAssignmentExprAlt(AssignmentExprAltContext ctx) {
Expression leftExpr = (Expression) this.visit(ctx.left);
if (leftExpr instanceof VariableExpression
&& isTrue(leftExpr, IS_INSIDE_PARENTHESES)) { // it is a special multiple assignment whose variable count is only one, e.g. (a) = [1]
if ((Integer) leftExpr.getNodeMetaData(INSIDE_PARENTHESES_LEVEL) > 1) {
throw createParsingFailedException("Nested parenthesis is not allowed in multiple assignment, e.g. ((a)) = b", ctx);
}
return this.configureAST(
new BinaryExpression(
this.configureAST(new TupleExpression(leftExpr), ctx.left),
this.createGroovyToken(ctx.op),
asBoolean(ctx.statementExpression())
? ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression()
: this.visitStandardLambda(ctx.standardLambda())),
ctx);
}
// the LHS expression should be a variable which is not inside any parentheses
if (
!(
(leftExpr instanceof VariableExpression
// && !(THIS_STR.equals(leftExpr.getText()) || SUPER_STR.equals(leftExpr.getText())) // commented, e.g. this = value // this will be transformed to $this
&& !isTrue(leftExpr, IS_INSIDE_PARENTHESES)) // e.g. p = 123
|| leftExpr instanceof PropertyExpression // e.g. obj.p = 123
|| (leftExpr instanceof BinaryExpression
// && !(((BinaryExpression) leftExpr).getRightExpression() instanceof ListExpression) // commented, e.g. list[1, 2] = [11, 12]
&& Types.LEFT_SQUARE_BRACKET == ((BinaryExpression) leftExpr).getOperation().getType()) // e.g. map[a] = 123 OR map['a'] = 123 OR map["$a"] = 123
)
) {
throw createParsingFailedException("The LHS of an assignment should be a variable or a field accessing expression", ctx);
}
return this.configureAST(
new BinaryExpression(
leftExpr,
this.createGroovyToken(ctx.op),
asBoolean(ctx.statementExpression())
? ((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression()
: this.visitStandardLambda(ctx.standardLambda())),
ctx);
}
// } expression --------------------------------------------------------------------
// primary { --------------------------------------------------------------------
@Override
public VariableExpression visitIdentifierPrmrAlt(IdentifierPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(this.visitIdentifier(ctx.identifier())), ctx);
}
@Override
public ConstantExpression visitLiteralPrmrAlt(LiteralPrmrAltContext ctx) {
return this.configureAST((ConstantExpression) this.visit(ctx.literal()), ctx);
}
@Override
public GStringExpression visitGstringPrmrAlt(GstringPrmrAltContext ctx) {
return this.configureAST((GStringExpression) this.visit(ctx.gstring()), ctx);
}
@Override
public Expression visitNewPrmrAlt(NewPrmrAltContext ctx) {
return this.configureAST(this.visitCreator(ctx.creator()), ctx);
}
@Override
public VariableExpression visitThisPrmrAlt(ThisPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(ctx.THIS().getText()), ctx);
}
@Override
public VariableExpression visitSuperPrmrAlt(SuperPrmrAltContext ctx) {
return this.configureAST(new VariableExpression(ctx.SUPER().getText()), ctx);
}
@Override
public Expression visitParenPrmrAlt(ParenPrmrAltContext ctx) {
return this.configureAST(this.visitParExpression(ctx.parExpression()), ctx);
}
@Override
public ClosureExpression visitClosurePrmrAlt(ClosurePrmrAltContext ctx) {
return this.configureAST(this.visitClosure(ctx.closure()), ctx);
}
@Override
public ClosureExpression visitLambdaPrmrAlt(LambdaPrmrAltContext ctx) {
return this.configureAST(this.visitStandardLambda(ctx.standardLambda()), ctx);
}
@Override
public ListExpression visitListPrmrAlt(ListPrmrAltContext ctx) {
return this.configureAST(
this.visitList(ctx.list()),
ctx);
}
@Override
public MapExpression visitMapPrmrAlt(MapPrmrAltContext ctx) {
return this.configureAST(this.visitMap(ctx.map()), ctx);
}
@Override
public VariableExpression visitTypePrmrAlt(TypePrmrAltContext ctx) {
return this.configureAST(
this.visitBuiltInType(ctx.builtInType()),
ctx);
}
// } primary --------------------------------------------------------------------
@Override
public Expression visitCreator(CreatorContext ctx) {
ClassNode classNode = this.visitCreatedName(ctx.createdName());
Expression arguments = this.visitArguments(ctx.arguments());
if (asBoolean(ctx.arguments())) { // create instance of class
if (asBoolean(ctx.anonymousInnerClassDeclaration())) {
ctx.anonymousInnerClassDeclaration().putNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS, classNode);
InnerClassNode anonymousInnerClassNode = this.visitAnonymousInnerClassDeclaration(ctx.anonymousInnerClassDeclaration());
List<InnerClassNode> anonymousInnerClassList = anonymousInnerClassesDefinedInMethodStack.peek();
if (asBoolean((Object) anonymousInnerClassList)) { // if the anonymous class is created in a script, no anonymousInnerClassList is available.
anonymousInnerClassList.add(anonymousInnerClassNode);
}
ConstructorCallExpression constructorCallExpression = new ConstructorCallExpression(anonymousInnerClassNode, arguments);
constructorCallExpression.setUsingAnonymousInnerClass(true);
return this.configureAST(constructorCallExpression, ctx);
}
return this.configureAST(
new ConstructorCallExpression(classNode, arguments),
ctx);
}
if (asBoolean(ctx.LBRACK())) { // create array
if (asBoolean(ctx.arrayInitializer())) {
ClassNode arrayType = classNode;
for (int i = 0, n = ctx.b.size() - 1; i < n; i++) {
arrayType = arrayType.makeArray();
}
return this.configureAST(
new ArrayExpression(
arrayType,
this.visitArrayInitializer(ctx.arrayInitializer())),
ctx);
} else {
Expression[] empties;
if (asBoolean(ctx.b)) {
empties = new Expression[ctx.b.size()];
Arrays.setAll(empties, i -> ConstantExpression.EMPTY_EXPRESSION);
} else {
empties = new Expression[0];
}
return this.configureAST(
new ArrayExpression(
classNode,
null,
Stream.concat(
ctx.expression().stream()
.map(e -> (Expression) this.visit(e)),
Arrays.stream(empties)
).collect(Collectors.toList())),
ctx);
}
}
throw createParsingFailedException("Unsupported creator: " + ctx.getText(), ctx);
}
private String genAnonymousClassName(String outerClassName) {
return outerClassName + "$" + this.anonymousInnerClassCounter++;
}
@Override
public InnerClassNode visitAnonymousInnerClassDeclaration(AnonymousInnerClassDeclarationContext ctx) {
ClassNode superClass = ctx.getNodeMetaData(ANONYMOUS_INNER_CLASS_SUPER_CLASS);
Objects.requireNonNull(superClass, "superClass should not be null");
InnerClassNode anonymousInnerClass;
ClassNode outerClass = this.classNodeStack.peek();
outerClass = asBoolean(outerClass) ? outerClass : moduleNode.getScriptClassDummy();
String fullName = this.genAnonymousClassName(outerClass.getName());
if (1 == ctx.t) { // anonymous enum
anonymousInnerClass = new EnumConstantClassNode(outerClass, fullName, superClass.getModifiers() | Opcodes.ACC_FINAL, superClass.getPlainNodeReference());
// and remove the final modifier from classNode to allow the sub class
superClass.setModifiers(superClass.getModifiers() & ~Opcodes.ACC_FINAL);
} else { // anonymous inner class
anonymousInnerClass = new InnerClassNode(outerClass, fullName, Opcodes.ACC_PUBLIC, superClass);
}
anonymousInnerClass.setUsingGenerics(false);
anonymousInnerClass.setAnonymous(true);
this.configureAST(anonymousInnerClass, ctx);
classNodeStack.push(anonymousInnerClass);
ctx.classBody().putNodeMetaData(CLASS_DECLARATION_CLASS_NODE, anonymousInnerClass);
this.visitClassBody(ctx.classBody());
classNodeStack.pop();
classNodeList.add(anonymousInnerClass);
return anonymousInnerClass;
}
@Override
public ClassNode visitCreatedName(CreatedNameContext ctx) {
if (asBoolean(ctx.qualifiedClassName())) {
ClassNode classNode = this.visitQualifiedClassName(ctx.qualifiedClassName());
if (asBoolean(ctx.typeArgumentsOrDiamond())) {
classNode.setGenericsTypes(
this.visitTypeArgumentsOrDiamond(ctx.typeArgumentsOrDiamond()));
}
return this.configureAST(classNode, ctx);
}
if (asBoolean(ctx.primitiveType())) {
return this.configureAST(
this.visitPrimitiveType(ctx.primitiveType()),
ctx);
}
throw createParsingFailedException("Unsupported created name: " + ctx.getText(), ctx);
}
@Override
public MapExpression visitMap(MapContext ctx) {
return this.configureAST(
new MapExpression(this.visitMapEntryList(ctx.mapEntryList())),
ctx);
}
@Override
public List<MapEntryExpression> visitMapEntryList(MapEntryListContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.createMapEntryList(ctx.mapEntry());
}
private List<MapEntryExpression> createMapEntryList(List<? extends MapEntryContext> mapEntryContextList) {
if (!asBoolean(mapEntryContextList)) {
return Collections.emptyList();
}
return mapEntryContextList.stream()
.map(this::visitMapEntry)
.collect(Collectors.toList());
}
@Override
public MapEntryExpression visitMapEntry(MapEntryContext ctx) {
Expression keyExpr;
Expression valueExpr = (Expression) this.visit(ctx.expression());
if (asBoolean(ctx.MUL())) {
keyExpr = this.configureAST(new SpreadMapExpression(valueExpr), ctx);
} else if (asBoolean(ctx.mapEntryLabel())) {
keyExpr = this.visitMapEntryLabel(ctx.mapEntryLabel());
} else {
throw createParsingFailedException("Unsupported map entry: " + ctx.getText(), ctx);
}
return this.configureAST(
new MapEntryExpression(keyExpr, valueExpr),
ctx);
}
@Override
public Expression visitMapEntryLabel(MapEntryLabelContext ctx) {
if (asBoolean(ctx.keywords())) {
return this.configureAST(this.visitKeywords(ctx.keywords()), ctx);
} else if (asBoolean(ctx.primary())) {
Expression expression = (Expression) this.visit(ctx.primary());
// if the key is variable and not inside parentheses, convert it to a constant, e.g. [a:1, b:2]
if (expression instanceof VariableExpression && !isTrue(expression, IS_INSIDE_PARENTHESES)) {
expression =
this.configureAST(
new ConstantExpression(((VariableExpression) expression).getName()),
expression);
}
return this.configureAST(expression, ctx);
}
throw createParsingFailedException("Unsupported map entry label: " + ctx.getText(), ctx);
}
@Override
public ConstantExpression visitKeywords(KeywordsContext ctx) {
return this.configureAST(new ConstantExpression(ctx.getText()), ctx);
}
/*
@Override
public VariableExpression visitIdentifier(IdentifierContext ctx) {
return this.configureAST(new VariableExpression(ctx.getText()), ctx);
}
*/
@Override
public VariableExpression visitBuiltInType(BuiltInTypeContext ctx) {
String text;
if (asBoolean(ctx.VOID())) {
text = ctx.VOID().getText();
} else if (asBoolean(ctx.BuiltInPrimitiveType())) {
text = ctx.BuiltInPrimitiveType().getText();
} else {
throw createParsingFailedException("Unsupported built-in type: " + ctx, ctx);
}
return this.configureAST(new VariableExpression(text), ctx);
}
@Override
public ListExpression visitList(ListContext ctx) {
return this.configureAST(
new ListExpression(
this.visitExpressionList(ctx.expressionList())),
ctx);
}
@Override
public List<Expression> visitExpressionList(ExpressionListContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return this.createExpressionList(ctx.expressionListElement());
}
private List<Expression> createExpressionList(List<? extends ExpressionListElementContext> expressionListElementContextList) {
if (!asBoolean(expressionListElementContextList)) {
return Collections.emptyList();
}
return expressionListElementContextList.stream()
.map(this::visitExpressionListElement)
.collect(Collectors.toList());
}
@Override
public Expression visitExpressionListElement(ExpressionListElementContext ctx) {
Expression expression = (Expression) this.visit(ctx.expression());
if (asBoolean(ctx.MUL())) {
return this.configureAST(new SpreadExpression(expression), ctx);
}
return this.configureAST(expression, ctx);
}
// literal { --------------------------------------------------------------------
@Override
public ConstantExpression visitIntegerLiteralAlt(IntegerLiteralAltContext ctx) {
String text = ctx.IntegerLiteral().getText();
ConstantExpression constantExpression = new ConstantExpression(Numbers.parseInteger(null, text), !text.startsWith(SUB_STR));
constantExpression.putNodeMetaData(IS_NUMERIC, true);
constantExpression.putNodeMetaData(INTEGER_LITERAL_TEXT, text);
return this.configureAST(constantExpression, ctx);
}
@Override
public ConstantExpression visitFloatingPointLiteralAlt(FloatingPointLiteralAltContext ctx) {
String text = ctx.FloatingPointLiteral().getText();
ConstantExpression constantExpression = new ConstantExpression(Numbers.parseDecimal(text), !text.startsWith(SUB_STR));
constantExpression.putNodeMetaData(IS_NUMERIC, true);
constantExpression.putNodeMetaData(FLOATING_POINT_LITERAL_TEXT, text);
return this.configureAST(constantExpression, ctx);
}
@Override
public ConstantExpression visitStringLiteralAlt(StringLiteralAltContext ctx) {
return this.configureAST(
this.visitStringLiteral(ctx.stringLiteral()),
ctx);
}
@Override
public ConstantExpression visitBooleanLiteralAlt(BooleanLiteralAltContext ctx) {
return this.configureAST(new ConstantExpression("true".equals(ctx.BooleanLiteral().getText()), true), ctx);
}
@Override
public ConstantExpression visitNullLiteralAlt(NullLiteralAltContext ctx) {
return this.configureAST(new ConstantExpression(null), ctx);
}
// } literal --------------------------------------------------------------------
// gstring { --------------------------------------------------------------------
@Override
public GStringExpression visitGstring(GstringContext ctx) {
List<ConstantExpression> strings = new LinkedList<>();
String begin = ctx.GStringBegin().getText();
final int slashyType = begin.startsWith("/")
? StringUtils.SLASHY
: begin.startsWith("$/") ? StringUtils.DOLLAR_SLASHY : StringUtils.NONE_SLASHY;
{
String it = begin;
if (it.startsWith("\"\"\"")) {
it = StringUtils.removeCR(it);
it = it.substring(2); // translate leading """ to "
} else if (it.startsWith("$/")) {
it = StringUtils.removeCR(it);
it = "\"" + it.substring(2); // translate leading $/ to "
} else if (it.startsWith("/")) {
it = StringUtils.removeCR(it);
}
it = StringUtils.replaceEscapes(it, slashyType);
it = (it.length() == 2)
? ""
: StringGroovyMethods.getAt(it, new IntRange(true, 1, -2));
strings.add(this.configureAST(new ConstantExpression(it), ctx.GStringBegin()));
}
List<ConstantExpression> partStrings =
ctx.GStringPart().stream()
.map(e -> {
String it = e.getText();
it = StringUtils.removeCR(it);
it = StringUtils.replaceEscapes(it, slashyType);
it = it.length() == 1 ? "" : StringGroovyMethods.getAt(it, new IntRange(true, 0, -2));
return this.configureAST(new ConstantExpression(it), e);
}).collect(Collectors.toList());
strings.addAll(partStrings);
{
String it = ctx.GStringEnd().getText();
if (it.endsWith("\"\"\"")) {
it = StringUtils.removeCR(it);
it = StringGroovyMethods.getAt(it, new IntRange(true, 0, -3)); // translate tailing """ to "
} else if (it.endsWith("/$")) {
it = StringUtils.removeCR(it);
it = StringGroovyMethods.getAt(it, new IntRange(false, 0, -2)) + "\""; // translate tailing /$ to "
} else if (it.endsWith("/")) {
it = StringUtils.removeCR(it);
}
it = StringUtils.replaceEscapes(it, slashyType);
it = (it.length() == 1)
? ""
: StringGroovyMethods.getAt(it, new IntRange(true, 0, -2));
strings.add(this.configureAST(new ConstantExpression(it), ctx.GStringEnd()));
}
List<Expression> values = ctx.gstringValue().stream()
.map(e -> {
Expression expression = this.visitGstringValue(e);
if (expression instanceof ClosureExpression && !asBoolean(e.closure().ARROW())) {
List<Statement> statementList = ((BlockStatement) ((ClosureExpression) expression).getCode()).getStatements();
if (statementList.stream().allMatch(x -> !asBoolean(x))) {
return this.configureAST(new ConstantExpression(null), e);
}
return this.configureAST(new MethodCallExpression(expression, CALL_STR, new ArgumentListExpression()), e);
}
return expression;
})
.collect(Collectors.toList());
StringBuilder verbatimText = new StringBuilder(ctx.getText().length());
for (int i = 0, n = strings.size(), s = values.size(); i < n; i++) {
verbatimText.append(strings.get(i).getValue());
if (i == s) {
continue;
}
Expression value = values.get(i);
if (!asBoolean(value)) {
continue;
}
verbatimText.append(DOLLAR_STR);
verbatimText.append(value.getText());
}
return this.configureAST(new GStringExpression(verbatimText.toString(), strings, values), ctx);
}
@Override
public Expression visitGstringValue(GstringValueContext ctx) {
if (asBoolean(ctx.gstringPath())) {
return this.configureAST(this.visitGstringPath(ctx.gstringPath()), ctx);
}
if (asBoolean(ctx.LBRACE())) {
if (asBoolean(ctx.statementExpression())) {
return this.configureAST(((ExpressionStatement) this.visit(ctx.statementExpression())).getExpression(), ctx.statementExpression());
} else { // e.g. "${}"
return this.configureAST(new ConstantExpression(null), ctx);
}
}
if (asBoolean(ctx.closure())) {
return this.configureAST(this.visitClosure(ctx.closure()), ctx);
}
throw createParsingFailedException("Unsupported gstring value: " + ctx.getText(), ctx);
}
@Override
public Expression visitGstringPath(GstringPathContext ctx) {
VariableExpression variableExpression = new VariableExpression(this.visitIdentifier(ctx.identifier()));
if (asBoolean(ctx.GStringPathPart())) {
Expression propertyExpression = ctx.GStringPathPart().stream()
.map(e -> this.configureAST((Expression) new ConstantExpression(e.getText().substring(1)), e))
.reduce(this.configureAST(variableExpression, ctx.identifier()), (r, e) -> this.configureAST(new PropertyExpression(r, e), e));
return this.configureAST(propertyExpression, ctx);
}
return this.configureAST(variableExpression, ctx);
}
// } gstring --------------------------------------------------------------------
@Override
public LambdaExpression visitStandardLambda(StandardLambdaContext ctx) {
return this.configureAST(this.createLambda(ctx.standardLambdaParameters(), ctx.lambdaBody()), ctx);
}
private LambdaExpression createLambda(StandardLambdaParametersContext standardLambdaParametersContext, LambdaBodyContext lambdaBodyContext) {
return new LambdaExpression(
this.visitStandardLambdaParameters(standardLambdaParametersContext),
this.visitLambdaBody(lambdaBodyContext));
}
@Override
public Parameter[] visitStandardLambdaParameters(StandardLambdaParametersContext ctx) {
if (asBoolean(ctx.variableDeclaratorId())) {
return new Parameter[]{
this.configureAST(
new Parameter(
ClassHelper.OBJECT_TYPE,
this.visitVariableDeclaratorId(ctx.variableDeclaratorId()).getName()
),
ctx.variableDeclaratorId()
)
};
}
Parameter[] parameters = this.visitFormalParameters(ctx.formalParameters());
if (0 == parameters.length) {
return null;
}
return parameters;
}
@Override
public Statement visitLambdaBody(LambdaBodyContext ctx) {
if (asBoolean(ctx.statementExpression())) {
return this.configureAST((ExpressionStatement) this.visit(ctx.statementExpression()), ctx);
}
if (asBoolean(ctx.block())) {
return this.configureAST(this.visitBlock(ctx.block()), ctx);
}
throw createParsingFailedException("Unsupported lambda body: " + ctx.getText(), ctx);
}
@Override
public ClosureExpression visitClosure(ClosureContext ctx) {
Parameter[] parameters = asBoolean(ctx.formalParameterList())
? this.visitFormalParameterList(ctx.formalParameterList())
: null;
if (!asBoolean(ctx.ARROW())) {
parameters = Parameter.EMPTY_ARRAY;
}
Statement code = this.visitBlockStatementsOpt(ctx.blockStatementsOpt());
return this.configureAST(new ClosureExpression(parameters, code), ctx);
}
@Override
public Parameter[] visitFormalParameters(FormalParametersContext ctx) {
if (!asBoolean(ctx)) {
return new Parameter[0];
}
return this.visitFormalParameterList(ctx.formalParameterList());
}
@Override
public Parameter[] visitFormalParameterList(FormalParameterListContext ctx) {
if (!asBoolean(ctx)) {
return new Parameter[0];
}
List<Parameter> parameterList = new LinkedList<>();
if (asBoolean(ctx.formalParameter())) {
parameterList.addAll(
ctx.formalParameter().stream()
.map(this::visitFormalParameter)
.collect(Collectors.toList()));
}
if (asBoolean(ctx.lastFormalParameter())) {
parameterList.add(this.visitLastFormalParameter(ctx.lastFormalParameter()));
}
return parameterList.toArray(new Parameter[0]);
}
@Override
public Parameter visitFormalParameter(FormalParameterContext ctx) {
return this.processFormalParameter(ctx, ctx.variableModifiersOpt(), ctx.type(), null, ctx.variableDeclaratorId(), ctx.expression());
}
@Override
public Parameter visitLastFormalParameter(LastFormalParameterContext ctx) {
return this.processFormalParameter(ctx, ctx.variableModifiersOpt(), ctx.type(), ctx.ELLIPSIS(), ctx.variableDeclaratorId(), ctx.expression());
}
@Override
public List<ModifierNode> visitClassOrInterfaceModifiersOpt(ClassOrInterfaceModifiersOptContext ctx) {
if (asBoolean(ctx.classOrInterfaceModifiers())) {
return this.visitClassOrInterfaceModifiers(ctx.classOrInterfaceModifiers());
}
return Collections.emptyList();
}
@Override
public List<ModifierNode> visitClassOrInterfaceModifiers(ClassOrInterfaceModifiersContext ctx) {
return ctx.classOrInterfaceModifier().stream()
.map(this::visitClassOrInterfaceModifier)
.collect(Collectors.toList());
}
@Override
public ModifierNode visitClassOrInterfaceModifier(ClassOrInterfaceModifierContext ctx) {
if (asBoolean(ctx.annotation())) {
return this.configureAST(new ModifierNode(this.visitAnnotation(ctx.annotation()), ctx.getText()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported class or interface modifier: " + ctx.getText(), ctx);
}
@Override
public ModifierNode visitModifier(ModifierContext ctx) {
if (asBoolean(ctx.classOrInterfaceModifier())) {
return this.configureAST(this.visitClassOrInterfaceModifier(ctx.classOrInterfaceModifier()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported modifier: " + ctx.getText(), ctx);
}
@Override
public List<ModifierNode> visitModifiers(ModifiersContext ctx) {
return ctx.modifier().stream()
.map(this::visitModifier)
.collect(Collectors.toList());
}
@Override
public List<ModifierNode> visitModifiersOpt(ModifiersOptContext ctx) {
if (asBoolean(ctx.modifiers())) {
return this.visitModifiers(ctx.modifiers());
}
return Collections.emptyList();
}
@Override
public ModifierNode visitVariableModifier(VariableModifierContext ctx) {
if (asBoolean(ctx.annotation())) {
return this.configureAST(new ModifierNode(this.visitAnnotation(ctx.annotation()), ctx.getText()), ctx);
}
if (asBoolean(ctx.m)) {
return this.configureAST(new ModifierNode(ctx.m.getType(), ctx.getText()), ctx);
}
throw createParsingFailedException("Unsupported variable modifier", ctx);
}
@Override
public List<ModifierNode> visitVariableModifiersOpt(VariableModifiersOptContext ctx) {
if (asBoolean(ctx.variableModifiers())) {
return this.visitVariableModifiers(ctx.variableModifiers());
}
return Collections.emptyList();
}
@Override
public List<ModifierNode> visitVariableModifiers(VariableModifiersContext ctx) {
return ctx.variableModifier().stream()
.map(this::visitVariableModifier)
.collect(Collectors.toList());
}
// type { --------------------------------------------------------------------
@Override
public ClassNode visitType(TypeContext ctx) {
if (!asBoolean(ctx)) {
return ClassHelper.OBJECT_TYPE;
}
ClassNode classNode = null;
if (asBoolean(ctx.classOrInterfaceType())) {
ctx.classOrInterfaceType().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitClassOrInterfaceType(ctx.classOrInterfaceType());
}
if (asBoolean(ctx.primitiveType())) {
classNode = this.visitPrimitiveType(ctx.primitiveType());
}
if (asBoolean(ctx.LBRACK())) {
// clear array's generics type info. Groovy's bug? array's generics type will be ignored. e.g. List<String>[]... p
classNode.setGenericsTypes(null);
classNode.setUsingGenerics(false);
for (int i = 0, n = ctx.LBRACK().size(); i < n; i++) {
classNode = this.configureAST(classNode.makeArray(), classNode);
}
}
if (!asBoolean(classNode)) {
throw createParsingFailedException("Unsupported type: " + ctx.getText(), ctx);
}
return this.configureAST(classNode, ctx);
}
@Override
public ClassNode visitClassOrInterfaceType(ClassOrInterfaceTypeContext ctx) {
ClassNode classNode;
if (asBoolean(ctx.qualifiedClassName())) {
ctx.qualifiedClassName().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitQualifiedClassName(ctx.qualifiedClassName());
} else {
ctx.qualifiedStandardClassName().putNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR, ctx.getNodeMetaData(IS_INSIDE_INSTANCEOF_EXPR));
classNode = this.visitQualifiedStandardClassName(ctx.qualifiedStandardClassName());
}
if (asBoolean(ctx.typeArguments())) {
classNode.setGenericsTypes(
this.visitTypeArguments(ctx.typeArguments()));
}
return this.configureAST(classNode, ctx);
}
@Override
public GenericsType[] visitTypeArgumentsOrDiamond(TypeArgumentsOrDiamondContext ctx) {
if (asBoolean(ctx.typeArguments())) {
return this.visitTypeArguments(ctx.typeArguments());
}
if (asBoolean(ctx.LT())) { // e.g. <>
return new GenericsType[0];
}
throw createParsingFailedException("Unsupported type arguments or diamond: " + ctx.getText(), ctx);
}
@Override
public GenericsType[] visitTypeArguments(TypeArgumentsContext ctx) {
return ctx.typeArgument().stream().map(this::visitTypeArgument).toArray(GenericsType[]::new);
}
@Override
public GenericsType visitTypeArgument(TypeArgumentContext ctx) {
if (asBoolean(ctx.QUESTION())) {
ClassNode baseType = this.configureAST(ClassHelper.makeWithoutCaching(QUESTION_STR), ctx.QUESTION());
if (!asBoolean(ctx.type())) {
GenericsType genericsType = new GenericsType(baseType);
genericsType.setWildcard(true);
genericsType.setName(QUESTION_STR);
return this.configureAST(genericsType, ctx);
}
ClassNode[] upperBounds = null;
ClassNode lowerBound = null;
ClassNode classNode = this.visitType(ctx.type());
if (asBoolean(ctx.EXTENDS())) {
upperBounds = new ClassNode[]{classNode};
} else if (asBoolean(ctx.SUPER())) {
lowerBound = classNode;
}
GenericsType genericsType = new GenericsType(baseType, upperBounds, lowerBound);
genericsType.setWildcard(true);
genericsType.setName(QUESTION_STR);
return this.configureAST(genericsType, ctx);
} else if (asBoolean(ctx.type())) {
return this.configureAST(
this.createGenericsType(
this.visitType(ctx.type())),
ctx);
}
throw createParsingFailedException("Unsupported type argument: " + ctx.getText(), ctx);
}
@Override
public ClassNode visitPrimitiveType(PrimitiveTypeContext ctx) {
return this.configureAST(ClassHelper.make(ctx.getText()), ctx);
}
// } type --------------------------------------------------------------------
@Override
public VariableExpression visitVariableDeclaratorId(VariableDeclaratorIdContext ctx) {
return this.configureAST(new VariableExpression(this.visitIdentifier(ctx.identifier())), ctx);
}
@Override
public TupleExpression visitVariableNames(VariableNamesContext ctx) {
return this.configureAST(
new TupleExpression(
ctx.variableDeclaratorId().stream()
.map(this::visitVariableDeclaratorId)
.collect(Collectors.toList())
),
ctx);
}
@Override
public BlockStatement visitBlockStatementsOpt(BlockStatementsOptContext ctx) {
if (asBoolean(ctx.blockStatements())) {
return this.configureAST(this.visitBlockStatements(ctx.blockStatements()), ctx);
}
return this.configureAST(this.createBlockStatement(), ctx);
}
@Override
public BlockStatement visitBlockStatements(BlockStatementsContext ctx) {
return this.configureAST(
this.createBlockStatement(
ctx.blockStatement().stream()
.map(this::visitBlockStatement)
.filter(e -> asBoolean(e))
.collect(Collectors.toList())),
ctx);
}
@Override
public Statement visitBlockStatement(BlockStatementContext ctx) {
if (asBoolean(ctx.localVariableDeclaration())) {
return this.configureAST(this.visitLocalVariableDeclaration(ctx.localVariableDeclaration()), ctx);
}
if (asBoolean(ctx.statement())) {
Object astNode = this.visit(ctx.statement()); //this.configureAST((Statement) this.visit(ctx.statement()), ctx);
if (astNode instanceof MethodNode) {
throw createParsingFailedException("Method definition not expected here", ctx);
} else {
return (Statement) astNode;
}
}
throw createParsingFailedException("Unsupported block statement: " + ctx.getText(), ctx);
}
@Override
public List<AnnotationNode> visitAnnotationsOpt(AnnotationsOptContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
return ctx.annotation().stream()
.map(this::visitAnnotation)
.collect(Collectors.toList());
}
@Override
public AnnotationNode visitAnnotation(AnnotationContext ctx) {
String annotationName = this.visitAnnotationName(ctx.annotationName());
AnnotationNode annotationNode = new AnnotationNode(ClassHelper.make(annotationName));
List<Pair<String, Expression>> annotationElementValues = this.visitElementValues(ctx.elementValues());
annotationElementValues.forEach(e -> annotationNode.addMember(e.getKey(), e.getValue()));
return this.configureAST(annotationNode, ctx);
}
@Override
public List<Pair<String, Expression>> visitElementValues(ElementValuesContext ctx) {
if (!asBoolean(ctx)) {
return Collections.emptyList();
}
List<Pair<String, Expression>> annotationElementValues = new LinkedList<>();
if (asBoolean(ctx.elementValuePairs())) {
this.visitElementValuePairs(ctx.elementValuePairs()).entrySet().forEach(e -> {
annotationElementValues.add(new Pair<>(e.getKey(), e.getValue()));
});
} else if (asBoolean(ctx.elementValue())) {
annotationElementValues.add(new Pair<>(VALUE_STR, this.visitElementValue(ctx.elementValue())));
}
return annotationElementValues;
}
@Override
public String visitAnnotationName(AnnotationNameContext ctx) {
return this.visitQualifiedClassName(ctx.qualifiedClassName()).getName();
}
@Override
public Map<String, Expression> visitElementValuePairs(ElementValuePairsContext ctx) {
return ctx.elementValuePair().stream()
.map(this::visitElementValuePair)
.collect(Collectors.toMap(
Pair::getKey,
Pair::getValue,
(k, v) -> {
throw new IllegalStateException(String.format("Duplicate key %s", k));
},
LinkedHashMap::new
));
}
@Override
public Pair<String, Expression> visitElementValuePair(ElementValuePairContext ctx) {
return new Pair<>(ctx.elementValuePairName().getText(), this.visitElementValue(ctx.elementValue()));
}
@Override
public Expression visitElementValue(ElementValueContext ctx) {
if (asBoolean(ctx.expression())) {
return this.configureAST((Expression) this.visit(ctx.expression()), ctx);
}
if (asBoolean(ctx.annotation())) {
return this.configureAST(new AnnotationConstantExpression(this.visitAnnotation(ctx.annotation())), ctx);
}
if (asBoolean(ctx.elementValueArrayInitializer())) {
return this.configureAST(this.visitElementValueArrayInitializer(ctx.elementValueArrayInitializer()), ctx);
}
throw createParsingFailedException("Unsupported element value: " + ctx.getText(), ctx);
}
@Override
public ListExpression visitElementValueArrayInitializer(ElementValueArrayInitializerContext ctx) {
return this.configureAST(new ListExpression(ctx.elementValue().stream().map(this::visitElementValue).collect(Collectors.toList())), ctx);
}
@Override
public String visitClassName(ClassNameContext ctx) {
String text = ctx.getText();
if (!text.contains("\\")) {
return text;
}
return StringUtils.replaceHexEscapes(text);
}
@Override
public String visitIdentifier(IdentifierContext ctx) {
String text = ctx.getText();
if (!text.contains("\\")) {
return text;
}
return StringUtils.replaceHexEscapes(text);
}
@Override
public String visitQualifiedName(QualifiedNameContext ctx) {
return ctx.qualifiedNameElement().stream()
.map(ParseTree::getText)
.collect(Collectors.joining(DOT_STR));
}
@Override
public ClassNode[] visitQualifiedClassNameList(QualifiedClassNameListContext ctx) {
if (!asBoolean(ctx)) {
return new ClassNode[0];
}
return ctx.qualifiedClassName().stream()
.map(this::visitQualifiedClassName)
.toArray(ClassNode[]::new);
}
@Override
public ClassNode visitQualifiedClassName(QualifiedClassNameContext ctx) {
return this.createClassNode(ctx);
}
@Override
public ClassNode visitQualifiedStandardClassName(QualifiedStandardClassNameContext ctx) {
return this.createClassNode(ctx);
}
private ClassNode createClassNode(GroovyParserRuleContext ctx) {
ClassNode result = ClassHelper.make(ctx.getText());
if (!isTrue(ctx, IS_INSIDE_INSTANCEOF_EXPR)) { // type in the "instanceof" expression should not have proxy to redirect to it
result = this.proxyClassNode(result);
}
return this.configureAST(result, ctx);
}
private ClassNode proxyClassNode(ClassNode classNode) {
if (!classNode.isUsingGenerics()) {
return classNode;
}
ClassNode cn = ClassHelper.makeWithoutCaching(classNode.getName());
cn.setRedirect(classNode);
return cn;
}
/**
* Visit tree safely, no NPE occurred when the tree is null.
*
* @param tree an AST node
* @return the visiting result
*/
@Override
public Object visit(ParseTree tree) {
if (!asBoolean(tree)) {
return null;
}
return super.visit(tree);
}
// e.g. obj.a(1, 2) or obj.a 1, 2
private MethodCallExpression createMethodCallExpression(PropertyExpression propertyExpression, Expression arguments) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
propertyExpression.getObjectExpression(),
propertyExpression.getProperty(),
arguments
);
methodCallExpression.setImplicitThis(false);
methodCallExpression.setSafe(propertyExpression.isSafe());
methodCallExpression.setSpreadSafe(propertyExpression.isSpreadSafe());
// method call obj*.m(): "safe"(false) and "spreadSafe"(true)
// property access obj*.p: "safe"(true) and "spreadSafe"(true)
// so we have to reset safe here.
if (propertyExpression.isSpreadSafe()) {
methodCallExpression.setSafe(false);
}
// if the generics types meta data is not empty, it is a generic method call, e.g. obj.<Integer>a(1, 2)
methodCallExpression.setGenericsTypes(
propertyExpression.getNodeMetaData(PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES));
return methodCallExpression;
}
// e.g. m(1, 2) or m 1, 2
private MethodCallExpression createMethodCallExpression(Expression baseExpr, Expression arguments) {
MethodCallExpression methodCallExpression =
new MethodCallExpression(
VariableExpression.THIS_EXPRESSION,
(baseExpr instanceof VariableExpression)
? this.createConstantExpression((VariableExpression) baseExpr)
: baseExpr,
arguments
);
return methodCallExpression;
}
private Parameter processFormalParameter(GroovyParserRuleContext ctx,
VariableModifiersOptContext variableModifiersOptContext,
TypeContext typeContext,
TerminalNode ellipsis,
VariableDeclaratorIdContext variableDeclaratorIdContext,
ExpressionContext expressionContext) {
ClassNode classNode = this.visitType(typeContext);
if (asBoolean(ellipsis)) {
classNode = this.configureAST(classNode.makeArray(), classNode);
}
Parameter parameter =
new ModifierManager(this, this.visitVariableModifiersOpt(variableModifiersOptContext))
.processParameter(
this.configureAST(
new Parameter(classNode, this.visitVariableDeclaratorId(variableDeclaratorIdContext).getName()),
ctx)
);
if (asBoolean(expressionContext)) {
parameter.setInitialExpression((Expression) this.visit(expressionContext));
}
return parameter;
}
private Expression createPathExpression(Expression primaryExpr, List<? extends PathElementContext> pathElementContextList) {
return (Expression) pathElementContextList.stream()
.map(e -> (Object) e)
.reduce(primaryExpr,
(r, e) -> {
PathElementContext pathElementContext = (PathElementContext) e;
pathElementContext.putNodeMetaData(PATH_EXPRESSION_BASE_EXPR, r);
return this.visitPathElement(pathElementContext);
}
);
}
private GenericsType createGenericsType(ClassNode classNode) {
return this.configureAST(new GenericsType(classNode), classNode);
}
private ConstantExpression createConstantExpression(Expression expression) {
if (expression instanceof ConstantExpression) {
return (ConstantExpression) expression;
}
return this.configureAST(new ConstantExpression(expression.getText()), expression);
}
private BinaryExpression createBinaryExpression(ExpressionContext left, Token op, ExpressionContext right) {
return new BinaryExpression((Expression) this.visit(left), this.createGroovyToken(op), (Expression) this.visit(right));
}
private Statement unpackStatement(Statement statement) {
if (statement instanceof DeclarationListStatement) {
List<ExpressionStatement> expressionStatementList = ((DeclarationListStatement) statement).getDeclarationStatements();
if (1 == expressionStatementList.size()) {
return expressionStatementList.get(0);
}
return this.configureAST(this.createBlockStatement(statement), statement); // if DeclarationListStatement contains more than 1 declarations, maybe it's better to create a block to hold them
}
return statement;
}
public BlockStatement createBlockStatement(Statement... statements) {
return this.createBlockStatement(Arrays.asList(statements));
}
private BlockStatement createBlockStatement(List<Statement> statementList) {
return this.appendStatementsToBlockStatement(new BlockStatement(), statementList);
}
public BlockStatement appendStatementsToBlockStatement(BlockStatement bs, Statement... statements) {
return this.appendStatementsToBlockStatement(bs, Arrays.asList(statements));
}
private BlockStatement appendStatementsToBlockStatement(BlockStatement bs, List<Statement> statementList) {
return (BlockStatement) statementList.stream()
.reduce(bs, (r, e) -> {
BlockStatement blockStatement = (BlockStatement) r;
if (e instanceof DeclarationListStatement) {
((DeclarationListStatement) e).getDeclarationStatements().forEach(blockStatement::addStatement);
} else {
blockStatement.addStatement(e);
}
return blockStatement;
});
}
private boolean isAnnotationDeclaration(ClassNode classNode) {
return asBoolean(classNode) && classNode.isAnnotationDefinition();
}
private boolean isSyntheticPublic(
boolean isAnnotationDeclaration,
boolean isAnonymousInnerEnumDeclaration,
boolean hasReturnType,
ModifierManager modifierManager
) {
return this.isSyntheticPublic(
isAnnotationDeclaration,
isAnonymousInnerEnumDeclaration,
modifierManager.containsAnnotations(),
modifierManager.containsVisibilityModifier(),
modifierManager.containsNonVisibilityModifier(),
hasReturnType,
modifierManager.contains(DEF));
}
/**
* @param isAnnotationDeclaration whether the method is defined in an annotation
* @param isAnonymousInnerEnumDeclaration whether the method is defined in an anonymous inner enum
* @param hasAnnotation whether the method declaration has annotations
* @param hasVisibilityModifier whether the method declaration contains visibility modifier(e.g. public, protected, private)
* @param hasModifier whether the method declaration has modifier(e.g. visibility modifier, final, static and so on)
* @param hasReturnType whether the method declaration has an return type(e.g. String, generic types)
* @param hasDef whether the method declaration using def keyword
* @return the result
*/
private boolean isSyntheticPublic(
boolean isAnnotationDeclaration,
boolean isAnonymousInnerEnumDeclaration,
boolean hasAnnotation,
boolean hasVisibilityModifier,
boolean hasModifier,
boolean hasReturnType,
boolean hasDef) {
if (hasVisibilityModifier) {
return false;
}
if (isAnnotationDeclaration) {
return true;
}
if (hasDef && hasReturnType) {
return true;
}
if (hasModifier || hasAnnotation || !hasReturnType) {
return true;
}
if (isAnonymousInnerEnumDeclaration) {
return true;
}
return false;
}
// the mixins of interface and annotation should be null
private void hackMixins(ClassNode classNode) {
try {
// FIXME Hack with visibility.
Field field = ClassNode.class.getDeclaredField("mixins");
field.setAccessible(true);
field.set(classNode, null);
} catch (IllegalAccessException | NoSuchFieldException e) {
throw new GroovyBugError("Failed to access mixins field", e);
}
}
private static final Map<ClassNode, Object> TYPE_DEFAULT_VALUE_MAP = Collections.unmodifiableMap(new HashMap<ClassNode, Object>() {
{
this.put(ClassHelper.int_TYPE, 0);
this.put(ClassHelper.long_TYPE, 0L);
this.put(ClassHelper.double_TYPE, 0.0D);
this.put(ClassHelper.float_TYPE, 0.0F);
this.put(ClassHelper.short_TYPE, (short) 0);
this.put(ClassHelper.byte_TYPE, (byte) 0);
this.put(ClassHelper.char_TYPE, (char) 0);
this.put(ClassHelper.boolean_TYPE, Boolean.FALSE);
}
});
private Object findDefaultValueByType(ClassNode type) {
return TYPE_DEFAULT_VALUE_MAP.get(type);
}
private boolean isPackageInfoDeclaration() {
String name = this.sourceUnit.getName();
if (asBoolean((Object) name) && name.endsWith(PACKAGE_INFO_FILE_NAME)) {
return true;
}
return false;
}
private boolean isBlankScript(CompilationUnitContext ctx) {
return moduleNode.getStatementBlock().isEmpty() && moduleNode.getMethods().isEmpty() && moduleNode.getClasses().isEmpty();
}
private void addEmptyReturnStatement() {
moduleNode.addStatement(ReturnStatement.RETURN_NULL_OR_VOID);
}
private void addPackageInfoClassNode() {
List<ClassNode> classNodeList = moduleNode.getClasses();
ClassNode packageInfoClassNode = ClassHelper.make(moduleNode.getPackageName() + PACKAGE_INFO);
if (!classNodeList.contains(packageInfoClassNode)) {
moduleNode.addClass(packageInfoClassNode);
}
}
private org.codehaus.groovy.syntax.Token createGroovyTokenByType(Token token, int type) {
if (null == token) {
throw new IllegalArgumentException("token should not be null");
}
return new org.codehaus.groovy.syntax.Token(type, token.getText(), token.getLine(), token.getCharPositionInLine());
}
private org.codehaus.groovy.syntax.Token createGroovyToken(Token token) {
return this.createGroovyToken(token, 1);
}
private org.codehaus.groovy.syntax.Token createGroovyToken(Token token, int cardinality) {
String text = StringGroovyMethods.multiply((CharSequence) token.getText(), cardinality);
return new org.codehaus.groovy.syntax.Token(
"..<".equals(token.getText()) || "..".equals(token.getText())
? Types.RANGE_OPERATOR
: Types.lookup(text, Types.ANY),
text,
token.getLine(),
token.getCharPositionInLine() + 1
);
}
/*
private org.codehaus.groovy.syntax.Token createGroovyToken(String text, int startLine, int startColumn) {
return new org.codehaus.groovy.syntax.Token(
Types.lookup(text, Types.ANY),
text,
startLine,
startColumn
);
}
*/
/**
* set the script source position
*/
private void configureScriptClassNode() {
ClassNode scriptClassNode = moduleNode.getScriptClassDummy();
if (!asBoolean(scriptClassNode)) {
return;
}
List<Statement> statements = moduleNode.getStatementBlock().getStatements();
if (!statements.isEmpty()) {
Statement firstStatement = statements.get(0);
Statement lastStatement = statements.get(statements.size() - 1);
scriptClassNode.setSourcePosition(firstStatement);
scriptClassNode.setLastColumnNumber(lastStatement.getLastColumnNumber());
scriptClassNode.setLastLineNumber(lastStatement.getLastLineNumber());
}
}
/**
* Sets location(lineNumber, colNumber, lastLineNumber, lastColumnNumber) for node using standard context information.
* Note: this method is implemented to be closed over ASTNode. It returns same node as it received in arguments.
*
* @param astNode Node to be modified.
* @param ctx Context from which information is obtained.
* @return Modified astNode.
*/
private <T extends ASTNode> T configureAST(T astNode, GroovyParserRuleContext ctx) {
Token start = ctx.getStart();
Token stop = ctx.getStop();
astNode.setLineNumber(start.getLine());
astNode.setColumnNumber(start.getCharPositionInLine() + 1);
Pair<Integer, Integer> stopTokenEndPosition = endPosition(stop);
astNode.setLastLineNumber(stopTokenEndPosition.getKey());
astNode.setLastColumnNumber(stopTokenEndPosition.getValue());
return astNode;
}
private Pair<Integer, Integer> endPosition(Token token) {
String stopText = token.getText();
int stopTextLength = 0;
int newLineCnt = 0;
if (asBoolean((Object) stopText)) {
stopTextLength = stopText.length();
newLineCnt = (int) StringUtils.countChar(stopText, '\n');
}
if (0 == newLineCnt) {
return new Pair<Integer, Integer>(token.getLine(), token.getCharPositionInLine() + 1 + token.getText().length());
} else { // e.g. GStringEnd contains newlines, we should fix the location info
return new Pair<Integer, Integer>(token.getLine() + newLineCnt, stopTextLength - stopText.lastIndexOf('\n'));
}
}
private <T extends ASTNode> T configureAST(T astNode, TerminalNode terminalNode) {
return this.configureAST(astNode, terminalNode.getSymbol());
}
private <T extends ASTNode> T configureAST(T astNode, Token token) {
astNode.setLineNumber(token.getLine());
astNode.setColumnNumber(token.getCharPositionInLine() + 1);
astNode.setLastLineNumber(token.getLine());
astNode.setLastColumnNumber(token.getCharPositionInLine() + 1 + token.getText().length());
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, ASTNode source) {
astNode.setLineNumber(source.getLineNumber());
astNode.setColumnNumber(source.getColumnNumber());
astNode.setLastLineNumber(source.getLastLineNumber());
astNode.setLastColumnNumber(source.getLastColumnNumber());
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, GroovyParserRuleContext ctx, ASTNode stop) {
Token start = ctx.getStart();
astNode.setLineNumber(start.getLine());
astNode.setColumnNumber(start.getCharPositionInLine() + 1);
if (asBoolean(stop)) {
astNode.setLastLineNumber(stop.getLastLineNumber());
astNode.setLastColumnNumber(stop.getLastColumnNumber());
} else {
Pair<Integer, Integer> endPosition = endPosition(start);
astNode.setLastLineNumber(endPosition.getKey());
astNode.setLastColumnNumber(endPosition.getValue());
}
return astNode;
}
private <T extends ASTNode> T configureAST(T astNode, ASTNode start, ASTNode stop) {
astNode.setLineNumber(start.getLineNumber());
astNode.setColumnNumber(start.getColumnNumber());
if (asBoolean(stop)) {
astNode.setLastLineNumber(stop.getLastLineNumber());
astNode.setLastColumnNumber(stop.getLastColumnNumber());
} else {
astNode.setLastLineNumber(start.getLastLineNumber());
astNode.setLastColumnNumber(start.getLastColumnNumber());
}
return astNode;
}
private boolean isTrue(GroovyParserRuleContext ctx, String key) {
Object nmd = ctx.getNodeMetaData(key);
if (null == nmd) {
return false;
}
if (!(nmd instanceof Boolean)) {
throw new GroovyBugError(ctx + " ctx meta data[" + key + "] is not an instance of Boolean");
}
return (Boolean) nmd;
}
private boolean isTrue(ASTNode node, String key) {
Object nmd = node.getNodeMetaData(key);
if (null == nmd) {
return false;
}
if (!(nmd instanceof Boolean)) {
throw new GroovyBugError(node + " node meta data[" + key + "] is not an instance of Boolean");
}
return (Boolean) nmd;
}
private CompilationFailedException createParsingFailedException(String msg, GroovyParserRuleContext ctx) {
return createParsingFailedException(
new SyntaxException(msg,
ctx.start.getLine(),
ctx.start.getCharPositionInLine() + 1,
ctx.stop.getLine(),
ctx.stop.getCharPositionInLine() + 1 + ctx.stop.getText().length()));
}
public CompilationFailedException createParsingFailedException(String msg, ASTNode node) {
Objects.requireNonNull(node, "node passed into createParsingFailedException should not be null");
return createParsingFailedException(
new SyntaxException(msg,
node.getLineNumber(),
node.getColumnNumber(),
node.getLastLineNumber(),
node.getLastColumnNumber()));
}
/*
private CompilationFailedException createParsingFailedException(String msg, Token token) {
return createParsingFailedException(
new SyntaxException(msg,
token.getLine(),
token.getCharPositionInLine() + 1,
token.getLine(),
token.getCharPositionInLine() + 1 + token.getText().length()));
}
*/
private CompilationFailedException createParsingFailedException(Throwable t) {
if (t instanceof SyntaxException) {
this.collectSyntaxError((SyntaxException) t);
} else if (t instanceof GroovySyntaxError) {
GroovySyntaxError groovySyntaxError = (GroovySyntaxError) t;
this.collectSyntaxError(
new SyntaxException(
groovySyntaxError.getMessage(),
groovySyntaxError,
groovySyntaxError.getLine(),
groovySyntaxError.getColumn()));
} else if (t instanceof Exception) {
this.collectException((Exception) t);
}
return new CompilationFailedException(
CompilePhase.PARSING.getPhaseNumber(),
this.sourceUnit,
t);
}
private void collectSyntaxError(SyntaxException e) {
sourceUnit.getErrorCollector().addFatalError(new SyntaxErrorMessage(e, sourceUnit));
}
private void collectException(Exception e) {
sourceUnit.getErrorCollector().addException(e, this.sourceUnit);
}
private String readSourceCode(SourceUnit sourceUnit) {
String text = null;
try {
text = IOGroovyMethods.getText(
new BufferedReader(
sourceUnit.getSource().getReader()));
} catch (IOException e) {
LOGGER.severe(createExceptionMessage(e));
throw new RuntimeException("Error occurred when reading source code.", e);
}
return text;
}
private ANTLRErrorListener createANTLRErrorListener() {
return new ANTLRErrorListener() {
@Override
public void syntaxError(
Recognizer recognizer,
Object offendingSymbol, int line, int charPositionInLine,
String msg, RecognitionException e) {
collectSyntaxError(new SyntaxException(msg, line, charPositionInLine + 1));
}
};
}
private void removeErrorListeners() {
lexer.removeErrorListeners();
parser.removeErrorListeners();
}
private void addErrorListeners() {
lexer.removeErrorListeners();
lexer.addErrorListener(this.createANTLRErrorListener());
parser.removeErrorListeners();
parser.addErrorListener(this.createANTLRErrorListener());
}
private String createExceptionMessage(Throwable t) {
StringWriter sw = new StringWriter();
try (PrintWriter pw = new PrintWriter(sw)) {
t.printStackTrace(pw);
}
return sw.toString();
}
private class DeclarationListStatement extends Statement {
private List<ExpressionStatement> declarationStatements;
public DeclarationListStatement(DeclarationExpression... declarations) {
this(Arrays.asList(declarations));
}
public DeclarationListStatement(List<DeclarationExpression> declarations) {
this.declarationStatements =
declarations.stream()
.map(e -> configureAST(new ExpressionStatement(e), e))
.collect(Collectors.toList());
}
public List<ExpressionStatement> getDeclarationStatements() {
List<String> declarationListStatementLabels = this.getStatementLabels();
this.declarationStatements.forEach(e -> {
if (asBoolean((Object) declarationListStatementLabels)) {
// clear existing statement labels before setting labels
if (asBoolean((Object) e.getStatementLabels())) {
e.getStatementLabels().clear();
}
declarationListStatementLabels.forEach(e::addStatementLabel);
}
});
return this.declarationStatements;
}
public List<DeclarationExpression> getDeclarationExpressions() {
return this.declarationStatements.stream()
.map(e -> (DeclarationExpression) e.getExpression())
.collect(Collectors.toList());
}
}
private static class Pair<K, V> {
private K key;
private V value;
public Pair(K key, V value) {
this.key = key;
this.value = value;
}
public K getKey() {
return key;
}
public void setKey(K key) {
this.key = key;
}
public V getValue() {
return value;
}
public void setValue(V value) {
this.value = value;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Pair<?, ?> pair = (Pair<?, ?>) o;
return Objects.equals(key, pair.key) &&
Objects.equals(value, pair.value);
}
@Override
public int hashCode() {
return Objects.hash(key, value);
}
}
private final ModuleNode moduleNode;
private final SourceUnit sourceUnit;
private final ClassLoader classLoader; // Our ClassLoader, which provides information on external types
private final GroovyLangLexer lexer;
private final GroovyLangParser parser;
private final TryWithResourcesASTTransformation tryWithResourcesASTTransformation;
private final GroovydocManager groovydocManager;
private final List<ClassNode> classNodeList = new LinkedList<>();
private final Deque<ClassNode> classNodeStack = new ArrayDeque<>();
private final Deque<List<InnerClassNode>> anonymousInnerClassesDefinedInMethodStack = new ArrayDeque<>();
private int anonymousInnerClassCounter = 1;
private static final String QUESTION_STR = "?";
private static final String DOT_STR = ".";
private static final String SUB_STR = "-";
private static final String ASSIGN_STR = "=";
private static final String VALUE_STR = "value";
private static final String DOLLAR_STR = "$";
private static final String CALL_STR = "call";
private static final String THIS_STR = "this";
private static final String SUPER_STR = "super";
private static final String VOID_STR = "void";
private static final String PACKAGE_INFO = "package-info";
private static final String PACKAGE_INFO_FILE_NAME = PACKAGE_INFO + ".groovy";
private static final String GROOVY_TRANSFORM_TRAIT = "groovy.transform.Trait";
private static final Set<String> PRIMITIVE_TYPE_SET = Collections.unmodifiableSet(new HashSet<>(Arrays.asList("boolean", "char", "byte", "short", "int", "long", "float", "double")));
private static final Logger LOGGER = Logger.getLogger(AstBuilder.class.getName());
private static final String IS_INSIDE_PARENTHESES = "_IS_INSIDE_PARENTHESES";
private static final String INSIDE_PARENTHESES_LEVEL = "_INSIDE_PARENTHESES_LEVEL";
private static final String IS_INSIDE_INSTANCEOF_EXPR = "_IS_INSIDE_INSTANCEOF_EXPR";
private static final String IS_SWITCH_DEFAULT = "_IS_SWITCH_DEFAULT";
private static final String IS_NUMERIC = "_IS_NUMERIC";
private static final String IS_STRING = "_IS_STRING";
private static final String IS_INTERFACE_WITH_DEFAULT_METHODS = "_IS_INTERFACE_WITH_DEFAULT_METHODS";
private static final String PATH_EXPRESSION_BASE_EXPR = "_PATH_EXPRESSION_BASE_EXPR";
private static final String PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES = "_PATH_EXPRESSION_BASE_EXPR_GENERICS_TYPES";
private static final String CMD_EXPRESSION_BASE_EXPR = "_CMD_EXPRESSION_BASE_EXPR";
private static final String TYPE_DECLARATION_MODIFIERS = "_TYPE_DECLARATION_MODIFIERS";
private static final String CLASS_DECLARATION_CLASS_NODE = "_CLASS_DECLARATION_CLASS_NODE";
private static final String VARIABLE_DECLARATION_VARIABLE_TYPE = "_VARIABLE_DECLARATION_VARIABLE_TYPE";
private static final String ANONYMOUS_INNER_CLASS_SUPER_CLASS = "_ANONYMOUS_INNER_CLASS_SUPER_CLASS";
private static final String INTEGER_LITERAL_TEXT = "_INTEGER_LITERAL_TEXT";
private static final String FLOATING_POINT_LITERAL_TEXT = "_FLOATING_POINT_LITERAL_TEXT";
private static final String CLASS_NAME = "_CLASS_NAME";
}
| Sync the changes from apache/groovy manually
| src/main/java/org/apache/groovy/parser/antlr4/AstBuilder.java | Sync the changes from apache/groovy manually | <ide><path>rc/main/java/org/apache/groovy/parser/antlr4/AstBuilder.java
<ide> if (hasStar) { // e.g. import static java.lang.Math.*
<ide> String qualifiedName = this.visitQualifiedName(ctx.qualifiedName());
<ide> ClassNode type = ClassHelper.make(qualifiedName);
<del>
<add> this.configureAST(type, ctx);
<ide>
<ide> moduleNode.addStaticStarImport(type.getText(), type, annotationNodeList);
<ide>
<ide> String alias = hasAlias
<ide> ? ctx.alias.getText()
<ide> : name;
<add> this.configureAST(classNode, ctx);
<ide>
<ide> moduleNode.addStaticImport(classNode, name, alias, annotationNodeList);
<ide>
<ide> String alias = hasAlias
<ide> ? ctx.alias.getText()
<ide> : name;
<add> this.configureAST(classNode, ctx);
<ide>
<ide> moduleNode.addImport(alias, classNode, annotationNodeList);
<ide>
<ide>
<ide> new Parameter(e, this.visitIdentifier(ctx.identifier())),
<ide> this.visitBlock(ctx.block())),
<del> ctx.block()))
<add> ctx))
<ide> .collect(Collectors.toList());
<ide> }
<ide>
<ide> public GenericsType visitTypeParameter(TypeParameterContext ctx) {
<ide> return this.configureAST(
<ide> new GenericsType(
<del> ClassHelper.make(this.visitClassName(ctx.className())),
<add> this.configureAST(ClassHelper.make(this.visitClassName(ctx.className())), ctx),
<ide> this.visitTypeBound(ctx.typeBound()),
<ide> null
<ide> ),
<ide>
<ide> if (asBoolean(ctx.arguments())) {
<ide> Expression argumentsExpr = this.visitArguments(ctx.arguments());
<add> this.configureAST(argumentsExpr, ctx);
<ide>
<ide> if (isTrue(baseExpr, IS_INSIDE_PARENTHESES)) { // e.g. (obj.x)(), (obj.@x)()
<ide> MethodCallExpression methodCallExpression = |
|
JavaScript | mit | 71bb07b9adab133d22de93b4c6a62eee689ff583 | 0 | KTH/lms-sync,KTH/lms-sync | var test = require('tape')
const {handleMessages} = require('././utils')
const canvasApi = require('../../canvasApi')
const randomstring = require('randomstring')
async function processMessage (message, course) {
// First create a fresch course in canvas
try {
const accountId = 14 // Courses that starts with an 'A' is handled by account 14
const canvasCourse = await canvasApi.createCourse({course}, accountId)
await canvasApi.createDefaultSection(canvasCourse)
const [{resp}] = await handleMessages(message)
await canvasApi.pollUntilSisComplete(resp.id)
const enrolledUsers = await canvasApi.getEnrollments(canvasCourse.id)
console.log('enrolledUsers:', JSON.stringify(enrolledUsers))
const [enrolledUser] = enrolledUsers
return enrolledUser
} catch (e) {
console.error('An error occured', e)
}
}
test('should enroll an assistant in an existing course in canvas', t => {
t.plan(1)
const courseCode = 'A' + randomstring.generate(5) // Assistants course code should be 6 chars
const userKthId = 'u1znmoik'
const message = {
ugClass: 'group',
ug1Name: `edu.courses.SF.${courseCode}.20171.1.assistants`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode,
'sis_course_id': `${courseCode}VT171`
}
processMessage(message, course)
.then((enrolledUser) => {
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test.only('should enroll an employee in correct section in Miljöutbildningen and Canvas at KTH', async t => {
t.plan(1)
const canvasCourseId = 5011 // Miljöutbildningen
const canvasCourseId2 = 85 // Miljöutbildningen
// First create a new user
const kthid = randomstring.generate(8)
const username = `${kthid}_abc`
const createUserMessage = {
kthid,
'ugClass': 'user',
'deleted': false,
'affiliation': ['student'],
username,
'family_name': 'Stenberg',
'given_name': 'Emil Stenberg',
'primary_email': '[email protected]'}
await handleMessages(createUserMessage)
// Then enroll the new user
const staffMessage = {
ugClass: 'group',
ug1Name: 'app.katalog3.A',
member: [kthid]}
const [{resp}] = await handleMessages(staffMessage)
await canvasApi.pollUntilSisComplete(resp.id)
const enrolledUsersMU = await canvasApi.get(`courses/${canvasCourseId}/enrollments?sis_section_id[]=app.katalog3.A.section_1`)
t.ok(enrolledUsersMU.find(user => user.user.sis_user_id === kthid))
// const enrolledUsersCanvasAtKth = await canvasApi.get(`courses/${canvasCourseId2}/enrollments?sis_section_id[]=app.katalog3.A.section_2`)
// t.ok(enrolledUsersCanvasAtKth.find(user => user.user.sis_user_id === kthid))
})
test('should enroll a re-registered student in an existing course in canvas', t => {
t.plan(2)
const userKthId = 'u1znmoik'
const courseCode0 = 'A' + randomstring.generate(1)
const courseCode1 = randomstring.generate(4)
const message = {
ugClass: 'group',
ug1Name: `ladok2.kurser.${courseCode0}.${courseCode1}.omregistrerade_20171`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode0 + courseCode1,
'sis_course_id': `${courseCode0 + courseCode1}VT173`
}
processMessage(message, course)
.then(enrolledUser => {
t.ok(enrolledUser)
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test('should enroll a student in an existing course in canvas', t => {
t.plan(2)
const courseCode0 = 'A' + randomstring.generate(1)
const courseCode1 = randomstring.generate(4)
const userKthId = 'u1znmoik'
const message = {
kthid: 'u2yp4zyn',
ugClass: 'group',
ug1Name: `ladok2.kurser.${courseCode0}.${courseCode1}.registrerade_20171.1`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode0 + courseCode1,
'sis_course_id': `${courseCode0 + courseCode1}VT171`
}
processMessage(message, course)
.then((enrolledUser) => {
t.ok(enrolledUser)
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test('should ������ enroll an antagen, but return with the message and type:unknown', t => {
t.plan(1)
const message = {
ugClass: 'group',
ug1Name: 'ladok2.kurser.SF1624.antagna_20171.1',
member: ['u1znmoik']
}
handleMessages(message)
.then(([{_desc}]) => {
t.deepEqual(_desc, { type: 'UNKNOWN' })
})
})
| test/integration/enrollment.test.js | var test = require('tape')
const {handleMessages} = require('././utils')
const canvasApi = require('../../canvasApi')
const randomstring = require('randomstring')
async function processMessage (message, course) {
// First create a fresch course in canvas
try {
const accountId = 14 // Courses that starts with an 'A' is handled by account 14
const canvasCourse = await canvasApi.createCourse({course}, accountId)
await canvasApi.createDefaultSection(canvasCourse)
const [{resp}] = await handleMessages(message)
await canvasApi.pollUntilSisComplete(resp.id)
const enrolledUsers = await canvasApi.getEnrollments(canvasCourse.id)
console.log('enrolledUsers:', JSON.stringify(enrolledUsers))
const [enrolledUser] = enrolledUsers
return enrolledUser
} catch (e) {
console.error('An error occured', e)
}
}
test('should enroll an assistant in an existing course in canvas', t => {
t.plan(1)
const courseCode = 'A' + randomstring.generate(5) // Assistants course code should be 6 chars
const userKthId = 'u1znmoik'
const message = {
ugClass: 'group',
ug1Name: `edu.courses.SF.${courseCode}.20171.1.assistants`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode,
'sis_course_id': `${courseCode}VT171`
}
processMessage(message, course)
.then((enrolledUser) => {
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test.only('should enroll an employee in correct section in Miljöutbildningen', async t => {
t.plan(1)
const canvasCourseId = 5011 // Miljöutbildningen
// First create a new user
const kthid = randomstring.generate(8)
const username = `${kthid}_abc`
const createUserMessage = {
kthid,
'ugClass': 'user',
'deleted': false,
'affiliation': ['student'],
username,
'family_name': 'Stenberg',
'given_name': 'Emil Stenberg',
'primary_email': '[email protected]'}
await handleMessages(createUserMessage)
// Then enroll the new user
const staffMessage = {
ugClass: 'group',
ug1Name: 'app.katalog3.A',
member: [kthid]}
const [{resp}] = await handleMessages(staffMessage)
await canvasApi.pollUntilSisComplete(resp.id)
const enrolledUsers = await canvasApi.get(`courses/${canvasCourseId}/enrollments?sis_section_id[]=app.katalog3.A.section_1`)
console.log(enrolledUsers)
t.ok(enrolledUsers.find(user => user.user.sis_user_id === kthid))
})
test('should enroll a re-registered student in an existing course in canvas', t => {
t.plan(2)
const userKthId = 'u1znmoik'
const courseCode0 = 'A' + randomstring.generate(1)
const courseCode1 = randomstring.generate(4)
const message = {
ugClass: 'group',
ug1Name: `ladok2.kurser.${courseCode0}.${courseCode1}.omregistrerade_20171`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode0 + courseCode1,
'sis_course_id': `${courseCode0 + courseCode1}VT173`
}
processMessage(message, course)
.then(enrolledUser => {
t.ok(enrolledUser)
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test('should enroll a student in an existing course in canvas', t => {
t.plan(2)
const courseCode0 = 'A' + randomstring.generate(1)
const courseCode1 = randomstring.generate(4)
const userKthId = 'u1znmoik'
const message = {
kthid: 'u2yp4zyn',
ugClass: 'group',
ug1Name: `ladok2.kurser.${courseCode0}.${courseCode1}.registrerade_20171.1`,
member: [userKthId]}
const course = {
name: 'Emil testar',
'course_code': courseCode0 + courseCode1,
'sis_course_id': `${courseCode0 + courseCode1}VT171`
}
processMessage(message, course)
.then((enrolledUser) => {
t.ok(enrolledUser)
t.equal(enrolledUser.sis_user_id, userKthId)
})
})
test('should ������ enroll an antagen, but return with the message and type:unknown', t => {
t.plan(1)
const message = {
ugClass: 'group',
ug1Name: 'ladok2.kurser.SF1624.antagna_20171.1',
member: ['u1znmoik']
}
handleMessages(message)
.then(([{_desc}]) => {
t.deepEqual(_desc, { type: 'UNKNOWN' })
})
})
| added comment about enrollment in another course
| test/integration/enrollment.test.js | added comment about enrollment in another course | <ide><path>est/integration/enrollment.test.js
<ide> })
<ide> })
<ide>
<del>test.only('should enroll an employee in correct section in Miljöutbildningen', async t => {
<add>test.only('should enroll an employee in correct section in Miljöutbildningen and Canvas at KTH', async t => {
<ide> t.plan(1)
<ide> const canvasCourseId = 5011 // Miljöutbildningen
<add> const canvasCourseId2 = 85 // Miljöutbildningen
<ide>
<ide> // First create a new user
<ide> const kthid = randomstring.generate(8)
<ide> const [{resp}] = await handleMessages(staffMessage)
<ide> await canvasApi.pollUntilSisComplete(resp.id)
<ide>
<del> const enrolledUsers = await canvasApi.get(`courses/${canvasCourseId}/enrollments?sis_section_id[]=app.katalog3.A.section_1`)
<del> console.log(enrolledUsers)
<del> t.ok(enrolledUsers.find(user => user.user.sis_user_id === kthid))
<add> const enrolledUsersMU = await canvasApi.get(`courses/${canvasCourseId}/enrollments?sis_section_id[]=app.katalog3.A.section_1`)
<add> t.ok(enrolledUsersMU.find(user => user.user.sis_user_id === kthid))
<add>
<add> // const enrolledUsersCanvasAtKth = await canvasApi.get(`courses/${canvasCourseId2}/enrollments?sis_section_id[]=app.katalog3.A.section_2`)
<add> // t.ok(enrolledUsersCanvasAtKth.find(user => user.user.sis_user_id === kthid))
<ide> })
<ide>
<ide> test('should enroll a re-registered student in an existing course in canvas', t => { |
|
JavaScript | mit | 56d357f4dc5fb69c84c07dbe1a688b282b054c73 | 0 | trueadm/inferno,infernojs/inferno,infernojs/inferno,trueadm/inferno | /*
t7.js is a small, lightweight library for compiling ES2015 template literals
into virtual DOM objects.
By Dominic Gannaway
*/
var t7 = (function() {
"use strict";
//we store created functions in the cache (key is the template string)
var isBrowser = typeof window != "undefined" && document != null;
var docHead = null;
//to save time later, we can pre-create a props object structure to re-use
var output = null;
var precompile = false;
var version = "0.3.0";
if (isBrowser === true) {
docHead = document.getElementsByTagName('head')[0];
}
var selfClosingTags = {
area: true,
base: true,
basefont: true,
br: true,
col: true,
command: true,
embed: true,
frame: true,
hr: true,
img: true,
input: true,
isindex: true,
keygen: true,
link: true,
meta: true,
param: true,
source: true,
track: true,
wbr: true,
//common self closing svg elements
path: true,
circle: true,
ellipse: true,
line: true,
rect: true,
use: true,
stop: true,
polyline: true,
polygon: true
};
//when creating a new function from a vdom, we'll need to build the vdom's children
function buildUniversalChildren(root, tagParams, childrenProp, component) {
var childrenText = [];
var i = 0;
var n = 0;
var key = "";
var matches = null;
//if the node has children that is an array, handle it with a loop
if (root.children != null && root.children instanceof Array) {
for (i = 0, n = root.children.length; i < n; i++) {
if (root.children[i] != null) {
if (typeof root.children[i] === "string") {
root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm, "");
matches = root.children[i].match(/__\$props__\[\d*\]/g);
if (matches !== null) {
childrenText.push(root.children[i]);
} else {
childrenText.push("'" + root.children[i] + "'");
}
} else {
buildFunction(root.children[i], childrenText, component)
}
}
}
//push the children code into our tag params code
if (childrenText.length === 1) {
tagParams.push((childrenProp ? "children: " : "") + childrenText);
} else if (childrenText.length > 1) {
tagParams.push((childrenProp ? "children: " : "") + "[" + childrenText.join(",") + "]");
}
} else if (root.children != null && typeof root.children === "string") {
root.children = root.children.replace(/(\r\n|\n|\r)/gm, "").trim();
//this ensures its a prop replacement
matches = root.children.match(/__\$props__\[\d*\]/g);
//find any template strings and replace them
if (matches !== null) {
root.children = root.children.replace(/(__\$props__\[.*\])/g, "',$1,'")
}
//if the last two characters are ,', replace them with nothing
if (root.children.substring(root.children.length - 2) === ",'") {
root.children = root.children.substring(0, root.children.length - 2);
tagParams.push((childrenProp ? "children: " : "") + "['" + root.children + "]");
} else {
tagParams.push((childrenProp ? "children: " : "") + "['" + root.children + "']");
}
}
};
function buildInfernoTemplate(root, valueCounter, parentNodeName, templateValues, templateParams, component) {
//TODO this entire function is horrible, needs a revist and refactor
var nodeName = parentNodeName ? parentNodeName + "_" : "n_";
var child = null,
matches, valueName = "";
if (root.children instanceof Array) {
for (var i = 0; i < root.children.length; i++) {
child = root.children[i];
if (typeof child === "string" && root.children.length === 1) {
matches = child.match(/__\$props__\[\d*\]/g);
if (matches === null) {
if (!parentNodeName) {
templateParams.push("root.textContent=('" + child + "');");
} else {
templateParams.push(parentNodeName + ".textContent='" + child + "';");
}
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
templateParams.push("if(typeof " + valueName + " !== 'object') {");
if (!parentNodeName) {
templateParams.push("root.textContent=" + valueName + ";");
} else {
templateParams.push(parentNodeName + ".textContent=(" + valueName + " === '' ? ' ' : " + valueName + ");");
}
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.TEXT;");
templateParams.push("} else {");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = (" + valueName + ".constructor === Array ? Inferno.Type.LIST : Inferno.Type.FRAGMENT);");
templateParams.push("}");
if (!parentNodeName) {
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = root;");
} else {
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + parentNodeName + ";");
}
templateValues.push(child);
valueCounter.index++;
}
} else if (typeof child === "string" && root.children.length > 1) {
matches = child.match(/__\$props__\[\d*\]/g);
if (matches === null) {
templateParams.push("var " + nodeName + i + " = Inferno.dom.createText('" + child.replace(/(\r\n|\n|\r)/gm, "") + "');");
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
templateParams.push("var " + nodeName + i + ";");
templateParams.push("if(typeof " + valueName + " !== 'object') {");
templateParams.push(nodeName + i + " = Inferno.dom.createText(" + valueName + ");");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.TEXT_DIRECT;");
templateParams.push("} else {");
templateParams.push(nodeName + i + " = Inferno.dom.createEmpty();");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = (" + valueName + ".constructor === Array ? Inferno.Type.LIST_REPLACE : Inferno.Type.FRAGMENT_REPLACE);");
templateParams.push("}");
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + nodeName + i + ";");
templateValues.push(child);
valueCounter.index++;
}
if (!parentNodeName) {
templateParams.push("root.appendChild(" + nodeName + i + ");");
} else {
templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
}
} else if (child != null) {
if (child.tag) {
if (isComponentName(child.tag) === true) {
valueCounter.t7Required = true;
var props = [];
var propRefs = [];
if (child.attrs) {
buildInfernoAttrsParams(child, nodeName + i, props, templateValues, templateParams, valueCounter, propRefs);
}
templateParams.push("var " + nodeName + i + " = Inferno.dom.createComponent(" + (!parentNodeName ? "root" : parentNodeName) + ", t7.loadComponent('" + child.tag + "'), {" + props.join(",") + "});");
templateParams.push(propRefs.join(""));
} else {
templateParams.push("var " + nodeName + i + " = Inferno.dom.createElement('" + child.tag + "');");
if (child.attrs) {
var attrsParams = [];
buildInfernoAttrsParams(child, nodeName + i, attrsParams, templateValues, templateParams, valueCounter);
templateParams.push("Inferno.dom.addAttributes(" + nodeName + i + ", {" + attrsParams.join(",") + "});");
}
if (child.children) {
buildInfernoTemplate(child, valueCounter, nodeName + i, templateValues, templateParams, component);
}
if (!parentNodeName) {
templateParams.push("root.appendChild(" + nodeName + i + ");");
} else {
templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
}
}
}
}
}
}
}
//when creating a new function from a vdom, we'll need to build the vdom's children
function buildReactChildren(root, tagParams, childrenProp, component) {
var childrenText = [];
var i = 0;
var n = 0;
var matches = null;
//if the node has children that is an array, handle it with a loop
if (root.children != null && root.children instanceof Array) {
//we're building an array in code, so we need an open bracket
for (i = 0, n = root.children.length; i < n; i++) {
if (root.children[i] != null) {
if (typeof root.children[i] === "string") {
root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm, "");
matches = root.children[i].match(/__\$props__\[\d*\]/g);
if (matches != null) {
root.children[i] = root.children[i].replace(/(__\$props__\[[0-9]*\])/g, "$1")
if (root.children[i].substring(root.children[i].length - 1) === ",") {
root.children[i] = root.children[i].substring(0, root.children[i].length - 1);
}
childrenText.push(root.children[i]);
} else {
childrenText.push("'" + root.children[i] + "'");
}
} else {
buildFunction(root.children[i], childrenText, i === root.children.length - 1, component)
}
}
}
//push the children code into our tag params code
if (childrenText.length > 0) {
tagParams.push(childrenText.join(","));
}
} else if (root.children != null && typeof root.children === "string") {
root.children = root.children.replace(/(\r\n|\n|\r)/gm, "");
tagParams.push("'" + root.children + "'");
}
};
function buildInfernoAttrsParams(root, rootElement, attrsParams, templateValues, templateParams, valueCounter, propRefs) {
var val = '',
valueName;
var matches = null;
for (var name in root.attrs) {
val = root.attrs[name];
matches = val.match(/__\$props__\[\d*\]/g);
if (matches === null) {
attrsParams.push("'" + name + "':'" + val + "'");
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
if (!propRefs) {
switch (name) {
case "class":
case "className":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_CLASS;");
break;
case "id":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_ID;");
break;
case "value":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_VALUE;");
break;
case "width":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_WIDTH;");
break;
case "height":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_HEIGHT;");
break;
case "type":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_TYPE;");
break;
case "name":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_NAME;");
break;
case "href":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_HREF;");
break;
case "disabled":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_DISABLED;");
break;
case "checked":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_CHECKED;");
break;
case "selected":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_SELECTED;");
break;
case "label":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_LABEL;");
break;
case "style":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_STYLE;");
break;
case "placeholder":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_PLACEHOLDER;");
break;
default:
templateParams.push("if(Inferno.Type.ATTR_OTHER." + name + " === undefined) { Inferno.Type.ATTR_OTHER." + name + " = '" + name + "'; }");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_OTHER." + name + ";");
break;
}
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + rootElement + ";");
} else {
templateParams.push("if(Inferno.Type.COMPONENT_PROPS." + name + " === undefined) { Inferno.Type.COMPONENT_PROPS." + name + " = '" + name + "'; }");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.COMPONENT_PROPS." + name + ";");
propRefs.push("fragment.templateElements[" + valueCounter.index + "] = " + rootElement + ";");
}
attrsParams.push("'" + name + "':" + valueName);
templateValues.push(val);
valueCounter.index++;
}
}
};
function buildAttrsParams(root, attrsParams) {
var val = '';
var matches = null;
for (var name in root.attrs) {
val = root.attrs[name];
matches = val.match(/__\$props__\[\d*\]/g);
if (matches === null) {
attrsParams.push("'" + name + "':'" + val + "'");
} else {
attrsParams.push("'" + name + "':" + val);
}
}
};
function isComponentName(tagName) {
if (tagName[0] === tagName[0].toUpperCase()) {
return true;
}
return false;
};
//This takes a vDom array and builds a new function from it, to improve
//repeated performance at the cost of building new Functions()
function buildFunction(root, functionText, component, templateKey) {
var i = 0;
var tagParams = [];
var literalParts = [];
var attrsParams = [];
var attrsValueKeysParams = [];
if (root instanceof Array) {
//throw error about adjacent elements
} else {
//Universal output or Inferno output
if (output === t7.Outputs.Universal || output === t7.Outputs.Mithril) {
//if we have a tag, add an element, check too for a component
if (root.tag != null) {
if (isComponentName(root.tag) === false) {
functionText.push("{tag: '" + root.tag + "'");
//add the key
if (root.key != null) {
tagParams.push("key: " + root.key);
}
//build the attrs
if (root.attrs != null) {
buildAttrsParams(root, attrsParams);
tagParams.push("attrs: {" + attrsParams.join(',') + "}");
}
//build the children for this node
buildUniversalChildren(root, tagParams, true, component);
functionText.push(tagParams.join(',') + "}");
} else {
if (((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
}
if (output === t7.Outputs.Universal) {
//we need to apply the tag components
buildAttrsParams(root, attrsParams);
functionText.push("__$components__." + root.tag + "({" + attrsParams.join(',') + "})");
} else if (output === t7.Outputs.Mithril) {
//we need to apply the tag components
buildAttrsParams(root, attrsParams);
functionText.push("m.component(__$components__." + root.tag + ",{" + attrsParams.join(',') + "})");
}
}
} else {
//add a text entry
functionText.push("'" + root + "'");
}
}
//Inferno output
else if (output === t7.Outputs.Inferno) {
//inferno is a bit more complicated, it requires both a fragment "vdom" and a template to be generated
var key = root.key;
if (root.key === undefined) {
key = null;
}
var template = "null";
var component = null;
var props = null;
var templateParams = [];
var valueCounter = {
index: 0,
t7Required: false
};
var templateValues = [];
if (isComponentName(root.tag) === true) {
buildAttrsParams(root, attrsParams);
component = "__$components__." + root.tag;
props = " {" + attrsParams.join(',') + "}";
} else {
templateParams.push("var root = Inferno.dom.createElement('" + root.tag + "');");
if (root.attrs) {
buildInfernoAttrsParams(root, "root", attrsParams, templateValues, templateParams, valueCounter);
templateParams.push("Inferno.dom.addAttributes(root, {" + attrsParams.join(",") + "});");
}
}
if (root.children.length > 0) {
buildInfernoTemplate(root, valueCounter, null, templateValues, templateParams, component);
templateParams.push("fragment.dom = root;");
var scriptCode = templateParams.join("\n");
if (templateValues.length === 1) {
scriptCode = scriptCode.replace(/fragment.templateValues\[0\]/g, "fragment.templateValue");
scriptCode = scriptCode.replace(/fragment.templateElements\[0\]/g, "fragment.templateElement");
scriptCode = scriptCode.replace(/fragment.templateTypes\[0\]/g, "fragment.templateType");
}
if (isBrowser === true) {
addNewScriptFunction('t7._templateCache["' + templateKey + '"]=function(fragment, t7){"use strict";\n' + scriptCode + '}', templateKey);
} else {
t7._templateCache[templateKey] = new Function('"use strict";var fragment = arguments[0];var t7 = arguments[1];\n' + scriptCode);
}
t7._templateCache[templateKey].key = templateKey;
template = 't7._templateCache["' + templateKey + '"]';
}
var templateValuesString = "";
if (templateValues.length === 1) {
templateValuesString = "templateValue: " + templateValues[0] + ", templateElements: null, templateTypes: null, t7ref: t7";
} else if (templateValues.length > 1) {
templateValuesString = "templateValues: [" + templateValues.join(", ") + "], templateElements: Array(" + templateValues.length + "), templateTypes: Array(" + templateValues.length + "), t7ref: t7";
}
if (component !== null) {
functionText.push("{dom: null, component: " + component + ", props: " + props + ", key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
} else {
functionText.push("{dom: null, key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
}
}
//React output
else if (output === t7.Outputs.React) {
//if we have a tag, add an element
if (root.tag != null) {
//find out if the tag is a React componenet
if (isComponentName(root.tag) === true) {
if (((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
}
functionText.push("React.createElement(__$components__." + root.tag);
} else {
functionText.push("React.createElement('" + root.tag + "'");
}
//the props/attrs
if (root.attrs != null) {
buildAttrsParams(root, attrsParams);
//add the key
if (root.key != null) {
attrsParams.push("'key':" + root.key);
}
tagParams.push("{" + attrsParams.join(',') + "}");
} else {
tagParams.push("null");
}
//build the children for this node
buildReactChildren(root, tagParams, true, component);
functionText.push(tagParams.join(',') + ")");
} else {
//add a text entry
root = root.replace(/(\r\n|\n|\r)/gm, "\\n");
functionText.push("'" + root + "'");
}
}
}
};
function handleChildTextPlaceholders(childText, parent, onlyChild) {
var i = 0;
var parts = childText.split(/(__\$props__\[\d*\])/g)
for (i = 0; i < parts.length; i++) {
if (parts[i].trim() !== "") {
//set the children to this object
parent.children.push(parts[i]);
}
}
childText = null;
return childText;
};
function replaceQuotes(string) {
// string = string.replace(/'/g,"\\'")
if (string.indexOf("'") > -1) {
string = string.replace(/'/g, "\\'")
}
return string;
};
function applyValues(string, values) {
var index = 0;
var re = /__\$props__\[([0-9]*)\]/;
var placeholders = string.match(/__\$props__\[([0-9]*)\]/g);
for (var i = 0; i < placeholders.length; i++) {
index = re.exec(placeholders[i])[1];
string = string.replace(placeholders[i], values[index]);
}
return string;
};
function getVdom(html, values) {
var char = '';
var lastChar = '';
var i = 0;
var n = 0;
var root = null;
var insideTag = false;
var tagContent = '';
var tagName = '';
var vElement = null;
var childText = '';
var parent = null;
var tagData = null;
var skipAppend = false;
var newChild = null;
var hasRootNodeAlready = false;
for (i = 0, n = html.length; i < n; i++) {
//set the char to the current character in the string
char = html[i];
if (char === "<") {
insideTag = true;
} else if (char === ">" && insideTag === true) {
//check if first character is a close tag
if (tagContent[0] === "/") {
//bad closing tag
if (tagContent !== "/" + parent.tag && !selfClosingTags[parent.tag] && !parent.closed) {
console.error("Template error: " + applyValues(html, values));
throw new Error("Expected corresponding t7 closing tag for '" + parent.tag + "'.");
}
//when the childText is not empty
if (childText.trim() !== "") {
//escape quotes etc
childText = replaceQuotes(childText);
//check if childText contains one of our placeholders
childText = handleChildTextPlaceholders(childText, parent, true);
if (childText !== null && parent.children.length === 0) {
parent.children = childText;
} else if (childText != null) {
parent.children.push(childText);
}
}
//move back up the vDom tree
parent = parent.parent;
if (parent) {
parent.closed = true;
}
} else {
//check if we have any content in the childText, if so, it was a text node that needs to be added
if (childText.trim().length > 0 && !(parent instanceof Array)) {
//escape quotes etc
childText = replaceQuotes(childText);
//check the childtext for placeholders
childText = handleChildTextPlaceholders(
childText.replace(/(\r\n|\n|\r)/gm, ""),
parent
);
parent.children.push(childText);
childText = "";
}
//check if there any spaces in the tagContent, if not, we have our tagName
if (tagContent.indexOf(" ") === -1) {
tagData = {};
tagName = tagContent;
} else {
//get the tag data via the getTagData function
tagData = getTagData(tagContent);
tagName = tagData.tag;
}
//now we create out vElement
vElement = {
tag: tagName,
attrs: (tagData && tagData.attrs) ? tagData.attrs : null,
children: [],
closed: tagContent[tagContent.length - 1] === "/" || selfClosingTags[tagName] ? true : false
};
if (tagData && tagData.key) {
vElement.key = tagData.key;
}
//push the node we've constructed to the relevant parent
if (parent === null) {
if (hasRootNodeAlready === true) {
throw new Error("t7 templates must contain only a single root element");
}
hasRootNodeAlready = true;
if (root === null && vElement.closed === false) {
root = parent = vElement;
} else {
root = vElement;
}
} else if (parent instanceof Array) {
parent.push(vElement);
} else {
parent.children.push(vElement);
}
if (!selfClosingTags[tagName] && vElement.closed === false) {
//set our node's parent to our current parent
if (parent === vElement) {
vElement.parent = null;
} else {
vElement.parent = parent;
}
//now assign the parent to our new node
parent = vElement;
}
}
//reset our flags and strings
insideTag = false;
tagContent = '';
childText = '';
} else if (insideTag === true) {
tagContent += char;
lastChar = char;
} else {
childText += char;
lastChar = char;
}
}
//return the root (our constructed vDom)
return root;
}
function getTagData(tagText) {
var parts = [];
var char = '';
var lastChar = '';
var i = 0;
var s = 0;
var n = 0;
var n2 = 0;
var currentString = '';
var inQuotes = false;
var attrParts = [];
var attrs = {};
var key = '';
//build the parts of the tag
for (i = 0, n = tagText.length; i < n; i++) {
char = tagText[i];
if (char === " " && inQuotes === false) {
parts.push(currentString);
currentString = '';
} else if (char === "'") {
if (inQuotes === false) {
inQuotes = true;
} else {
inQuotes = false;
parts.push(currentString);
currentString = '';
}
} else if (char === '"') {
if (inQuotes === false) {
inQuotes = true;
} else {
inQuotes = false;
parts.push(currentString);
currentString = '';
}
} else {
currentString += char;
}
}
if (currentString !== "") {
parts.push(currentString);
}
currentString = '';
//loop through the parts of the tag
for (i = 1, n = parts.length; i < n; i++) {
attrParts = [];
lastChar = '';
currentString = '';
for (s = 0, n2 = parts[i].length; s < n2; s++) {
char = parts[i][s];
//if the character is =, then we're able to split the attribute name and value
if (char === "=") {
attrParts.push(currentString);
currentString = '';
} else {
currentString += char;
lastChar = char;
}
}
if (currentString != "") {
attrParts.push(currentString);
}
if (attrParts.length > 1) {
var matches = attrParts[1].match(/__\$props__\[\d*\]/g);
if (matches !== null) {
attrs[attrParts[0]] = attrParts[1];
} else {
if (attrParts[0] === "key") {
key = attrParts[1];
} else {
attrs[attrParts[0]] = attrParts[1];
}
}
}
}
//return the attributes and the tag name
return {
tag: parts[0],
attrs: attrs,
key: key
}
};
function addNewScriptFunction(scriptString, templateKey) {
var funcCode = scriptString + '\n//# sourceURL=' + templateKey;
var scriptElement = document.createElement('script');
scriptElement.textContent = funcCode;
docHead.appendChild(scriptElement);
}
function createTemplateKey(tpl) {
var hash = 0,
i, chr, len;
if (tpl.length == 0) return tpl;
for (i = 0, len = tpl.length; i < len; i++) {
chr = tpl.charCodeAt(i);
hash = ((hash << 5) - hash) + chr;
hash |= 0;
}
return hash;
};
//main t7 compiling function
function t7(template) {
var fullHtml = null;
var i = 1;
var n = arguments.length;
var functionString = null;
var scriptString = null;
var scriptCode = "";
var templateKey = null;
var tpl = template[0];
var values = [].slice.call(arguments, 1);
//build the template string
for (; i < n; i++) {
tpl += template[i];
};
//set our unique key
templateKey = createTemplateKey(tpl);
//check if we have the template in cache
if (t7._cache[templateKey] == null) {
fullHtml = '';
//put our placeholders around the template parts
for (i = 0, n = template.length; i < n; i++) {
if (i === template.length - 1) {
fullHtml += template[i];
} else {
fullHtml += template[i] + "__$props__[" + i + "]";
}
}
//once we have our vDom array, build an optimal function to improve performance
functionString = [];
buildFunction(
//build a vDom from the HTML
getVdom(fullHtml, values),
functionString,
this,
templateKey
);
scriptCode = functionString.join(',');
//build a new Function and store it depending if on node or browser
if (precompile === true) {
if (output === t7.Outputs.Inferno) {
return {
templateKey: templateKey,
inlineObject: scriptCode
}
} else {
return {
templateKey: templateKey,
template: 'return ' + scriptCode
}
}
return;
} else {
if (isBrowser === true) {
scriptString = 't7._cache["' + templateKey + '"]=function(__$props__, __$components__, t7)';
scriptString += '{"use strict";return ' + scriptCode + '}';
addNewScriptFunction(scriptString, templateKey);
} else {
t7._cache[templateKey] = new Function('"use strict";var __$props__ = arguments[0];var __$components__ = arguments[1];var t7 = arguments[2];return ' + scriptCode);
}
}
}
return t7._cache[templateKey](values, this, t7);
};
var ARRAY_PROPS = {
length: 'number',
sort: 'function',
slice: 'function',
splice: 'function'
};
t7._cache = {};
t7._templateCache = {};
t7.Outputs = {
React: 1,
Universal: 2,
Inferno: 3,
Mithril: 4
};
t7.getTemplateCache = function(id) {
return t7._templateCache[id];
};
t7.getOutput = function() {
return output;
};
t7.setPrecompile = function(val) {
precompile = val;
};
t7.getVersion = function() {
return version;
};
//a lightweight flow control function
//expects truthy and falsey to be functions
t7.if = function(expression, truthy) {
if (expression) {
return {
else: function() {
return truthy();
}
};
} else {
return {
else: function(falsey) {
return falsey();
}
}
}
},
t7.setOutput = function(newOutput) {
output = newOutput;
};
t7.clearCache = function() {
t7._cache = {};
t7._templateCache = {};
};
t7.assign = function(compName) {
throw new Error("Error assigning component '" + compName + "'. You can only assign components from within a module. Please check documentation for t7.module().");
};
t7.module = function(callback) {
var components = {};
var instance = function() {
return t7.apply(components, arguments);
};
instance.assign = function(name, val) {
if (arguments.length === 2) {
components[name] = val;
} else {
for (var key in name) {
components[key] = name[key];
}
}
};
instance.loadComponent = function(name) {
return components[name];
}
instance.if = t7.if;
instance.Outputs = t7.Outputs;
instance.clearCache = t7.clearCache;
instance.setOutput = t7.setOutput;
instance.getOutput = t7.getOutput;
instance.precompile = t7.precompile;
callback(instance);
};
t7.precompile = function() {
};
//set the type to React as default if it exists in global scope
output = typeof React != "undefined" ? t7.Outputs.React : typeof Inferno != "undefined" ? t7.Outputs.Inferno : t7.Outputs.Universal;
return t7;
})();
if (typeof module != "undefined" && module.exports != null) {
module.exports = t7;
}
| t7.js | /*
t7.js is a small, lightweight library for compiling ES2015 template literals
into virtual DOM objects.
By Dominic Gannaway
*/
var t7 = (function() {
"use strict";
//we store created functions in the cache (key is the template string)
var isBrowser = typeof window != "undefined" && document != null;
var docHead = null;
//to save time later, we can pre-create a props object structure to re-use
var output = null;
var selfClosingTags = [];
var precompile = false;
var version = "0.3.0";
if(isBrowser === true) {
docHead = document.getElementsByTagName('head')[0];
}
selfClosingTags = [
'area',
'base',
'br',
'col',
'command',
'embed',
'hr',
'img',
'input',
'keygen',
'link',
'meta',
'param',
'source',
'track',
'wbr'
];
//when creating a new function from a vdom, we'll need to build the vdom's children
function buildUniversalChildren(root, tagParams, childrenProp, component) {
var childrenText = [];
var i = 0;
var n = 0;
var key = "";
var matches = null;
//if the node has children that is an array, handle it with a loop
if(root.children != null && root.children instanceof Array) {
for(i = 0, n = root.children.length; i < n; i++) {
if(root.children[i] != null) {
if(typeof root.children[i] === "string") {
root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm,"");
matches = root.children[i].match(/__\$props__\[\d*\]/g);
if(matches !== null) {
childrenText.push(root.children[i]);
} else {
childrenText.push("'" + root.children[i] + "'");
}
} else {
buildFunction(root.children[i], childrenText, component)
}
}
}
//push the children code into our tag params code
if(childrenText.length === 1) {
tagParams.push((childrenProp ? "children: " : "") + childrenText);
} else {
tagParams.push((childrenProp ? "children: " : "") + "[" + childrenText.join(",") + "]");
}
} else if(root.children != null && typeof root.children === "string") {
root.children = root.children.replace(/(\r\n|\n|\r)/gm,"").trim();
//this ensures its a prop replacement
matches = root.children.match(/__\$props__\[\d*\]/g);
//find any template strings and replace them
if(matches !== null) {
root.children = root.children.replace(/(__\$props__\[.*\])/g, "',$1,'")
}
//if the last two characters are ,', replace them with nothing
if(root.children.substring(root.children.length - 2) === ",'") {
root.children = root.children.substring(0, root.children.length - 2);
tagParams.push((childrenProp ? "children: " : "") + "['" + root.children + "]");
} else {
tagParams.push((childrenProp ? "children: " : "") + "['" + root.children + "']");
}
}
};
function buildInfernoTemplate(root, valueCounter, parentNodeName, templateValues, templateParams, component) {
//TODO this entire function is horrible, needs a revist and refactor
var nodeName = parentNodeName ? parentNodeName + "_" : "n_";
var child = null, matches, valueName = "";
if(root.children instanceof Array) {
for(var i = 0; i < root.children.length; i++) {
child = root.children[i];
if(typeof child === "string" && root.children.length === 1) {
matches = child.match(/__\$props__\[\d*\]/g);
if(matches === null) {
if(!parentNodeName) {
templateParams.push("root.textContent=('" + child + "');");
} else {
templateParams.push(parentNodeName + ".textContent='" + child + "';");
}
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
templateParams.push("if(typeof " + valueName + " !== 'object') {");
if(!parentNodeName) {
templateParams.push("root.textContent=" + valueName + ";");
} else {
templateParams.push(parentNodeName + ".textContent=(" + valueName + " === '' ? ' ' : " + valueName + ");");
}
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.TEXT;");
templateParams.push("} else {");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = (" + valueName + ".constructor === Array ? Inferno.Type.LIST : Inferno.Type.FRAGMENT);");
templateParams.push("}");
if(!parentNodeName) {
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = root;");
} else {
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + parentNodeName + ";");
}
templateValues.push(child);
valueCounter.index++;
}
} else if(typeof child === "string" && root.children.length > 1) {
matches = child.match(/__\$props__\[\d*\]/g);
if(matches === null) {
templateParams.push("var " + nodeName + i + " = Inferno.dom.createText('" + child.replace(/(\r\n|\n|\r)/gm,"") + "');");
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
templateParams.push("var " + nodeName + i + ";");
templateParams.push("if(typeof " + valueName + " !== 'object') {");
templateParams.push(nodeName + i + " = Inferno.dom.createText(" + valueName + ");");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.TEXT_DIRECT;");
templateParams.push("} else {");
templateParams.push(nodeName + i + " = Inferno.dom.createEmpty();");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = (" + valueName + ".constructor === Array ? Inferno.Type.LIST_REPLACE : Inferno.Type.FRAGMENT_REPLACE);");
templateParams.push("}");
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + nodeName + i + ";");
templateValues.push(child);
valueCounter.index++;
}
if(!parentNodeName) {
templateParams.push("root.appendChild(" + nodeName + i + ");");
} else {
templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
}
} else if(child != null) {
if(child.tag) {
if(isComponentName(child.tag) === true) {
valueCounter.t7Required = true;
var props = [];
var propRefs = [];
if(child.attrs) {
buildInfernoAttrsParams(child, nodeName + i, props, templateValues, templateParams, valueCounter, propRefs);
}
templateParams.push("var " + nodeName + i + " = Inferno.dom.createComponent(" + (!parentNodeName ? "root" : parentNodeName) + ", t7.loadComponent('" + child.tag + "'), {" + props.join(",") + "});");
templateParams.push(propRefs.join(""));
} else {
templateParams.push("var " + nodeName + i + " = Inferno.dom.createElement('" + child.tag + "');");
if(child.attrs) {
var attrsParams = [];
buildInfernoAttrsParams(child, nodeName + i, attrsParams, templateValues, templateParams, valueCounter);
templateParams.push("Inferno.dom.addAttributes(" + nodeName + i + ", {" + attrsParams.join(",") + "});");
}
if(child.children) {
buildInfernoTemplate(child, valueCounter, nodeName + i, templateValues, templateParams, component);
}
if(!parentNodeName) {
templateParams.push("root.appendChild(" + nodeName + i + ");");
} else {
templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
}
}
}
}
}
}
}
//when creating a new function from a vdom, we'll need to build the vdom's children
function buildReactChildren(root, tagParams, childrenProp, component) {
var childrenText = [];
var i = 0;
var n = 0;
var matches = null;
//if the node has children that is an array, handle it with a loop
if(root.children != null && root.children instanceof Array) {
//we're building an array in code, so we need an open bracket
for(i = 0, n = root.children.length; i < n; i++) {
if(root.children[i] != null) {
if(typeof root.children[i] === "string") {
root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm,"");
matches = root.children[i].match(/__\$props__\[\d*\]/g);
if(matches != null) {
root.children[i] = root.children[i].replace(/(__\$props__\[[0-9]*\])/g, "$1")
if(root.children[i].substring(root.children[i].length - 1) === ",") {
root.children[i] = root.children[i].substring(0, root.children[i].length - 1);
}
childrenText.push(root.children[i]);
} else {
childrenText.push("'" + root.children[i] + "'");
}
} else {
buildFunction(root.children[i], childrenText, i === root.children.length - 1, component)
}
}
}
//push the children code into our tag params code
if(childrenText.length > 0) {
tagParams.push(childrenText.join(","));
}
} else if(root.children != null && typeof root.children === "string") {
root.children = root.children.replace(/(\r\n|\n|\r)/gm,"");
tagParams.push("'" + root.children + "'");
}
};
function buildInfernoAttrsParams(root, rootElement, attrsParams, templateValues, templateParams, valueCounter, propRefs) {
var val = '', valueName;
var matches = null;
for(var name in root.attrs) {
val = root.attrs[name];
matches = val.match(/__\$props__\[\d*\]/g);
if(matches === null) {
attrsParams.push("'" + name + "':'" + val + "'");
} else {
valueName = "fragment.templateValues[" + valueCounter.index + "]";
if(!propRefs) {
switch(name) {
case "class":
case "className":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_CLASS;");
break;
case "id":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_ID;");
break;
case "value":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_VALUE;");
break;
case "width":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_WIDTH;");
break;
case "height":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_HEIGHT;");
break;
case "type":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_TYPE;");
break;
case "name":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_NAME;");
break;
case "href":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_HREF;");
break;
case "disabled":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_DISABLED;");
break;
case "checked":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_CHECKED;");
break;
case "selected":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_SELECTED;");
break;
case "label":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_LABEL;");
break;
case "style":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_STYLE;");
break;
case "placeholder":
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_PLACEHOLDER;");
break;
default:
templateParams.push("if(Inferno.Type.ATTR_OTHER." + name + " === undefined) { Inferno.Type.ATTR_OTHER." + name + " = '" + name + "'; }");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_OTHER." + name + ";");
break;
}
templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + rootElement + ";");
} else {
templateParams.push("if(Inferno.Type.COMPONENT_PROPS." + name + " === undefined) { Inferno.Type.COMPONENT_PROPS." + name + " = '" + name + "'; }");
templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.COMPONENT_PROPS." + name + ";");
propRefs.push("fragment.templateElements[" + valueCounter.index + "] = " + rootElement + ";");
}
attrsParams.push("'" + name + "':" + valueName);
templateValues.push(val);
valueCounter.index++;
}
}
};
function buildAttrsParams(root, attrsParams) {
var val = '';
var matches = null;
for(var name in root.attrs) {
val = root.attrs[name];
matches = val.match(/__\$props__\[\d*\]/g);
if(matches === null) {
attrsParams.push("'" + name + "':'" + val + "'");
} else {
attrsParams.push("'" + name + "':" + val);
}
}
};
function isComponentName(tagName) {
if(tagName[0] === tagName[0].toUpperCase()) {
return true;
}
return false;
};
//This takes a vDom array and builds a new function from it, to improve
//repeated performance at the cost of building new Functions()
function buildFunction(root, functionText, component, templateKey) {
var i = 0;
var tagParams = [];
var literalParts = [];
var attrsParams = [];
var attrsValueKeysParams = [];
if(root instanceof Array) {
//throw error about adjacent elements
} else {
//Universal output or Inferno output
if(output === t7.Outputs.Universal || output === t7.Outputs.Mithril) {
//if we have a tag, add an element, check too for a component
if(root.tag != null) {
if(isComponentName(root.tag) === false) {
functionText.push("{tag: '" + root.tag + "'");
//add the key
if(root.key != null) {
tagParams.push("key: " + root.key);
}
//build the attrs
if(root.attrs != null) {
buildAttrsParams(root, attrsParams);
tagParams.push("attrs: {" + attrsParams.join(',') + "}");
}
//build the children for this node
buildUniversalChildren(root, tagParams, true, component);
functionText.push(tagParams.join(',') + "}");
} else {
if(((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
}
if(output === t7.Outputs.Universal) {
//we need to apply the tag components
buildAttrsParams(root, attrsParams);
functionText.push("__$components__." + root.tag + "({" + attrsParams.join(',') + "})");
} else if(output === t7.Outputs.Mithril) {
//we need to apply the tag components
buildAttrsParams(root, attrsParams);
functionText.push("m.component(__$components__." + root.tag + ",{" + attrsParams.join(',') + "})");
}
}
} else {
//add a text entry
functionText.push("'" + root + "'");
}
}
//Inferno output
else if(output === t7.Outputs.Inferno) {
//inferno is a bit more complicated, it requires both a fragment "vdom" and a template to be generated
var key = root.key;
if(root.key === undefined) {
key = null;
}
var template = "null";
var component = null;
var props = null;
var templateParams = [];
var valueCounter = {index: 0, t7Required: false};
var templateValues = [];
if(isComponentName(root.tag) === true) {
buildAttrsParams(root, attrsParams);
component = "__$components__." + root.tag;
props = " {" + attrsParams.join(',') + "}";
} else {
templateParams.push("var root = Inferno.dom.createElement('" + root.tag + "');");
if(root.attrs) {
buildInfernoAttrsParams(root, "root", attrsParams, templateValues, templateParams, valueCounter);
templateParams.push("Inferno.dom.addAttributes(root, {" + attrsParams.join(",") + "});");
}
}
if(root.children.length > 0) {
buildInfernoTemplate(root, valueCounter, null, templateValues, templateParams, component);
templateParams.push("fragment.dom = root;");
var scriptCode = templateParams.join("\n");
if(templateValues.length === 1) {
scriptCode = scriptCode.replace(/fragment.templateValues\[0\]/g, "fragment.templateValue");
scriptCode = scriptCode.replace(/fragment.templateElements\[0\]/g, "fragment.templateElement");
scriptCode = scriptCode.replace(/fragment.templateTypes\[0\]/g, "fragment.templateType");
}
if(isBrowser === true) {
addNewScriptFunction('t7._templateCache["' + templateKey + '"]=function(fragment, t7){"use strict";\n' + scriptCode + '}', templateKey);
} else {
t7._templateCache[templateKey] = new Function('"use strict";var fragment = arguments[0];var t7 = arguments[1];\n' + scriptCode);
}
t7._templateCache[templateKey].key = templateKey;
template = 't7._templateCache["' + templateKey + '"]';
}
var templateValuesString = "";
if(templateValues.length === 1) {
templateValuesString = "templateValue: " + templateValues[0] + ", templateElements: null, templateTypes: null, t7ref: t7";
} else if (templateValues.length > 1) {
templateValuesString = "templateValues: [" + templateValues.join(", ") + "], templateElements: Array(" + templateValues.length + "), templateTypes: Array(" + templateValues.length + "), t7ref: t7";
}
if(component !== null) {
functionText.push("{dom: null, component: " + component + ", props: " + props + ", key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
} else {
functionText.push("{dom: null, key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
}
}
//React output
else if(output === t7.Outputs.React) {
//if we have a tag, add an element
if(root.tag != null) {
//find out if the tag is a React componenet
if(isComponentName(root.tag) === true) {
if(((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
}
functionText.push("React.createElement(__$components__." + root.tag);
} else {
functionText.push("React.createElement('" + root.tag + "'");
}
//the props/attrs
if(root.attrs != null) {
buildAttrsParams(root, attrsParams);
//add the key
if(root.key != null) {
attrsParams.push("'key':" + root.key);
}
tagParams.push("{" + attrsParams.join(',') + "}");
} else {
tagParams.push("null");
}
//build the children for this node
buildReactChildren(root, tagParams, true, component);
functionText.push(tagParams.join(',') + ")");
} else {
//add a text entry
root = root.replace(/(\r\n|\n|\r)/gm,"\\n");
functionText.push("'" + root + "'");
}
}
}
};
function handleChildTextPlaceholders(childText, parent, onlyChild) {
var i = 0;
var parts = childText.split(/(__\$props__\[\d*\])/g)
for(i = 0; i < parts.length; i++) {
if(parts[i].trim() !== "") {
//set the children to this object
parent.children.push(parts[i]);
}
}
childText = null;
return childText;
};
function replaceQuotes(string) {
// string = string.replace(/'/g,"\\'")
if(string.indexOf("'") > -1) {
string = string.replace(/'/g,"\\'")
}
return string;
};
function applyValues(string, values) {
var index = 0;
var re = /__\$props__\[([0-9]*)\]/;
var placeholders = string.match(/__\$props__\[([0-9]*)\]/g);
for(var i = 0; i < placeholders.length; i++) {
index = re.exec(placeholders[i])[1];
string = string.replace(placeholders[i], values[index]);
}
return string;
};
function getVdom(html, values) {
var char = '';
var lastChar = '';
var i = 0;
var n = 0;
var root = null;
var insideTag = false;
var tagContent = '';
var tagName = '';
var vElement = null;
var childText = '';
var parent = null;
var tagData = null;
var skipAppend = false;
var newChild = null;
for(i = 0, n = html.length; i < n; i++) {
//set the char to the current character in the string
char = html[i];
if (char === "<") {
insideTag = true;
} else if(char === ">" && insideTag === true) {
//check if first character is a close tag
if(tagContent[0] === "/") {
//bad closing tag
if(tagContent !== "/" + parent.tag && selfClosingTags.indexOf(parent.tag) === -1 && !parent.closed) {
console.error("Template error: " + applyValues(html, values));
throw new Error("Expected corresponding t7 closing tag for '" + parent.tag + "'.");
}
//when the childText is not empty
if(childText.trim() !== "") {
//escape quotes etc
childText = replaceQuotes(childText);
//check if childText contains one of our placeholders
childText = handleChildTextPlaceholders(childText, parent, true);
if(childText !== null && parent.children.length === 0) {
parent.children = childText;
} else if (childText != null) {
parent.children.push(childText);
}
}
//move back up the vDom tree
parent = parent.parent;
if(parent) {
parent.closed = true;
}
} else {
//check if we have any content in the childText, if so, it was a text node that needs to be added
if(childText.trim().length > 0 && !(parent instanceof Array)) {
//escape quotes etc
childText = replaceQuotes(childText);
//check the childtext for placeholders
childText = handleChildTextPlaceholders(
childText.replace(/(\r\n|\n|\r)/gm,""),
parent
);
parent.children.push(childText);
childText = "";
}
//check if there any spaces in the tagContent, if not, we have our tagName
if(tagContent.indexOf(" ") === -1) {
tagData = {};
tagName = tagContent;
} else {
//get the tag data via the getTagData function
tagData = getTagData(tagContent);
tagName = tagData.tag;
}
//now we create out vElement
vElement = {
tag: tagName,
attrs: (tagData && tagData.attrs) ? tagData.attrs : null,
children: [],
closed: tagContent[tagContent.length - 1] === "/" || selfClosingTags.indexOf(tagName) > -1 ? true : false
};
if(tagData && tagData.key) {
vElement.key = tagData.key;
}
//push the node we've constructed to the relevant parent
if(parent === null) {
if(root === null) {
root = parent = vElement;
} else {
throw new Error("t7 templates must contain only a single root element");
}
} else if (parent instanceof Array) {
parent.push(vElement);
} else {
parent.children.push(vElement);
}
if(selfClosingTags.indexOf(tagName) === -1 ) {
//set our node's parent to our current parent
if(parent === vElement) {
vElement.parent = null;
} else {
vElement.parent = parent;
}
//now assign the parent to our new node
parent = vElement;
}
}
//reset our flags and strings
insideTag = false;
tagContent = '';
childText = '';
} else if (insideTag === true) {
tagContent += char;
lastChar = char;
} else {
childText += char;
lastChar = char;
}
}
//return the root (our constructed vDom)
return root;
}
function getTagData(tagText) {
var parts = [];
var char = '';
var lastChar = '';
var i = 0;
var s = 0;
var n = 0;
var n2 = 0;
var currentString = '';
var inQuotes = false;
var attrParts = [];
var attrs = {};
var key = '';
//build the parts of the tag
for(i = 0, n = tagText.length; i < n; i++) {
char = tagText[i];
if(char === " " && inQuotes === false) {
parts.push(currentString);
currentString = '';
} else if(char === "'") {
if(inQuotes === false) {
inQuotes = true;
} else {
inQuotes = false;
parts.push(currentString);
currentString = '';
}
} else if(char === '"') {
if(inQuotes === false) {
inQuotes = true;
} else {
inQuotes = false;
parts.push(currentString);
currentString = '';
}
} else {
currentString += char;
}
}
if(currentString !== "") {
parts.push(currentString);
}
currentString = '';
//loop through the parts of the tag
for(i = 1, n = parts.length; i < n; i++) {
attrParts = [];
lastChar= '';
currentString = '';
for(s = 0, n2 = parts[i].length; s < n2; s++) {
char = parts[i][s];
//if the character is =, then we're able to split the attribute name and value
if(char === "=") {
attrParts.push(currentString);
currentString = '';
} else {
currentString += char;
lastChar = char;
}
}
if(currentString != "") {
attrParts.push(currentString);
}
if(attrParts.length > 1) {
var matches = attrParts[1].match(/__\$props__\[\d*\]/g);
if(matches !== null) {
attrs[attrParts[0]] = attrParts[1];
} else {
if(attrParts[0] === "key") {
key = attrParts[1];
} else {
attrs[attrParts[0]] = attrParts[1];
}
}
}
}
//return the attributes and the tag name
return {
tag: parts[0],
attrs: attrs,
key: key
}
};
function addNewScriptFunction(scriptString, templateKey) {
var funcCode = scriptString + '\n//# sourceURL=' + templateKey;
var scriptElement = document.createElement('script');
scriptElement.textContent = funcCode;
docHead.appendChild(scriptElement);
}
function createTemplateKey(tpl) {
var hash = 0, i, chr, len;
if (tpl.length == 0) return tpl;
for (i = 0, len = tpl.length; i < len; i++) {
chr = tpl.charCodeAt(i);
hash = ((hash << 5) - hash) + chr;
hash |= 0;
}
return hash;
};
//main t7 compiling function
function t7(template) {
var fullHtml = null;
var i = 1;
var n = arguments.length;
var functionString = null;
var scriptString = null;
var scriptCode = "";
var templateKey = null;
var tpl = template[0];
var values = [].slice.call(arguments, 1);
//build the template string
for(; i < n; i++) {
tpl += template[i];
};
//set our unique key
templateKey = createTemplateKey(tpl);
//check if we have the template in cache
if(t7._cache[templateKey] == null) {
fullHtml = '';
//put our placeholders around the template parts
for(i = 0, n = template.length; i < n; i++) {
if(i === template.length - 1) {
fullHtml += template[i];
} else {
fullHtml += template[i] + "__$props__[" + i + "]";
}
}
//once we have our vDom array, build an optimal function to improve performance
functionString = [];
buildFunction(
//build a vDom from the HTML
getVdom(fullHtml, values),
functionString,
this,
templateKey
);
scriptCode = functionString.join(',');
//build a new Function and store it depending if on node or browser
if(precompile === true) {
if(output === t7.Outputs.Inferno) {
return {
templateKey: templateKey,
inlineObject: scriptCode
}
} else {
return {
templateKey: templateKey,
template: 'return ' + scriptCode
}
}
return;
} else {
if(isBrowser === true) {
scriptString = 't7._cache["' + templateKey + '"]=function(__$props__, __$components__, t7)';
scriptString += '{"use strict";return ' + scriptCode + '}';
addNewScriptFunction(scriptString, templateKey);
} else {
t7._cache[templateKey] = new Function('"use strict";var __$props__ = arguments[0];var __$components__ = arguments[1];var t7 = arguments[2];return ' + scriptCode);
}
}
}
return t7._cache[templateKey](values, this, t7);
};
var ARRAY_PROPS = {
length: 'number',
sort: 'function',
slice: 'function',
splice: 'function'
};
t7._cache = {};
t7._templateCache = {};
t7.Outputs = {
React: 1,
Universal: 2,
Inferno: 3,
Mithril: 4
};
t7.getTemplateCache = function(id) {
return t7._templateCache[id];
};
t7.getOutput = function() {
return output;
};
t7.setPrecompile = function(val) {
precompile = val;
};
t7.getVersion = function() {
return version;
};
//a lightweight flow control function
//expects truthy and falsey to be functions
t7.if = function(expression, truthy) {
if(expression) {
return {
else: function() {
return truthy();
}
};
} else {
return {
else: function(falsey) {
return falsey();
}
}
}
},
t7.setOutput = function(newOutput) {
output = newOutput;
};
t7.clearCache = function() {
t7._cache = {};
t7._templateCache = {};
};
t7.assign = function(compName) {
throw new Error("Error assigning component '" + compName+ "'. You can only assign components from within a module. Please check documentation for t7.module().");
};
t7.module = function(callback) {
var components = {};
var instance = function() {
return t7.apply(components, arguments);
};
instance.assign = function(name, val) {
if(arguments.length === 2) {
components[name] = val;
} else {
for(var key in name) {
components[key] = name[key];
}
}
};
instance.loadComponent = function(name) {
return components[name];
}
instance.if = t7.if;
instance.Outputs = t7.Outputs;
instance.clearCache = t7.clearCache;
instance.setOutput = t7.setOutput;
instance.getOutput = t7.getOutput;
instance.precompile = t7.precompile;
callback(instance);
};
t7.precompile = function() {
};
//set the type to React as default if it exists in global scope
output = typeof React != "undefined" ? t7.Outputs.React
: typeof Inferno != "undefined" ? t7.Outputs.Inferno : t7.Outputs.Universal;
return t7;
})();
if(typeof module != "undefined" && module.exports != null) {
module.exports = t7;
}
| Updated t7 to latest
| t7.js | Updated t7 to latest | <ide><path>7.js
<ide> var docHead = null;
<ide> //to save time later, we can pre-create a props object structure to re-use
<ide> var output = null;
<del> var selfClosingTags = [];
<ide> var precompile = false;
<ide> var version = "0.3.0";
<ide>
<del> if(isBrowser === true) {
<add> if (isBrowser === true) {
<ide> docHead = document.getElementsByTagName('head')[0];
<ide> }
<ide>
<del> selfClosingTags = [
<del> 'area',
<del> 'base',
<del> 'br',
<del> 'col',
<del> 'command',
<del> 'embed',
<del> 'hr',
<del> 'img',
<del> 'input',
<del> 'keygen',
<del> 'link',
<del> 'meta',
<del> 'param',
<del> 'source',
<del> 'track',
<del> 'wbr'
<del> ];
<add> var selfClosingTags = {
<add> area: true,
<add> base: true,
<add> basefont: true,
<add> br: true,
<add> col: true,
<add> command: true,
<add> embed: true,
<add> frame: true,
<add> hr: true,
<add> img: true,
<add> input: true,
<add> isindex: true,
<add> keygen: true,
<add> link: true,
<add> meta: true,
<add> param: true,
<add> source: true,
<add> track: true,
<add> wbr: true,
<add>
<add> //common self closing svg elements
<add> path: true,
<add> circle: true,
<add> ellipse: true,
<add> line: true,
<add> rect: true,
<add> use: true,
<add> stop: true,
<add> polyline: true,
<add> polygon: true
<add> };
<ide>
<ide> //when creating a new function from a vdom, we'll need to build the vdom's children
<ide> function buildUniversalChildren(root, tagParams, childrenProp, component) {
<ide> var matches = null;
<ide>
<ide> //if the node has children that is an array, handle it with a loop
<del> if(root.children != null && root.children instanceof Array) {
<del> for(i = 0, n = root.children.length; i < n; i++) {
<del> if(root.children[i] != null) {
<del> if(typeof root.children[i] === "string") {
<del> root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm,"");
<add> if (root.children != null && root.children instanceof Array) {
<add> for (i = 0, n = root.children.length; i < n; i++) {
<add> if (root.children[i] != null) {
<add> if (typeof root.children[i] === "string") {
<add> root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm, "");
<ide> matches = root.children[i].match(/__\$props__\[\d*\]/g);
<del> if(matches !== null) {
<add> if (matches !== null) {
<ide> childrenText.push(root.children[i]);
<ide> } else {
<ide> childrenText.push("'" + root.children[i] + "'");
<ide> }
<ide> }
<ide> //push the children code into our tag params code
<del> if(childrenText.length === 1) {
<add> if (childrenText.length === 1) {
<ide> tagParams.push((childrenProp ? "children: " : "") + childrenText);
<del> } else {
<add> } else if (childrenText.length > 1) {
<ide> tagParams.push((childrenProp ? "children: " : "") + "[" + childrenText.join(",") + "]");
<ide> }
<ide>
<del> } else if(root.children != null && typeof root.children === "string") {
<del> root.children = root.children.replace(/(\r\n|\n|\r)/gm,"").trim();
<add> } else if (root.children != null && typeof root.children === "string") {
<add> root.children = root.children.replace(/(\r\n|\n|\r)/gm, "").trim();
<ide> //this ensures its a prop replacement
<ide> matches = root.children.match(/__\$props__\[\d*\]/g);
<ide> //find any template strings and replace them
<del> if(matches !== null) {
<add> if (matches !== null) {
<ide> root.children = root.children.replace(/(__\$props__\[.*\])/g, "',$1,'")
<ide> }
<ide> //if the last two characters are ,', replace them with nothing
<del> if(root.children.substring(root.children.length - 2) === ",'") {
<add> if (root.children.substring(root.children.length - 2) === ",'") {
<ide> root.children = root.children.substring(0, root.children.length - 2);
<ide> tagParams.push((childrenProp ? "children: " : "") + "['" + root.children + "]");
<ide> } else {
<ide> function buildInfernoTemplate(root, valueCounter, parentNodeName, templateValues, templateParams, component) {
<ide> //TODO this entire function is horrible, needs a revist and refactor
<ide> var nodeName = parentNodeName ? parentNodeName + "_" : "n_";
<del> var child = null, matches, valueName = "";
<del>
<del> if(root.children instanceof Array) {
<del> for(var i = 0; i < root.children.length; i++) {
<add> var child = null,
<add> matches, valueName = "";
<add>
<add> if (root.children instanceof Array) {
<add> for (var i = 0; i < root.children.length; i++) {
<ide> child = root.children[i];
<del> if(typeof child === "string" && root.children.length === 1) {
<add> if (typeof child === "string" && root.children.length === 1) {
<ide> matches = child.match(/__\$props__\[\d*\]/g);
<del> if(matches === null) {
<del> if(!parentNodeName) {
<add> if (matches === null) {
<add> if (!parentNodeName) {
<ide> templateParams.push("root.textContent=('" + child + "');");
<ide> } else {
<del> templateParams.push(parentNodeName + ".textContent='" + child + "';");
<add> templateParams.push(parentNodeName + ".textContent='" + child + "';");
<ide> }
<ide> } else {
<ide> valueName = "fragment.templateValues[" + valueCounter.index + "]";
<ide> templateParams.push("if(typeof " + valueName + " !== 'object') {");
<del> if(!parentNodeName) {
<add> if (!parentNodeName) {
<ide> templateParams.push("root.textContent=" + valueName + ";");
<ide> } else {
<del> templateParams.push(parentNodeName + ".textContent=(" + valueName + " === '' ? ' ' : " + valueName + ");");
<add> templateParams.push(parentNodeName + ".textContent=(" + valueName + " === '' ? ' ' : " + valueName + ");");
<ide> }
<ide> templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.TEXT;");
<ide> templateParams.push("} else {");
<ide> templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = (" + valueName + ".constructor === Array ? Inferno.Type.LIST : Inferno.Type.FRAGMENT);");
<ide> templateParams.push("}");
<del> if(!parentNodeName) {
<add> if (!parentNodeName) {
<ide> templateParams.push("fragment.templateElements[" + valueCounter.index + "] = root;");
<ide> } else {
<ide> templateParams.push("fragment.templateElements[" + valueCounter.index + "] = " + parentNodeName + ";");
<ide> templateValues.push(child);
<ide> valueCounter.index++;
<ide> }
<del> } else if(typeof child === "string" && root.children.length > 1) {
<add> } else if (typeof child === "string" && root.children.length > 1) {
<ide> matches = child.match(/__\$props__\[\d*\]/g);
<del> if(matches === null) {
<del> templateParams.push("var " + nodeName + i + " = Inferno.dom.createText('" + child.replace(/(\r\n|\n|\r)/gm,"") + "');");
<add> if (matches === null) {
<add> templateParams.push("var " + nodeName + i + " = Inferno.dom.createText('" + child.replace(/(\r\n|\n|\r)/gm, "") + "');");
<ide> } else {
<ide> valueName = "fragment.templateValues[" + valueCounter.index + "]";
<ide> templateParams.push("var " + nodeName + i + ";");
<ide> templateValues.push(child);
<ide> valueCounter.index++;
<ide> }
<del> if(!parentNodeName) {
<del> templateParams.push("root.appendChild(" + nodeName + i + ");");
<del> } else {
<del> templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
<del> }
<del> } else if(child != null) {
<del> if(child.tag) {
<del> if(isComponentName(child.tag) === true) {
<add> if (!parentNodeName) {
<add> templateParams.push("root.appendChild(" + nodeName + i + ");");
<add> } else {
<add> templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
<add> }
<add> } else if (child != null) {
<add> if (child.tag) {
<add> if (isComponentName(child.tag) === true) {
<ide> valueCounter.t7Required = true;
<ide> var props = [];
<ide> var propRefs = [];
<del> if(child.attrs) {
<add> if (child.attrs) {
<ide> buildInfernoAttrsParams(child, nodeName + i, props, templateValues, templateParams, valueCounter, propRefs);
<ide> }
<ide> templateParams.push("var " + nodeName + i + " = Inferno.dom.createComponent(" + (!parentNodeName ? "root" : parentNodeName) + ", t7.loadComponent('" + child.tag + "'), {" + props.join(",") + "});");
<ide> templateParams.push(propRefs.join(""));
<ide> } else {
<ide> templateParams.push("var " + nodeName + i + " = Inferno.dom.createElement('" + child.tag + "');");
<del> if(child.attrs) {
<add> if (child.attrs) {
<ide> var attrsParams = [];
<ide> buildInfernoAttrsParams(child, nodeName + i, attrsParams, templateValues, templateParams, valueCounter);
<del> templateParams.push("Inferno.dom.addAttributes(" + nodeName + i + ", {" + attrsParams.join(",") + "});");
<add> templateParams.push("Inferno.dom.addAttributes(" + nodeName + i + ", {" + attrsParams.join(",") + "});");
<ide> }
<del> if(child.children) {
<add> if (child.children) {
<ide> buildInfernoTemplate(child, valueCounter, nodeName + i, templateValues, templateParams, component);
<ide> }
<del> if(!parentNodeName) {
<del> templateParams.push("root.appendChild(" + nodeName + i + ");");
<add> if (!parentNodeName) {
<add> templateParams.push("root.appendChild(" + nodeName + i + ");");
<ide> } else {
<del> templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
<add> templateParams.push(parentNodeName + ".appendChild(" + nodeName + i + ");");
<ide> }
<ide> }
<ide> }
<ide> var matches = null;
<ide>
<ide> //if the node has children that is an array, handle it with a loop
<del> if(root.children != null && root.children instanceof Array) {
<add> if (root.children != null && root.children instanceof Array) {
<ide> //we're building an array in code, so we need an open bracket
<del> for(i = 0, n = root.children.length; i < n; i++) {
<del> if(root.children[i] != null) {
<del> if(typeof root.children[i] === "string") {
<del> root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm,"");
<add> for (i = 0, n = root.children.length; i < n; i++) {
<add> if (root.children[i] != null) {
<add> if (typeof root.children[i] === "string") {
<add> root.children[i] = root.children[i].replace(/(\r\n|\n|\r)/gm, "");
<ide> matches = root.children[i].match(/__\$props__\[\d*\]/g);
<del> if(matches != null) {
<add> if (matches != null) {
<ide> root.children[i] = root.children[i].replace(/(__\$props__\[[0-9]*\])/g, "$1")
<del> if(root.children[i].substring(root.children[i].length - 1) === ",") {
<add> if (root.children[i].substring(root.children[i].length - 1) === ",") {
<ide> root.children[i] = root.children[i].substring(0, root.children[i].length - 1);
<ide> }
<ide> childrenText.push(root.children[i]);
<ide> }
<ide> }
<ide> //push the children code into our tag params code
<del> if(childrenText.length > 0) {
<add> if (childrenText.length > 0) {
<ide> tagParams.push(childrenText.join(","));
<ide> }
<ide>
<del> } else if(root.children != null && typeof root.children === "string") {
<del> root.children = root.children.replace(/(\r\n|\n|\r)/gm,"");
<add> } else if (root.children != null && typeof root.children === "string") {
<add> root.children = root.children.replace(/(\r\n|\n|\r)/gm, "");
<ide> tagParams.push("'" + root.children + "'");
<ide> }
<ide> };
<ide>
<ide> function buildInfernoAttrsParams(root, rootElement, attrsParams, templateValues, templateParams, valueCounter, propRefs) {
<del> var val = '', valueName;
<add> var val = '',
<add> valueName;
<ide> var matches = null;
<del> for(var name in root.attrs) {
<add> for (var name in root.attrs) {
<ide> val = root.attrs[name];
<ide> matches = val.match(/__\$props__\[\d*\]/g);
<del> if(matches === null) {
<add> if (matches === null) {
<ide> attrsParams.push("'" + name + "':'" + val + "'");
<ide> } else {
<ide> valueName = "fragment.templateValues[" + valueCounter.index + "]";
<del> if(!propRefs) {
<del> switch(name) {
<add> if (!propRefs) {
<add> switch (name) {
<ide> case "class":
<ide> case "className":
<ide> templateParams.push("fragment.templateTypes[" + valueCounter.index + "] = Inferno.Type.ATTR_CLASS;");
<ide> function buildAttrsParams(root, attrsParams) {
<ide> var val = '';
<ide> var matches = null;
<del> for(var name in root.attrs) {
<add> for (var name in root.attrs) {
<ide> val = root.attrs[name];
<ide> matches = val.match(/__\$props__\[\d*\]/g);
<del> if(matches === null) {
<add> if (matches === null) {
<ide> attrsParams.push("'" + name + "':'" + val + "'");
<ide> } else {
<ide> attrsParams.push("'" + name + "':" + val);
<ide> };
<ide>
<ide> function isComponentName(tagName) {
<del> if(tagName[0] === tagName[0].toUpperCase()) {
<add> if (tagName[0] === tagName[0].toUpperCase()) {
<ide> return true;
<ide> }
<ide> return false;
<ide> var attrsParams = [];
<ide> var attrsValueKeysParams = [];
<ide>
<del> if(root instanceof Array) {
<add> if (root instanceof Array) {
<ide> //throw error about adjacent elements
<ide> } else {
<ide> //Universal output or Inferno output
<del> if(output === t7.Outputs.Universal || output === t7.Outputs.Mithril) {
<add> if (output === t7.Outputs.Universal || output === t7.Outputs.Mithril) {
<ide> //if we have a tag, add an element, check too for a component
<del> if(root.tag != null) {
<del> if(isComponentName(root.tag) === false) {
<add> if (root.tag != null) {
<add> if (isComponentName(root.tag) === false) {
<ide> functionText.push("{tag: '" + root.tag + "'");
<ide> //add the key
<del> if(root.key != null) {
<add> if (root.key != null) {
<ide> tagParams.push("key: " + root.key);
<ide> }
<ide> //build the attrs
<del> if(root.attrs != null) {
<add> if (root.attrs != null) {
<ide> buildAttrsParams(root, attrsParams);
<ide> tagParams.push("attrs: {" + attrsParams.join(',') + "}");
<ide> }
<ide> buildUniversalChildren(root, tagParams, true, component);
<ide> functionText.push(tagParams.join(',') + "}");
<ide> } else {
<del> if(((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
<add> if (((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
<ide> throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
<ide> }
<del> if(output === t7.Outputs.Universal) {
<add> if (output === t7.Outputs.Universal) {
<ide> //we need to apply the tag components
<ide> buildAttrsParams(root, attrsParams);
<ide> functionText.push("__$components__." + root.tag + "({" + attrsParams.join(',') + "})");
<del> } else if(output === t7.Outputs.Mithril) {
<add> } else if (output === t7.Outputs.Mithril) {
<ide> //we need to apply the tag components
<ide> buildAttrsParams(root, attrsParams);
<ide> functionText.push("m.component(__$components__." + root.tag + ",{" + attrsParams.join(',') + "})");
<ide> }
<ide> }
<ide> //Inferno output
<del> else if(output === t7.Outputs.Inferno) {
<add> else if (output === t7.Outputs.Inferno) {
<ide> //inferno is a bit more complicated, it requires both a fragment "vdom" and a template to be generated
<ide> var key = root.key;
<del> if(root.key === undefined) {
<add> if (root.key === undefined) {
<ide> key = null;
<ide> }
<ide> var template = "null";
<ide> var component = null;
<ide> var props = null;
<ide> var templateParams = [];
<del> var valueCounter = {index: 0, t7Required: false};
<add> var valueCounter = {
<add> index: 0,
<add> t7Required: false
<add> };
<ide> var templateValues = [];
<ide>
<del> if(isComponentName(root.tag) === true) {
<add> if (isComponentName(root.tag) === true) {
<ide> buildAttrsParams(root, attrsParams);
<ide> component = "__$components__." + root.tag;
<ide> props = " {" + attrsParams.join(',') + "}";
<ide> } else {
<ide> templateParams.push("var root = Inferno.dom.createElement('" + root.tag + "');");
<del> if(root.attrs) {
<add> if (root.attrs) {
<ide> buildInfernoAttrsParams(root, "root", attrsParams, templateValues, templateParams, valueCounter);
<ide> templateParams.push("Inferno.dom.addAttributes(root, {" + attrsParams.join(",") + "});");
<ide> }
<ide> }
<ide>
<del> if(root.children.length > 0) {
<add> if (root.children.length > 0) {
<ide> buildInfernoTemplate(root, valueCounter, null, templateValues, templateParams, component);
<ide> templateParams.push("fragment.dom = root;");
<ide> var scriptCode = templateParams.join("\n");
<del> if(templateValues.length === 1) {
<add> if (templateValues.length === 1) {
<ide> scriptCode = scriptCode.replace(/fragment.templateValues\[0\]/g, "fragment.templateValue");
<ide> scriptCode = scriptCode.replace(/fragment.templateElements\[0\]/g, "fragment.templateElement");
<ide> scriptCode = scriptCode.replace(/fragment.templateTypes\[0\]/g, "fragment.templateType");
<ide> }
<del> if(isBrowser === true) {
<add> if (isBrowser === true) {
<ide> addNewScriptFunction('t7._templateCache["' + templateKey + '"]=function(fragment, t7){"use strict";\n' + scriptCode + '}', templateKey);
<ide> } else {
<ide> t7._templateCache[templateKey] = new Function('"use strict";var fragment = arguments[0];var t7 = arguments[1];\n' + scriptCode);
<ide>
<ide> var templateValuesString = "";
<ide>
<del> if(templateValues.length === 1) {
<add> if (templateValues.length === 1) {
<ide> templateValuesString = "templateValue: " + templateValues[0] + ", templateElements: null, templateTypes: null, t7ref: t7";
<ide> } else if (templateValues.length > 1) {
<ide> templateValuesString = "templateValues: [" + templateValues.join(", ") + "], templateElements: Array(" + templateValues.length + "), templateTypes: Array(" + templateValues.length + "), t7ref: t7";
<ide> }
<ide>
<del> if(component !== null) {
<add> if (component !== null) {
<ide> functionText.push("{dom: null, component: " + component + ", props: " + props + ", key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
<ide> } else {
<ide> functionText.push("{dom: null, key: " + key + ", template: " + template + (root.children.length > 0 ? ", " + templateValuesString : "") + "}");
<ide> }
<ide> }
<ide> //React output
<del> else if(output === t7.Outputs.React) {
<add> else if (output === t7.Outputs.React) {
<ide> //if we have a tag, add an element
<del> if(root.tag != null) {
<add> if (root.tag != null) {
<ide> //find out if the tag is a React componenet
<del> if(isComponentName(root.tag) === true) {
<del> if(((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
<add> if (isComponentName(root.tag) === true) {
<add> if (((typeof window != "undefined" && component === window) || component == null) && precompile === false) {
<ide> throw new Error("Error referencing component '" + root.tag + "'. Components can only be used when within modules. See documentation for more information on t7.module().");
<ide> }
<ide> functionText.push("React.createElement(__$components__." + root.tag);
<ide> functionText.push("React.createElement('" + root.tag + "'");
<ide> }
<ide> //the props/attrs
<del> if(root.attrs != null) {
<add> if (root.attrs != null) {
<ide> buildAttrsParams(root, attrsParams);
<ide> //add the key
<del> if(root.key != null) {
<add> if (root.key != null) {
<ide> attrsParams.push("'key':" + root.key);
<ide> }
<ide> tagParams.push("{" + attrsParams.join(',') + "}");
<ide> functionText.push(tagParams.join(',') + ")");
<ide> } else {
<ide> //add a text entry
<del> root = root.replace(/(\r\n|\n|\r)/gm,"\\n");
<add> root = root.replace(/(\r\n|\n|\r)/gm, "\\n");
<ide> functionText.push("'" + root + "'");
<ide> }
<ide> }
<ide> function handleChildTextPlaceholders(childText, parent, onlyChild) {
<ide> var i = 0;
<ide> var parts = childText.split(/(__\$props__\[\d*\])/g)
<del> for(i = 0; i < parts.length; i++) {
<del> if(parts[i].trim() !== "") {
<add> for (i = 0; i < parts.length; i++) {
<add> if (parts[i].trim() !== "") {
<ide> //set the children to this object
<ide> parent.children.push(parts[i]);
<ide> }
<ide>
<ide> function replaceQuotes(string) {
<ide> // string = string.replace(/'/g,"\\'")
<del> if(string.indexOf("'") > -1) {
<del> string = string.replace(/'/g,"\\'")
<add> if (string.indexOf("'") > -1) {
<add> string = string.replace(/'/g, "\\'")
<ide> }
<ide> return string;
<ide> };
<ide> var index = 0;
<ide> var re = /__\$props__\[([0-9]*)\]/;
<ide> var placeholders = string.match(/__\$props__\[([0-9]*)\]/g);
<del> for(var i = 0; i < placeholders.length; i++) {
<add> for (var i = 0; i < placeholders.length; i++) {
<ide> index = re.exec(placeholders[i])[1];
<ide> string = string.replace(placeholders[i], values[index]);
<ide> }
<ide> var tagData = null;
<ide> var skipAppend = false;
<ide> var newChild = null;
<del>
<del> for(i = 0, n = html.length; i < n; i++) {
<add> var hasRootNodeAlready = false;
<add>
<add> for (i = 0, n = html.length; i < n; i++) {
<ide> //set the char to the current character in the string
<ide> char = html[i];
<ide> if (char === "<") {
<ide> insideTag = true;
<del> } else if(char === ">" && insideTag === true) {
<add> } else if (char === ">" && insideTag === true) {
<ide> //check if first character is a close tag
<del> if(tagContent[0] === "/") {
<add> if (tagContent[0] === "/") {
<ide> //bad closing tag
<del> if(tagContent !== "/" + parent.tag && selfClosingTags.indexOf(parent.tag) === -1 && !parent.closed) {
<add> if (tagContent !== "/" + parent.tag && !selfClosingTags[parent.tag] && !parent.closed) {
<ide> console.error("Template error: " + applyValues(html, values));
<ide> throw new Error("Expected corresponding t7 closing tag for '" + parent.tag + "'.");
<ide> }
<ide> //when the childText is not empty
<del> if(childText.trim() !== "") {
<add> if (childText.trim() !== "") {
<ide> //escape quotes etc
<ide> childText = replaceQuotes(childText);
<ide> //check if childText contains one of our placeholders
<ide> childText = handleChildTextPlaceholders(childText, parent, true);
<del> if(childText !== null && parent.children.length === 0) {
<add> if (childText !== null && parent.children.length === 0) {
<ide> parent.children = childText;
<ide> } else if (childText != null) {
<ide> parent.children.push(childText);
<ide> }
<ide> //move back up the vDom tree
<ide> parent = parent.parent;
<del> if(parent) {
<add> if (parent) {
<ide> parent.closed = true;
<ide> }
<ide> } else {
<ide> //check if we have any content in the childText, if so, it was a text node that needs to be added
<del> if(childText.trim().length > 0 && !(parent instanceof Array)) {
<add> if (childText.trim().length > 0 && !(parent instanceof Array)) {
<ide> //escape quotes etc
<ide> childText = replaceQuotes(childText);
<ide> //check the childtext for placeholders
<ide> childText = handleChildTextPlaceholders(
<del> childText.replace(/(\r\n|\n|\r)/gm,""),
<add> childText.replace(/(\r\n|\n|\r)/gm, ""),
<ide> parent
<ide> );
<ide> parent.children.push(childText);
<ide> childText = "";
<ide> }
<ide> //check if there any spaces in the tagContent, if not, we have our tagName
<del> if(tagContent.indexOf(" ") === -1) {
<add> if (tagContent.indexOf(" ") === -1) {
<ide> tagData = {};
<ide> tagName = tagContent;
<ide> } else {
<ide> tag: tagName,
<ide> attrs: (tagData && tagData.attrs) ? tagData.attrs : null,
<ide> children: [],
<del> closed: tagContent[tagContent.length - 1] === "/" || selfClosingTags.indexOf(tagName) > -1 ? true : false
<add> closed: tagContent[tagContent.length - 1] === "/" || selfClosingTags[tagName] ? true : false
<ide> };
<ide>
<del> if(tagData && tagData.key) {
<add> if (tagData && tagData.key) {
<ide> vElement.key = tagData.key;
<ide> }
<ide> //push the node we've constructed to the relevant parent
<del> if(parent === null) {
<del> if(root === null) {
<add> if (parent === null) {
<add> if (hasRootNodeAlready === true) {
<add> throw new Error("t7 templates must contain only a single root element");
<add> }
<add> hasRootNodeAlready = true;
<add> if (root === null && vElement.closed === false) {
<ide> root = parent = vElement;
<ide> } else {
<del> throw new Error("t7 templates must contain only a single root element");
<add> root = vElement;
<ide> }
<ide> } else if (parent instanceof Array) {
<ide> parent.push(vElement);
<ide> } else {
<ide> parent.children.push(vElement);
<ide> }
<del> if(selfClosingTags.indexOf(tagName) === -1 ) {
<add> if (!selfClosingTags[tagName] && vElement.closed === false) {
<ide> //set our node's parent to our current parent
<del> if(parent === vElement) {
<add> if (parent === vElement) {
<ide> vElement.parent = null;
<ide> } else {
<ide> vElement.parent = parent;
<ide> var key = '';
<ide>
<ide> //build the parts of the tag
<del> for(i = 0, n = tagText.length; i < n; i++) {
<add> for (i = 0, n = tagText.length; i < n; i++) {
<ide> char = tagText[i];
<ide>
<del> if(char === " " && inQuotes === false) {
<add> if (char === " " && inQuotes === false) {
<ide> parts.push(currentString);
<ide> currentString = '';
<del> } else if(char === "'") {
<del> if(inQuotes === false) {
<add> } else if (char === "'") {
<add> if (inQuotes === false) {
<ide> inQuotes = true;
<ide> } else {
<ide> inQuotes = false;
<ide> parts.push(currentString);
<ide> currentString = '';
<ide> }
<del> } else if(char === '"') {
<del> if(inQuotes === false) {
<add> } else if (char === '"') {
<add> if (inQuotes === false) {
<ide> inQuotes = true;
<ide> } else {
<ide> inQuotes = false;
<ide> }
<ide> }
<ide>
<del> if(currentString !== "") {
<add> if (currentString !== "") {
<ide> parts.push(currentString);
<ide> }
<ide> currentString = '';
<ide>
<ide> //loop through the parts of the tag
<del> for(i = 1, n = parts.length; i < n; i++) {
<add> for (i = 1, n = parts.length; i < n; i++) {
<ide> attrParts = [];
<del> lastChar= '';
<add> lastChar = '';
<ide> currentString = '';
<ide>
<del> for(s = 0, n2 = parts[i].length; s < n2; s++) {
<add> for (s = 0, n2 = parts[i].length; s < n2; s++) {
<ide> char = parts[i][s];
<ide>
<ide> //if the character is =, then we're able to split the attribute name and value
<del> if(char === "=") {
<add> if (char === "=") {
<ide> attrParts.push(currentString);
<ide> currentString = '';
<ide> } else {
<ide> }
<ide> }
<ide>
<del> if(currentString != "") {
<add> if (currentString != "") {
<ide> attrParts.push(currentString);
<ide> }
<del> if(attrParts.length > 1) {
<add> if (attrParts.length > 1) {
<ide> var matches = attrParts[1].match(/__\$props__\[\d*\]/g);
<del> if(matches !== null) {
<add> if (matches !== null) {
<ide> attrs[attrParts[0]] = attrParts[1];
<ide> } else {
<del> if(attrParts[0] === "key") {
<add> if (attrParts[0] === "key") {
<ide> key = attrParts[1];
<ide> } else {
<ide> attrs[attrParts[0]] = attrParts[1];
<ide> }
<ide>
<ide> function createTemplateKey(tpl) {
<del> var hash = 0, i, chr, len;
<add> var hash = 0,
<add> i, chr, len;
<ide> if (tpl.length == 0) return tpl;
<ide> for (i = 0, len = tpl.length; i < len; i++) {
<del> chr = tpl.charCodeAt(i);
<del> hash = ((hash << 5) - hash) + chr;
<add> chr = tpl.charCodeAt(i);
<add> hash = ((hash << 5) - hash) + chr;
<ide> hash |= 0;
<ide> }
<ide> return hash;
<ide> var values = [].slice.call(arguments, 1);
<ide>
<ide> //build the template string
<del> for(; i < n; i++) {
<add> for (; i < n; i++) {
<ide> tpl += template[i];
<ide> };
<ide> //set our unique key
<ide> templateKey = createTemplateKey(tpl);
<ide>
<ide> //check if we have the template in cache
<del> if(t7._cache[templateKey] == null) {
<add> if (t7._cache[templateKey] == null) {
<ide> fullHtml = '';
<ide> //put our placeholders around the template parts
<del> for(i = 0, n = template.length; i < n; i++) {
<del> if(i === template.length - 1) {
<add> for (i = 0, n = template.length; i < n; i++) {
<add> if (i === template.length - 1) {
<ide> fullHtml += template[i];
<ide> } else {
<ide> fullHtml += template[i] + "__$props__[" + i + "]";
<ide> );
<ide> scriptCode = functionString.join(',');
<ide> //build a new Function and store it depending if on node or browser
<del> if(precompile === true) {
<del> if(output === t7.Outputs.Inferno) {
<add> if (precompile === true) {
<add> if (output === t7.Outputs.Inferno) {
<ide> return {
<ide> templateKey: templateKey,
<ide> inlineObject: scriptCode
<ide> }
<ide> return;
<ide> } else {
<del> if(isBrowser === true) {
<add> if (isBrowser === true) {
<ide> scriptString = 't7._cache["' + templateKey + '"]=function(__$props__, __$components__, t7)';
<ide> scriptString += '{"use strict";return ' + scriptCode + '}';
<ide>
<ide> //a lightweight flow control function
<ide> //expects truthy and falsey to be functions
<ide> t7.if = function(expression, truthy) {
<del> if(expression) {
<del> return {
<del> else: function() {
<del> return truthy();
<del> }
<del> };
<del> } else {
<del> return {
<del> else: function(falsey) {
<del> return falsey();
<del> }
<del> }
<del> }
<del> },
<del>
<del> t7.setOutput = function(newOutput) {
<del> output = newOutput;
<del> };
<add> if (expression) {
<add> return {
<add> else: function() {
<add> return truthy();
<add> }
<add> };
<add> } else {
<add> return {
<add> else: function(falsey) {
<add> return falsey();
<add> }
<add> }
<add> }
<add> },
<add>
<add> t7.setOutput = function(newOutput) {
<add> output = newOutput;
<add> };
<ide>
<ide> t7.clearCache = function() {
<ide> t7._cache = {};
<ide> };
<ide>
<ide> t7.assign = function(compName) {
<del> throw new Error("Error assigning component '" + compName+ "'. You can only assign components from within a module. Please check documentation for t7.module().");
<add> throw new Error("Error assigning component '" + compName + "'. You can only assign components from within a module. Please check documentation for t7.module().");
<ide> };
<ide>
<ide> t7.module = function(callback) {
<ide> };
<ide>
<ide> instance.assign = function(name, val) {
<del> if(arguments.length === 2) {
<add> if (arguments.length === 2) {
<ide> components[name] = val;
<ide> } else {
<del> for(var key in name) {
<add> for (var key in name) {
<ide> components[key] = name[key];
<ide> }
<ide> }
<ide> };
<ide>
<ide> //set the type to React as default if it exists in global scope
<del> output = typeof React != "undefined" ? t7.Outputs.React
<del> : typeof Inferno != "undefined" ? t7.Outputs.Inferno : t7.Outputs.Universal;
<add> output = typeof React != "undefined" ? t7.Outputs.React : typeof Inferno != "undefined" ? t7.Outputs.Inferno : t7.Outputs.Universal;
<ide>
<ide> return t7;
<ide> })();
<ide>
<del>if(typeof module != "undefined" && module.exports != null) {
<add>if (typeof module != "undefined" && module.exports != null) {
<ide> module.exports = t7;
<ide> } |
|
Java | mit | dd6ad92c429ea58b499157778f64805bf10b784f | 0 | AlgorithmX2/FlatColoredBlocks | package mod.flatcoloredblocks;
import mod.flatcoloredblocks.block.BlockFlatColored;
import mod.flatcoloredblocks.block.BlockHSVConfiguration;
import mod.flatcoloredblocks.block.EnumFlatBlockType;
import mod.flatcoloredblocks.block.ItemBlockFlatColored;
import mod.flatcoloredblocks.client.ClientSide;
import mod.flatcoloredblocks.client.DummyClientSide;
import mod.flatcoloredblocks.client.IClientSide;
import mod.flatcoloredblocks.config.ModConfig;
import mod.flatcoloredblocks.craftingitem.FlatColoredBlockRecipe;
import mod.flatcoloredblocks.craftingitem.ItemColoredBlockCrafter;
import mod.flatcoloredblocks.gui.GuiScreenStartup;
import mod.flatcoloredblocks.gui.ModGuiRouter;
import mod.flatcoloredblocks.integration.IntegerationJEI;
import mod.flatcoloredblocks.network.NetworkRouter;
import net.minecraft.client.gui.GuiMainMenu;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.client.event.GuiOpenEvent;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.FMLCommonHandler;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.common.Mod.EventHandler;
import net.minecraftforge.fml.common.event.FMLInterModComms;
import net.minecraftforge.fml.common.event.FMLPostInitializationEvent;
import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
import net.minecraftforge.fml.common.network.NetworkRegistry;
import net.minecraftforge.fml.common.registry.GameRegistry;
import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;
import net.minecraftforge.oredict.RecipeSorter;
import net.minecraftforge.oredict.RecipeSorter.Category;
import net.minecraftforge.oredict.ShapedOreRecipe;
@Mod(
name = FlatColoredBlocks.MODNAME,
modid = FlatColoredBlocks.MODID,
acceptedMinecraftVersions = "[1.11]",
version = FlatColoredBlocks.VERSION,
dependencies = FlatColoredBlocks.DEPENDENCIES,
guiFactory = "mod.flatcoloredblocks.gui.ConfigGuiFactory" )
public class FlatColoredBlocks
{
// create creative tab...
public static FlatColoredBlocks instance;
public static final String MODNAME = "FlatColoredBlocks";
public static final String MODID = "flatcoloredblocks";
public static final String VERSION = "@VERSION@";
public static final String DEPENDENCIES = "required-after:forge@[" // forge.
+ net.minecraftforge.common.ForgeVersion.majorVersion + '.' // majorVersion
+ net.minecraftforge.common.ForgeVersion.minorVersion + '.' // minorVersion
+ net.minecraftforge.common.ForgeVersion.revisionVersion + '.' // revisionVersion
+ net.minecraftforge.common.ForgeVersion.buildVersion + ",)"; // buildVersion";
public CreativeTab creativeTab;
public ModConfig config;
public ItemColoredBlockCrafter itemColoredBlockCrafting;
public final IntegerationJEI jei = new IntegerationJEI();
private IClientSide clientSide;
public BlockHSVConfiguration normal;
public BlockHSVConfiguration transparent;
public BlockHSVConfiguration glowing;
public FlatColoredBlocks()
{
instance = this;
}
public void initHSVFromConfiguration(
final ModConfig config )
{
normal = new BlockHSVConfiguration( EnumFlatBlockType.NORMAL, config );
transparent = new BlockHSVConfiguration( EnumFlatBlockType.TRANSPARENT, config );
glowing = new BlockHSVConfiguration( EnumFlatBlockType.GLOWING, config );
}
public int getFullNumberOfShades()
{
return normal.getNumberOfShades()
+ transparent.getNumberOfShades() * FlatColoredBlocks.instance.config.TRANSPARENCY_SHADES
+ glowing.getNumberOfShades() * FlatColoredBlocks.instance.config.GLOWING_SHADES;
}
public int getFullNumberOfBlocks()
{
return normal.getNumberOfBlocks()
+ transparent.getNumberOfBlocks() * FlatColoredBlocks.instance.config.TRANSPARENCY_SHADES
+ glowing.getNumberOfBlocks() * FlatColoredBlocks.instance.config.GLOWING_SHADES;
}
@EventHandler
public void preinit(
final FMLPreInitializationEvent event )
{
config = new ModConfig( event.getSuggestedConfigurationFile() );
initHSVFromConfiguration( config );
if ( FMLCommonHandler.instance().getSide().isClient() )
{
clientSide = ClientSide.instance;
}
else
{
clientSide = new DummyClientSide();
}
// inform Version Checker Mod of our existence.
initVersionChecker();
// configure creative tab.
creativeTab = new CreativeTab();
MinecraftForge.EVENT_BUS.register( this );
// create and configure crafting item.
itemColoredBlockCrafting = new ItemColoredBlockCrafter();
itemColoredBlockCrafting.setRegistryName( FlatColoredBlocks.MODID, "coloredcraftingitem" );
GameRegistry.register( itemColoredBlockCrafting );
if ( config.allowCraftingTable )
{
final String craftingOrder = "after:minecraft:shapeless";
GameRegistry.addRecipe( new FlatColoredBlockRecipe() );
RecipeSorter.register( MODID + ":flatcoloredblockcrafting", FlatColoredBlockRecipe.class, Category.SHAPELESS, craftingOrder );
}
clientSide.configureCraftingRender( itemColoredBlockCrafting );
// crafting pattern.
final ShapedOreRecipe craftingItemRecipe = new ShapedOreRecipe( itemColoredBlockCrafting, " R ", "VrG", " C ", 'R', "dyeRed", 'V', "dyePurple", 'r', "ingotIron", 'G', "dyeGreen",
'C', "dyeCyan" );
GameRegistry.addRecipe( craftingItemRecipe );
final BlockHSVConfiguration configs[] = new BlockHSVConfiguration[] { normal, transparent, glowing };
// create and configure all blocks.
for ( final BlockHSVConfiguration hsvconfig : configs )
{
for ( int v = 0; v < hsvconfig.MAX_SHADE_VARIANT; ++v )
{
for ( int x = 0; x < hsvconfig.getNumberOfBlocks(); ++x )
{
final int offset = x * BlockHSVConfiguration.META_SCALE;
final BlockFlatColored cb = BlockFlatColored.construct( hsvconfig, offset, v );
final ItemBlockFlatColored cbi = new ItemBlockFlatColored( cb );
final String regName = hsvconfig.getBlockName( v ) + x;
// use the same name for item/block combo.
cb.setRegistryName( MODID, regName );
cbi.setRegistryName( MODID, regName );
// register both.
GameRegistry.register( cb );
GameRegistry.register( cbi );
// blacklist with JEI
if ( !config.ShowBlocksInJEI )
{
jei.blackListBlock( cb );
}
clientSide.configureBlockRender( cb );
}
}
}
clientSide.preinit();
}
private void initVersionChecker()
{
final NBTTagCompound compound = new NBTTagCompound();
compound.setString( "curseProjectName", "flat-colored-blocks" );
compound.setString( "curseFilenameParser", "flatcoloredblocks-[].jar" );
FMLInterModComms.sendRuntimeMessage( MODID, "VersionChecker", "addCurseCheck", compound );
}
@EventHandler
public void postinit(
final FMLPostInitializationEvent event )
{
clientSide.init();
// configure networking and gui.
NetworkRouter.instance = new NetworkRouter();
NetworkRegistry.INSTANCE.registerGuiHandler( this, new ModGuiRouter() );
}
@SubscribeEvent
@SideOnly( Side.CLIENT )
public void openMainMenu(
final GuiOpenEvent event )
{
// if the max shades has changed in form the user of the new usage.
if ( config.LAST_MAX_SHADES != FlatColoredBlocks.instance.getFullNumberOfShades()
&& event.getGui() != null
&& event.getGui().getClass() == GuiMainMenu.class )
{
event.setGui( new GuiScreenStartup() );
}
}
}
| src/main/java/mod/flatcoloredblocks/FlatColoredBlocks.java | package mod.flatcoloredblocks;
import mod.flatcoloredblocks.block.BlockFlatColored;
import mod.flatcoloredblocks.block.BlockHSVConfiguration;
import mod.flatcoloredblocks.block.EnumFlatBlockType;
import mod.flatcoloredblocks.block.ItemBlockFlatColored;
import mod.flatcoloredblocks.client.ClientSide;
import mod.flatcoloredblocks.client.DummyClientSide;
import mod.flatcoloredblocks.client.IClientSide;
import mod.flatcoloredblocks.config.ModConfig;
import mod.flatcoloredblocks.craftingitem.FlatColoredBlockRecipe;
import mod.flatcoloredblocks.craftingitem.ItemColoredBlockCrafter;
import mod.flatcoloredblocks.gui.GuiScreenStartup;
import mod.flatcoloredblocks.gui.ModGuiRouter;
import mod.flatcoloredblocks.integration.IntegerationJEI;
import mod.flatcoloredblocks.network.NetworkRouter;
import net.minecraft.client.gui.GuiMainMenu;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraftforge.client.event.GuiOpenEvent;
import net.minecraftforge.common.MinecraftForge;
import net.minecraftforge.fml.common.FMLCommonHandler;
import net.minecraftforge.fml.common.Mod;
import net.minecraftforge.fml.common.Mod.EventHandler;
import net.minecraftforge.fml.common.event.FMLInterModComms;
import net.minecraftforge.fml.common.event.FMLPostInitializationEvent;
import net.minecraftforge.fml.common.event.FMLPreInitializationEvent;
import net.minecraftforge.fml.common.eventhandler.SubscribeEvent;
import net.minecraftforge.fml.common.network.NetworkRegistry;
import net.minecraftforge.fml.common.registry.GameRegistry;
import net.minecraftforge.fml.relauncher.Side;
import net.minecraftforge.fml.relauncher.SideOnly;
import net.minecraftforge.oredict.RecipeSorter;
import net.minecraftforge.oredict.RecipeSorter.Category;
import net.minecraftforge.oredict.ShapedOreRecipe;
@Mod(
name = FlatColoredBlocks.MODNAME,
modid = FlatColoredBlocks.MODID,
acceptedMinecraftVersions = "[1.11]",
version = FlatColoredBlocks.VERSION,
dependencies = FlatColoredBlocks.DEPENDENCIES,
guiFactory = "mod.flatcoloredblocks.gui.ConfigGuiFactory" )
public class FlatColoredBlocks
{
// create creative tab...
public static FlatColoredBlocks instance;
public static final String MODNAME = "FlatColoredBlocks";
public static final String MODID = "flatcoloredblocks";
public static final String VERSION = "@VERSION@";
public static final String DEPENDENCIES = "required-after:Forge@[" // forge.
+ net.minecraftforge.common.ForgeVersion.majorVersion + '.' // majorVersion
+ net.minecraftforge.common.ForgeVersion.minorVersion + '.' // minorVersion
+ net.minecraftforge.common.ForgeVersion.revisionVersion + '.' // revisionVersion
+ net.minecraftforge.common.ForgeVersion.buildVersion + ",)"; // buildVersion";
public CreativeTab creativeTab;
public ModConfig config;
public ItemColoredBlockCrafter itemColoredBlockCrafting;
public final IntegerationJEI jei = new IntegerationJEI();
private IClientSide clientSide;
public BlockHSVConfiguration normal;
public BlockHSVConfiguration transparent;
public BlockHSVConfiguration glowing;
public FlatColoredBlocks()
{
instance = this;
}
public void initHSVFromConfiguration(
final ModConfig config )
{
normal = new BlockHSVConfiguration( EnumFlatBlockType.NORMAL, config );
transparent = new BlockHSVConfiguration( EnumFlatBlockType.TRANSPARENT, config );
glowing = new BlockHSVConfiguration( EnumFlatBlockType.GLOWING, config );
}
public int getFullNumberOfShades()
{
return normal.getNumberOfShades()
+ transparent.getNumberOfShades() * FlatColoredBlocks.instance.config.TRANSPARENCY_SHADES
+ glowing.getNumberOfShades() * FlatColoredBlocks.instance.config.GLOWING_SHADES;
}
public int getFullNumberOfBlocks()
{
return normal.getNumberOfBlocks()
+ transparent.getNumberOfBlocks() * FlatColoredBlocks.instance.config.TRANSPARENCY_SHADES
+ glowing.getNumberOfBlocks() * FlatColoredBlocks.instance.config.GLOWING_SHADES;
}
@EventHandler
public void preinit(
final FMLPreInitializationEvent event )
{
config = new ModConfig( event.getSuggestedConfigurationFile() );
initHSVFromConfiguration( config );
if ( FMLCommonHandler.instance().getSide().isClient() )
{
clientSide = ClientSide.instance;
}
else
{
clientSide = new DummyClientSide();
}
// inform Version Checker Mod of our existence.
initVersionChecker();
// configure creative tab.
creativeTab = new CreativeTab();
MinecraftForge.EVENT_BUS.register( this );
// create and configure crafting item.
itemColoredBlockCrafting = new ItemColoredBlockCrafter();
itemColoredBlockCrafting.setRegistryName( FlatColoredBlocks.MODID, "coloredcraftingitem" );
GameRegistry.register( itemColoredBlockCrafting );
if ( config.allowCraftingTable )
{
final String craftingOrder = "after:minecraft:shapeless";
GameRegistry.addRecipe( new FlatColoredBlockRecipe() );
RecipeSorter.register( MODID + ":flatcoloredblockcrafting", FlatColoredBlockRecipe.class, Category.SHAPELESS, craftingOrder );
}
clientSide.configureCraftingRender( itemColoredBlockCrafting );
// crafting pattern.
final ShapedOreRecipe craftingItemRecipe = new ShapedOreRecipe( itemColoredBlockCrafting, " R ", "VrG", " C ", 'R', "dyeRed", 'V', "dyePurple", 'r', "ingotIron", 'G', "dyeGreen",
'C', "dyeCyan" );
GameRegistry.addRecipe( craftingItemRecipe );
final BlockHSVConfiguration configs[] = new BlockHSVConfiguration[] { normal, transparent, glowing };
// create and configure all blocks.
for ( final BlockHSVConfiguration hsvconfig : configs )
{
for ( int v = 0; v < hsvconfig.MAX_SHADE_VARIANT; ++v )
{
for ( int x = 0; x < hsvconfig.getNumberOfBlocks(); ++x )
{
final int offset = x * BlockHSVConfiguration.META_SCALE;
final BlockFlatColored cb = BlockFlatColored.construct( hsvconfig, offset, v );
final ItemBlockFlatColored cbi = new ItemBlockFlatColored( cb );
final String regName = hsvconfig.getBlockName( v ) + x;
// use the same name for item/block combo.
cb.setRegistryName( MODID, regName );
cbi.setRegistryName( MODID, regName );
// register both.
GameRegistry.register( cb );
GameRegistry.register( cbi );
// blacklist with JEI
if ( !config.ShowBlocksInJEI )
{
jei.blackListBlock( cb );
}
clientSide.configureBlockRender( cb );
}
}
}
clientSide.preinit();
}
private void initVersionChecker()
{
final NBTTagCompound compound = new NBTTagCompound();
compound.setString( "curseProjectName", "flat-colored-blocks" );
compound.setString( "curseFilenameParser", "flatcoloredblocks-[].jar" );
FMLInterModComms.sendRuntimeMessage( MODID, "VersionChecker", "addCurseCheck", compound );
}
@EventHandler
public void postinit(
final FMLPostInitializationEvent event )
{
clientSide.init();
// configure networking and gui.
NetworkRouter.instance = new NetworkRouter();
NetworkRegistry.INSTANCE.registerGuiHandler( this, new ModGuiRouter() );
}
@SubscribeEvent
@SideOnly( Side.CLIENT )
public void openMainMenu(
final GuiOpenEvent event )
{
// if the max shades has changed in form the user of the new usage.
if ( config.LAST_MAX_SHADES != FlatColoredBlocks.instance.getFullNumberOfShades()
&& event.getGui() != null
&& event.getGui().getClass() == GuiMainMenu.class )
{
event.setGui( new GuiScreenStartup() );
}
}
}
| Fix Forge Requirement.
| src/main/java/mod/flatcoloredblocks/FlatColoredBlocks.java | Fix Forge Requirement. | <ide><path>rc/main/java/mod/flatcoloredblocks/FlatColoredBlocks.java
<ide> public static final String MODID = "flatcoloredblocks";
<ide> public static final String VERSION = "@VERSION@";
<ide>
<del> public static final String DEPENDENCIES = "required-after:Forge@[" // forge.
<add> public static final String DEPENDENCIES = "required-after:forge@[" // forge.
<ide> + net.minecraftforge.common.ForgeVersion.majorVersion + '.' // majorVersion
<ide> + net.minecraftforge.common.ForgeVersion.minorVersion + '.' // minorVersion
<ide> + net.minecraftforge.common.ForgeVersion.revisionVersion + '.' // revisionVersion |
|
JavaScript | mit | 92a28049aeb3c30cf5f758b8f333fbf71affc0fb | 0 | sandeepmistry/node-wimoto | var events = require('events');
var util = require('util');
var noble = require('noble');
var ClimateUtil = require('./climate/util');
var Broadcast = function() {
noble.on('discover', this.onDiscover.bind(this));
};
util.inherits(Broadcast, events.EventEmitter);
Broadcast.prototype.startScanning = function() {
if (noble.state === 'poweredOn') {
noble.startScanning([], true);
} else {
noble.once('stateChange', function() {
noble.startScanning([], true);
});
}
};
Broadcast.prototype.stopScanning = function() {
noble.stopScanning();
};
Broadcast.prototype.isBroadcast = function(peripheral) {
var localName = peripheral.advertisement.localName;
var manufacturerData = peripheral.advertisement.manufacturerData;
return (localName && localName.indexOf('_') !== -1 &&
manufacturerData && manufacturerData.length !== 9 && manufacturerData[0] === 0x01 && manufacturerData[1] === 0x17);
}
Broadcast.prototype.parseBroadcast = function(peripheral){
var localName = peripheral.advertisement.localName;
var manufacturerData = peripheral.advertisement.manufacturerData;
var splitLocalName = localName.split('_');
var type = splitLocalName[0].toLowerCase();
var id = splitLocalName[1].toLowerCase();
var sensorData = manufacturerData.slice(2);
var broadcast = {};
if (type === 'climate') {
broadcast.temperature = ClimateUtil.convertCurrentTemperature(sensorData.readUInt16LE(0));
broadcast.light = ClimateUtil.convertCurrentLight(sensorData.readUInt16LE(2));
broadcast.humidity = ClimateUtil.convertCurrentHumidity(sensorData.readUInt16LE(4));
broadcast.battery = sensorData.readUInt8(6);
}
return broadcast;
}
Broadcast.prototype.onDiscover = function(peripheral) {
if (!this.isBroadcast(peripheral)) {
return;
}
var broadcast = this.parseBroadcast(peripheral);
this.emit('data', broadcast);
};
module.exports = Broadcast;
| lib/broadcast.js | var events = require('events');
var util = require('util');
var noble = require('noble');
var ClimateUtil = require('./climate/util');
var Broadcast = function() {
noble.on('discover', this.onDiscover.bind(this));
};
util.inherits(Broadcast, events.EventEmitter);
Broadcast.prototype.startScanning = function() {
if (noble.state === 'poweredOn') {
noble.startScanning([], true);
} else {
noble.once('stateChange', function() {
noble.startScanning([], true);
});
}
};
Broadcast.prototype.stopScanning = function() {
noble.stopScanning();
};
Broadcast.prototype.isBroadcast = function(peripheral) {
var localName = peripheral.advertisement.localName;
var manufacturerData = peripheral.advertisement.manufacturerData;
return localName || localName.indexOf('_') === -1 ||
!manufacturerData || manufacturerData.length !== 9 || manufacturerData[0] !== 0x01 || manufacturerData[1] !== 0x17
}
Broadcast.prototype.parseBroadcast = function(peripheral){
var localName = peripheral.advertisement.localName;
var manufacturerData = peripheral.advertisement.manufacturerData;
var splitLocalName = localName.split('_');
var type = splitLocalName[0].toLowerCase();
var id = splitLocalName[1].toLowerCase();
var sensorData = manufacturerData.slice(2);
var broadcast = {};
if (type === 'climate') {
broadcast.temperature = ClimateUtil.convertCurrentTemperature(sensorData.readUInt16LE(0));
broadcast.light = ClimateUtil.convertCurrentLight(sensorData.readUInt16LE(2));
broadcast.humidity = ClimateUtil.convertCurrentHumidity(sensorData.readUInt16LE(4));
broadcast.battery = sensorData.readUInt8(6);
}
return broadcast;
}
Broadcast.prototype.onDiscover = function(peripheral) {
if (!this.isBroadcast(peripheral)) {
return;
}
var broadcast = this.parseBroadcast(peripheral);
this.emit('data', broadcast);
};
module.exports = Broadcast;
| using or wasnt catching when localName was undefined
| lib/broadcast.js | using or wasnt catching when localName was undefined | <ide><path>ib/broadcast.js
<ide> var localName = peripheral.advertisement.localName;
<ide> var manufacturerData = peripheral.advertisement.manufacturerData;
<ide>
<del> return localName || localName.indexOf('_') === -1 ||
<del> !manufacturerData || manufacturerData.length !== 9 || manufacturerData[0] !== 0x01 || manufacturerData[1] !== 0x17
<add> return (localName && localName.indexOf('_') !== -1 &&
<add> manufacturerData && manufacturerData.length !== 9 && manufacturerData[0] === 0x01 && manufacturerData[1] === 0x17);
<ide> }
<ide>
<ide> Broadcast.prototype.parseBroadcast = function(peripheral){ |
|
Java | apache-2.0 | eb0407f54f2f41237b2048dbae1a7ef495ed0904 | 0 | apache/shindig,apparentlymart/shindig,apache/shindig,apache/shindig,apparentlymart/shindig,apache/shindig,apparentlymart/shindig,apparentlymart/shindig,apache/shindig | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.shindig.gadgets.render;
import org.apache.shindig.common.JsonSerializer;
import org.apache.shindig.common.uri.Uri;
import org.apache.shindig.common.xml.DomUtil;
import org.apache.shindig.config.ContainerConfig;
import org.apache.shindig.gadgets.Gadget;
import org.apache.shindig.gadgets.GadgetContext;
import org.apache.shindig.gadgets.GadgetException;
import org.apache.shindig.gadgets.MessageBundleFactory;
import org.apache.shindig.gadgets.UnsupportedFeatureException;
import org.apache.shindig.gadgets.config.ConfigContributor;
import org.apache.shindig.gadgets.features.FeatureRegistry;
import org.apache.shindig.gadgets.features.FeatureResource;
import org.apache.shindig.gadgets.preload.PreloadException;
import org.apache.shindig.gadgets.preload.PreloadedData;
import org.apache.shindig.gadgets.rewrite.GadgetRewriter;
import org.apache.shindig.gadgets.rewrite.MutableContent;
import org.apache.shindig.gadgets.rewrite.RewritingException;
import org.apache.shindig.gadgets.spec.Feature;
import org.apache.shindig.gadgets.spec.MessageBundle;
import org.apache.shindig.gadgets.spec.UserPref;
import org.apache.shindig.gadgets.spec.View;
import org.apache.shindig.gadgets.uri.JsUriManager;
import org.apache.commons.lang.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.inject.Inject;
import com.google.inject.name.Named;
/**
* Produces a valid HTML document for the gadget output, automatically inserting appropriate HTML
* document wrapper data as needed.
*
* Currently, this is only invoked directly since the rewriting infrastructure doesn't properly
* deal with uncacheable rewrite operations.
*
* TODO: Break this up into multiple rewriters.
*
* Should be:
*
* - UserPrefs injection
* - Javascript injection (including configuration)
* - html document normalization
*/
public class RenderingGadgetRewriter implements GadgetRewriter {
private static final Logger LOG = Logger.getLogger(RenderingGadgetRewriter.class.getName());
private static final int INLINE_JS_BUFFER = 50;
protected static final String DEFAULT_CSS =
"body,td,div,span,p{font-family:arial,sans-serif;}" +
"a {color:#0000cc;}a:visited {color:#551a8b;}" +
"a:active {color:#ff0000;}" +
"body{margin: 0px;padding: 0px;background-color:white;}";
static final String IS_GADGET_BEACON = "window['__isgadget']=true;";
static final String INSERT_BASE_ELEMENT_KEY = "gadgets.insertBaseElement";
static final String FEATURES_KEY = "gadgets.features";
protected final MessageBundleFactory messageBundleFactory;
protected final ContainerConfig containerConfig;
protected final FeatureRegistry featureRegistry;
protected final JsUriManager jsUriManager;
protected final Map<String, ConfigContributor> configContributors;
protected Set<String> defaultExternLibs = ImmutableSet.of();
protected Boolean externalizeFeatures = false;
/**
* @param messageBundleFactory Used for injecting message bundles into gadget output.
*/
@Inject
public RenderingGadgetRewriter(MessageBundleFactory messageBundleFactory,
ContainerConfig containerConfig,
FeatureRegistry featureRegistry,
JsUriManager jsUriManager,
Map<String, ConfigContributor> configContributors) {
this.messageBundleFactory = messageBundleFactory;
this.containerConfig = containerConfig;
this.featureRegistry = featureRegistry;
this.jsUriManager = jsUriManager;
this.configContributors = configContributors;
}
@Inject
public void setDefaultForcedLibs(@Named("shindig.gadget-rewrite.default-forced-libs")String forcedLibs) {
if (StringUtils.isNotBlank(forcedLibs)) {
defaultExternLibs = ImmutableSortedSet.of(StringUtils.split(forcedLibs, ':'));
}
}
@Inject(optional = true)
public void setExternalizeFeatureLibs(@Named("shindig.gadget-rewrite.externalize-feature-libs")Boolean externalizeFeatures) {
this.externalizeFeatures = externalizeFeatures;
}
public void rewrite(Gadget gadget, MutableContent mutableContent) throws RewritingException {
// Don't touch sanitized gadgets.
if (gadget.sanitizeOutput()) {
return;
}
try {
Document document = mutableContent.getDocument();
Element head = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "head");
// Insert new content before any of the existing children of the head element
Node firstHeadChild = head.getFirstChild();
// Only inject default styles if no doctype was specified.
if (document.getDoctype() == null) {
Element defaultStyle = document.createElement("style");
defaultStyle.setAttribute("type", "text/css");
head.insertBefore(defaultStyle, firstHeadChild);
defaultStyle.appendChild(defaultStyle.getOwnerDocument().
createTextNode(DEFAULT_CSS));
}
injectBaseTag(gadget, head);
injectGadgetBeacon(gadget, head, firstHeadChild);
injectFeatureLibraries(gadget, head, firstHeadChild);
// This can be one script block.
Element mainScriptTag = document.createElement("script");
GadgetContext context = gadget.getContext();
MessageBundle bundle = messageBundleFactory.getBundle(
gadget.getSpec(), context.getLocale(), context.getIgnoreCache(), context.getContainer());
injectMessageBundles(bundle, mainScriptTag);
injectDefaultPrefs(gadget, mainScriptTag);
injectPreloads(gadget, mainScriptTag);
// We need to inject our script before any developer scripts.
head.insertBefore(mainScriptTag, firstHeadChild);
Element body = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "body");
body.setAttribute("dir", bundle.getLanguageDirection());
injectOnLoadHandlers(body);
mutableContent.documentChanged();
} catch (GadgetException e) {
throw new RewritingException(e.getLocalizedMessage(), e, e.getHttpStatusCode());
}
}
protected void injectBaseTag(Gadget gadget, Node headTag) {
GadgetContext context = gadget.getContext();
if (containerConfig.getBool(context.getContainer(), INSERT_BASE_ELEMENT_KEY)) {
Uri base = gadget.getSpec().getUrl();
View view = gadget.getCurrentView();
if (view != null && view.getHref() != null) {
base = view.getHref();
}
Element baseTag = headTag.getOwnerDocument().createElement("base");
baseTag.setAttribute("href", base.toString());
headTag.insertBefore(baseTag, headTag.getFirstChild());
}
}
protected void injectOnLoadHandlers(Node bodyTag) {
Element onloadScript = bodyTag.getOwnerDocument().createElement("script");
bodyTag.appendChild(onloadScript);
onloadScript.appendChild(bodyTag.getOwnerDocument().createTextNode(
"gadgets.util.runOnLoadHandlers();"));
}
protected void injectGadgetBeacon(Gadget gadget, Node headTag, Node firstHeadChild)
throws GadgetException {
Element beaconNode = headTag.getOwnerDocument().createElement("script");
beaconNode.setTextContent(IS_GADGET_BEACON);
headTag.insertBefore(beaconNode, firstHeadChild);
}
/**
* Injects javascript libraries needed to satisfy feature dependencies.
*/
protected void injectFeatureLibraries(Gadget gadget, Node headTag, Node firstHeadChild)
throws GadgetException {
// TODO: If there isn't any js in the document, we can skip this. Unfortunately, that means
// both script tags (easy to detect) and event handlers (much more complex).
GadgetContext context = gadget.getContext();
// Set of extern libraries requested by the container
Set<String> externForcedLibs = defaultExternLibs;
// gather the libraries we'll need to generate the extern libs
String externParam = context.getParameter("libs");
if (StringUtils.isNotBlank(externParam)) {
externForcedLibs = Sets.newTreeSet(Arrays.asList(StringUtils.split(externParam, ':')));
}
if (!externForcedLibs.isEmpty()) {
String jsUrl = jsUriManager.makeExternJsUri(gadget, externForcedLibs).toString();
Element libsTag = headTag.getOwnerDocument().createElement("script");
libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
headTag.insertBefore(libsTag, firstHeadChild);
}
List<String> unsupported = Lists.newLinkedList();
List<FeatureResource> externForcedResources =
featureRegistry.getFeatureResources(context, externForcedLibs, unsupported);
if (!unsupported.isEmpty()) {
LOG.info("Unknown feature(s) in extern &libs=: " + unsupported.toString());
unsupported.clear();
}
// Get all resources requested by the gadget's requires/optional features.
Map<String, Feature> featureMap = gadget.getSpec().getModulePrefs().getFeatures();
List<String> gadgetFeatureKeys = Lists.newArrayList(gadget.getDirectFeatureDeps());
List<FeatureResource> gadgetResources =
featureRegistry.getFeatureResources(context, gadgetFeatureKeys, unsupported);
if (!unsupported.isEmpty()) {
List<String> requiredUnsupported = Lists.newLinkedList();
for (String notThere : unsupported) {
if (!featureMap.containsKey(notThere) || featureMap.get(notThere).getRequired()) {
// if !containsKey, the lib was forced with Gadget.addFeature(...) so implicitly req'd.
requiredUnsupported.add(notThere);
}
}
if (!requiredUnsupported.isEmpty()) {
throw new UnsupportedFeatureException(requiredUnsupported.toString());
}
}
// Inline or externalize the gadgetFeatureKeys
List<FeatureResource> inlineResources = Lists.newArrayList();
List<String> allRequested = Lists.newArrayList(gadgetFeatureKeys);
if (externalizeFeatures) {
Set<String> externGadgetLibs = Sets.newTreeSet(featureRegistry.getFeatures(gadgetFeatureKeys));
externGadgetLibs.removeAll(externForcedLibs);
if (!externGadgetLibs.isEmpty()) {
String jsUrl = jsUriManager.makeExternJsUri(gadget, externGadgetLibs).toString();
Element libsTag = headTag.getOwnerDocument().createElement("script");
libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
headTag.insertBefore(libsTag, firstHeadChild);
}
} else {
inlineResources.addAll(gadgetResources);
}
// Calculate inlineResources as all resources that are needed by the gadget to
// render, minus all those included through externResources.
// TODO: profile and if needed, optimize this a bit.
if (!externForcedLibs.isEmpty()) {
allRequested.addAll(externForcedLibs);
inlineResources.removeAll(externForcedResources);
}
// Precalculate the maximum length in order to avoid excessive garbage generation.
int size = 0;
for (FeatureResource resource : inlineResources) {
if (!resource.isExternal()) {
if (context.getDebug()) {
size += resource.getDebugContent().length();
} else {
size += resource.getContent().length();
}
}
}
String libraryConfig =
getLibraryConfig(gadget, featureRegistry.getFeatures(allRequested));
// Size has a small fudge factor added to it for delimiters and such.
StringBuilder inlineJs = new StringBuilder(size + libraryConfig.length() + INLINE_JS_BUFFER);
// Inline any libs that weren't extern. The ugly context switch between inline and external
// Js is needed to allow both inline and external scripts declared in feature.xml.
for (FeatureResource resource : inlineResources) {
String theContent = context.getDebug() ? resource.getDebugContent() : resource.getContent();
if (resource.isExternal()) {
if (inlineJs.length() > 0) {
Element inlineTag = headTag.getOwnerDocument().createElement("script");
headTag.insertBefore(inlineTag, firstHeadChild);
inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
inlineJs.setLength(0);
}
Element referenceTag = headTag.getOwnerDocument().createElement("script");
referenceTag.setAttribute("src", StringUtils.replace(theContent, "&", "&"));
headTag.insertBefore(referenceTag, firstHeadChild);
} else {
inlineJs.append(theContent).append(";\n");
}
}
inlineJs.append(libraryConfig);
if (inlineJs.length() > 0) {
Element inlineTag = headTag.getOwnerDocument().createElement("script");
headTag.insertBefore(inlineTag, firstHeadChild);
inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
}
}
/**
* Creates a set of all configuration needed to satisfy the requested feature set.
*
* Appends special configuration for gadgets.util.hasFeature and gadgets.util.getFeatureParams to
* the output js.
*
* This can't be handled via the normal configuration mechanism because it is something that
* varies per request.
*
* @param reqs The features needed to satisfy the request.
* @throws GadgetException If there is a problem with the gadget auth token
*/
protected String getLibraryConfig(Gadget gadget, List<String> reqs)
throws GadgetException {
GadgetContext context = gadget.getContext();
Map<String, Object> features = containerConfig.getMap(context.getContainer(), FEATURES_KEY);
Map<String, Object> config
= Maps.newHashMapWithExpectedSize(features == null ? 2 : features.size() + 2);
if (features != null) {
// Discard what we don't care about.
for (String name : reqs) {
Object conf = features.get(name);
if (conf != null) {
config.put(name, conf);
}
// See if this feature has configuration data
ConfigContributor contributor = configContributors.get(name);
if (contributor != null) {
contributor.contribute(config, gadget);
}
}
}
return "gadgets.config.init(" + JsonSerializer.serialize(config) + ");\n";
}
/**
* Injects message bundles into the gadget output.
* @throws GadgetException If we are unable to retrieve the message bundle.
*/
protected void injectMessageBundles(MessageBundle bundle, Node scriptTag) throws GadgetException {
String msgs = bundle.toJSONString();
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.Prefs.setMessages_(");
text.appendData(msgs);
text.appendData(");");
scriptTag.appendChild(text);
}
/**
* Injects default values for user prefs into the gadget output.
*/
protected void injectDefaultPrefs(Gadget gadget, Node scriptTag) {
List<UserPref> prefs = gadget.getSpec().getUserPrefs();
Map<String, String> defaultPrefs = Maps.newHashMapWithExpectedSize(prefs.size());
for (UserPref up : prefs) {
defaultPrefs.put(up.getName(), up.getDefaultValue());
}
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.Prefs.setDefaultPrefs_(");
text.appendData(JsonSerializer.serialize(defaultPrefs));
text.appendData(");");
scriptTag.appendChild(text);
}
/**
* Injects preloads into the gadget output.
*
* If preloading fails for any reason, we just output an empty object.
*/
protected void injectPreloads(Gadget gadget, Node scriptTag) {
List<Object> preload = Lists.newArrayList();
for (PreloadedData preloaded : gadget.getPreloads()) {
try {
preload.addAll(preloaded.toJson());
} catch (PreloadException pe) {
// This will be thrown in the event of some unexpected exception. We can move on.
LOG.log(Level.WARNING, "Unexpected error when preloading", pe);
}
}
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.io.preloaded_=");
text.appendData(JsonSerializer.serialize(preload));
text.appendData(";");
scriptTag.appendChild(text);
}
}
| java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderingGadgetRewriter.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.shindig.gadgets.render;
import org.apache.shindig.common.JsonSerializer;
import org.apache.shindig.common.uri.Uri;
import org.apache.shindig.common.xml.DomUtil;
import org.apache.shindig.config.ContainerConfig;
import org.apache.shindig.gadgets.Gadget;
import org.apache.shindig.gadgets.GadgetContext;
import org.apache.shindig.gadgets.GadgetException;
import org.apache.shindig.gadgets.MessageBundleFactory;
import org.apache.shindig.gadgets.UnsupportedFeatureException;
import org.apache.shindig.gadgets.config.ConfigContributor;
import org.apache.shindig.gadgets.features.FeatureRegistry;
import org.apache.shindig.gadgets.features.FeatureResource;
import org.apache.shindig.gadgets.preload.PreloadException;
import org.apache.shindig.gadgets.preload.PreloadedData;
import org.apache.shindig.gadgets.rewrite.GadgetRewriter;
import org.apache.shindig.gadgets.rewrite.MutableContent;
import org.apache.shindig.gadgets.rewrite.RewritingException;
import org.apache.shindig.gadgets.spec.Feature;
import org.apache.shindig.gadgets.spec.MessageBundle;
import org.apache.shindig.gadgets.spec.UserPref;
import org.apache.shindig.gadgets.spec.View;
import org.apache.shindig.gadgets.uri.JsUriManager;
import org.apache.commons.lang.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.Text;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.inject.Inject;
import com.google.inject.name.Named;
/**
* Produces a valid HTML document for the gadget output, automatically inserting appropriate HTML
* document wrapper data as needed.
*
* Currently, this is only invoked directly since the rewriting infrastructure doesn't properly
* deal with uncacheable rewrite operations.
*
* TODO: Break this up into multiple rewriters.
*
* Should be:
*
* - UserPrefs injection
* - Javascript injection (including configuration)
* - html document normalization
*/
public class RenderingGadgetRewriter implements GadgetRewriter {
private static final Logger LOG = Logger.getLogger(RenderingGadgetRewriter.class.getName());
private static final int INLINE_JS_BUFFER = 50;
protected static final String DEFAULT_CSS =
"body,td,div,span,p{font-family:arial,sans-serif;}" +
"a {color:#0000cc;}a:visited {color:#551a8b;}" +
"a:active {color:#ff0000;}" +
"body{margin: 0px;padding: 0px;background-color:white;}";
static final String IS_GADGET_BEACON = "window['__isgadget']=true;";
static final String INSERT_BASE_ELEMENT_KEY = "gadgets.insertBaseElement";
static final String FEATURES_KEY = "gadgets.features";
protected final MessageBundleFactory messageBundleFactory;
protected final ContainerConfig containerConfig;
protected final FeatureRegistry featureRegistry;
protected final JsUriManager jsUriManager;
protected final Map<String, ConfigContributor> configContributors;
protected Set<String> defaultExternLibs = ImmutableSet.of();
protected Boolean externalizeFeatures = false;
/**
* @param messageBundleFactory Used for injecting message bundles into gadget output.
*/
@Inject
public RenderingGadgetRewriter(MessageBundleFactory messageBundleFactory,
ContainerConfig containerConfig,
FeatureRegistry featureRegistry,
JsUriManager jsUriManager,
Map<String, ConfigContributor> configContributors) {
this.messageBundleFactory = messageBundleFactory;
this.containerConfig = containerConfig;
this.featureRegistry = featureRegistry;
this.jsUriManager = jsUriManager;
this.configContributors = configContributors;
}
@Inject
public void setDefaultForcedLibs(@Named("shindig.gadget-rewrite.default-forced-libs")String forcedLibs) {
if (StringUtils.isNotBlank(forcedLibs)) {
defaultExternLibs = ImmutableSortedSet.of(StringUtils.split(forcedLibs, ':'));
}
}
@Inject(optional = true)
public void setExternalizeFeatureLibs(@Named("shindig.gadget-rewrite.externalize-feature-libs")Boolean externalizeFeatures) {
this.externalizeFeatures = externalizeFeatures;
}
public void rewrite(Gadget gadget, MutableContent mutableContent) throws RewritingException {
// Don't touch sanitized gadgets.
if (gadget.sanitizeOutput()) {
return;
}
try {
Document document = mutableContent.getDocument();
Element head = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "head");
// Remove all the elements currently in head and add them back after we inject content
NodeList children = head.getChildNodes();
List<Node> existingHeadContent = Lists.newArrayListWithExpectedSize(children.getLength());
for (int i = 0; i < children.getLength(); i++) {
existingHeadContent.add(children.item(i));
}
for (Node n : existingHeadContent) {
head.removeChild(n);
}
// Only inject default styles if no doctype was specified.
if (document.getDoctype() == null) {
Element defaultStyle = document.createElement("style");
defaultStyle.setAttribute("type", "text/css");
head.appendChild(defaultStyle);
defaultStyle.appendChild(defaultStyle.getOwnerDocument().
createTextNode(DEFAULT_CSS));
}
injectBaseTag(gadget, head);
injectGadgetBeacon(gadget, head);
injectFeatureLibraries(gadget, head);
// This can be one script block.
Element mainScriptTag = document.createElement("script");
GadgetContext context = gadget.getContext();
MessageBundle bundle = messageBundleFactory.getBundle(
gadget.getSpec(), context.getLocale(), context.getIgnoreCache(), context.getContainer());
injectMessageBundles(bundle, mainScriptTag);
injectDefaultPrefs(gadget, mainScriptTag);
injectPreloads(gadget, mainScriptTag);
// We need to inject our script before any developer scripts.
head.appendChild(mainScriptTag);
Element body = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "body");
body.setAttribute("dir", bundle.getLanguageDirection());
// re append head content
for (Node node : existingHeadContent) {
head.appendChild(node);
}
injectOnLoadHandlers(body);
mutableContent.documentChanged();
} catch (GadgetException e) {
throw new RewritingException(e.getLocalizedMessage(), e, e.getHttpStatusCode());
}
}
protected void injectBaseTag(Gadget gadget, Node headTag) {
GadgetContext context = gadget.getContext();
if (containerConfig.getBool(context.getContainer(), INSERT_BASE_ELEMENT_KEY)) {
Uri base = gadget.getSpec().getUrl();
View view = gadget.getCurrentView();
if (view != null && view.getHref() != null) {
base = view.getHref();
}
Element baseTag = headTag.getOwnerDocument().createElement("base");
baseTag.setAttribute("href", base.toString());
headTag.insertBefore(baseTag, headTag.getFirstChild());
}
}
protected void injectOnLoadHandlers(Node bodyTag) {
Element onloadScript = bodyTag.getOwnerDocument().createElement("script");
bodyTag.appendChild(onloadScript);
onloadScript.appendChild(bodyTag.getOwnerDocument().createTextNode(
"gadgets.util.runOnLoadHandlers();"));
}
protected void injectGadgetBeacon(Gadget gadget, Node headTag) throws GadgetException {
Element beaconNode = headTag.getOwnerDocument().createElement("script");
beaconNode.setTextContent(IS_GADGET_BEACON);
headTag.appendChild(beaconNode);
}
/**
* Injects javascript libraries needed to satisfy feature dependencies.
*/
protected void injectFeatureLibraries(Gadget gadget, Node headTag) throws GadgetException {
// TODO: If there isn't any js in the document, we can skip this. Unfortunately, that means
// both script tags (easy to detect) and event handlers (much more complex).
GadgetContext context = gadget.getContext();
// Set of extern libraries requested by the container
Set<String> externForcedLibs = defaultExternLibs;
// gather the libraries we'll need to generate the extern libs
String externParam = context.getParameter("libs");
if (StringUtils.isNotBlank(externParam)) {
externForcedLibs = Sets.newTreeSet(Arrays.asList(StringUtils.split(externParam, ':')));
}
if (!externForcedLibs.isEmpty()) {
String jsUrl = jsUriManager.makeExternJsUri(gadget, externForcedLibs).toString();
Element libsTag = headTag.getOwnerDocument().createElement("script");
libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
headTag.appendChild(libsTag);
}
List<String> unsupported = Lists.newLinkedList();
List<FeatureResource> externForcedResources =
featureRegistry.getFeatureResources(context, externForcedLibs, unsupported);
if (!unsupported.isEmpty()) {
LOG.info("Unknown feature(s) in extern &libs=: " + unsupported.toString());
unsupported.clear();
}
// Get all resources requested by the gadget's requires/optional features.
Map<String, Feature> featureMap = gadget.getSpec().getModulePrefs().getFeatures();
List<String> gadgetFeatureKeys = Lists.newArrayList(gadget.getDirectFeatureDeps());
List<FeatureResource> gadgetResources =
featureRegistry.getFeatureResources(context, gadgetFeatureKeys, unsupported);
if (!unsupported.isEmpty()) {
List<String> requiredUnsupported = Lists.newLinkedList();
for (String notThere : unsupported) {
if (!featureMap.containsKey(notThere) || featureMap.get(notThere).getRequired()) {
// if !containsKey, the lib was forced with Gadget.addFeature(...) so implicitly req'd.
requiredUnsupported.add(notThere);
}
}
if (!requiredUnsupported.isEmpty()) {
throw new UnsupportedFeatureException(requiredUnsupported.toString());
}
}
// Inline or externalize the gadgetFeatureKeys
List<FeatureResource> inlineResources = Lists.newArrayList();
List<String> allRequested = Lists.newArrayList(gadgetFeatureKeys);
if (externalizeFeatures) {
Set<String> externGadgetLibs = Sets.newTreeSet(featureRegistry.getFeatures(gadgetFeatureKeys));
externGadgetLibs.removeAll(externForcedLibs);
if (!externGadgetLibs.isEmpty()) {
String jsUrl = jsUriManager.makeExternJsUri(gadget, externGadgetLibs).toString();
Element libsTag = headTag.getOwnerDocument().createElement("script");
libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
headTag.appendChild(libsTag);
}
} else {
inlineResources.addAll(gadgetResources);
}
// Calculate inlineResources as all resources that are needed by the gadget to
// render, minus all those included through externResources.
// TODO: profile and if needed, optimize this a bit.
if (!externForcedLibs.isEmpty()) {
allRequested.addAll(externForcedLibs);
inlineResources.removeAll(externForcedResources);
}
// Precalculate the maximum length in order to avoid excessive garbage generation.
int size = 0;
for (FeatureResource resource : inlineResources) {
if (!resource.isExternal()) {
if (context.getDebug()) {
size += resource.getDebugContent().length();
} else {
size += resource.getContent().length();
}
}
}
String libraryConfig =
getLibraryConfig(gadget, featureRegistry.getFeatures(allRequested));
// Size has a small fudge factor added to it for delimiters and such.
StringBuilder inlineJs = new StringBuilder(size + libraryConfig.length() + INLINE_JS_BUFFER);
// Inline any libs that weren't extern. The ugly context switch between inline and external
// Js is needed to allow both inline and external scripts declared in feature.xml.
for (FeatureResource resource : inlineResources) {
String theContent = context.getDebug() ? resource.getDebugContent() : resource.getContent();
if (resource.isExternal()) {
if (inlineJs.length() > 0) {
Element inlineTag = headTag.getOwnerDocument().createElement("script");
headTag.appendChild(inlineTag);
inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
inlineJs.setLength(0);
}
Element referenceTag = headTag.getOwnerDocument().createElement("script");
referenceTag.setAttribute("src", StringUtils.replace(theContent, "&", "&"));
headTag.appendChild(referenceTag);
} else {
inlineJs.append(theContent).append(";\n");
}
}
inlineJs.append(libraryConfig);
if (inlineJs.length() > 0) {
Element inlineTag = headTag.getOwnerDocument().createElement("script");
headTag.appendChild(inlineTag);
inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
}
}
/**
* Creates a set of all configuration needed to satisfy the requested feature set.
*
* Appends special configuration for gadgets.util.hasFeature and gadgets.util.getFeatureParams to
* the output js.
*
* This can't be handled via the normal configuration mechanism because it is something that
* varies per request.
*
* @param reqs The features needed to satisfy the request.
* @throws GadgetException If there is a problem with the gadget auth token
*/
protected String getLibraryConfig(Gadget gadget, List<String> reqs)
throws GadgetException {
GadgetContext context = gadget.getContext();
Map<String, Object> features = containerConfig.getMap(context.getContainer(), FEATURES_KEY);
Map<String, Object> config
= Maps.newHashMapWithExpectedSize(features == null ? 2 : features.size() + 2);
if (features != null) {
// Discard what we don't care about.
for (String name : reqs) {
Object conf = features.get(name);
if (conf != null) {
config.put(name, conf);
}
// See if this feature has configuration data
ConfigContributor contributor = configContributors.get(name);
if (contributor != null) {
contributor.contribute(config, gadget);
}
}
}
return "gadgets.config.init(" + JsonSerializer.serialize(config) + ");\n";
}
/**
* Injects message bundles into the gadget output.
* @throws GadgetException If we are unable to retrieve the message bundle.
*/
protected void injectMessageBundles(MessageBundle bundle, Node scriptTag) throws GadgetException {
String msgs = bundle.toJSONString();
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.Prefs.setMessages_(");
text.appendData(msgs);
text.appendData(");");
scriptTag.appendChild(text);
}
/**
* Injects default values for user prefs into the gadget output.
*/
protected void injectDefaultPrefs(Gadget gadget, Node scriptTag) {
List<UserPref> prefs = gadget.getSpec().getUserPrefs();
Map<String, String> defaultPrefs = Maps.newHashMapWithExpectedSize(prefs.size());
for (UserPref up : prefs) {
defaultPrefs.put(up.getName(), up.getDefaultValue());
}
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.Prefs.setDefaultPrefs_(");
text.appendData(JsonSerializer.serialize(defaultPrefs));
text.appendData(");");
scriptTag.appendChild(text);
}
/**
* Injects preloads into the gadget output.
*
* If preloading fails for any reason, we just output an empty object.
*/
protected void injectPreloads(Gadget gadget, Node scriptTag) {
List<Object> preload = Lists.newArrayList();
for (PreloadedData preloaded : gadget.getPreloads()) {
try {
preload.addAll(preloaded.toJson());
} catch (PreloadException pe) {
// This will be thrown in the event of some unexpected exception. We can move on.
LOG.log(Level.WARNING, "Unexpected error when preloading", pe);
}
}
Text text = scriptTag.getOwnerDocument().createTextNode("gadgets.io.preloaded_=");
text.appendData(JsonSerializer.serialize(preload));
text.appendData(";");
scriptTag.appendChild(text);
}
}
| Patch from Jan Luehe | More efficient way of adding content in RenderingGadgetRewriter#rewrite
git-svn-id: 84334937b86421baa0e582c4ab1a9d358324cbeb@962730 13f79535-47bb-0310-9956-ffa450edef68
| java/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderingGadgetRewriter.java | Patch from Jan Luehe | More efficient way of adding content in RenderingGadgetRewriter#rewrite | <ide><path>ava/gadgets/src/main/java/org/apache/shindig/gadgets/render/RenderingGadgetRewriter.java
<ide>
<ide> Element head = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "head");
<ide>
<del> // Remove all the elements currently in head and add them back after we inject content
<del> NodeList children = head.getChildNodes();
<del> List<Node> existingHeadContent = Lists.newArrayListWithExpectedSize(children.getLength());
<del> for (int i = 0; i < children.getLength(); i++) {
<del> existingHeadContent.add(children.item(i));
<del> }
<del>
<del> for (Node n : existingHeadContent) {
<del> head.removeChild(n);
<del> }
<add> // Insert new content before any of the existing children of the head element
<add> Node firstHeadChild = head.getFirstChild();
<ide>
<ide> // Only inject default styles if no doctype was specified.
<ide> if (document.getDoctype() == null) {
<ide> Element defaultStyle = document.createElement("style");
<ide> defaultStyle.setAttribute("type", "text/css");
<del> head.appendChild(defaultStyle);
<add> head.insertBefore(defaultStyle, firstHeadChild);
<ide> defaultStyle.appendChild(defaultStyle.getOwnerDocument().
<ide> createTextNode(DEFAULT_CSS));
<ide> }
<ide>
<ide> injectBaseTag(gadget, head);
<del> injectGadgetBeacon(gadget, head);
<del> injectFeatureLibraries(gadget, head);
<add> injectGadgetBeacon(gadget, head, firstHeadChild);
<add> injectFeatureLibraries(gadget, head, firstHeadChild);
<ide>
<ide> // This can be one script block.
<ide> Element mainScriptTag = document.createElement("script");
<ide> injectPreloads(gadget, mainScriptTag);
<ide>
<ide> // We need to inject our script before any developer scripts.
<del> head.appendChild(mainScriptTag);
<add> head.insertBefore(mainScriptTag, firstHeadChild);
<ide>
<ide> Element body = (Element)DomUtil.getFirstNamedChildNode(document.getDocumentElement(), "body");
<ide>
<ide> body.setAttribute("dir", bundle.getLanguageDirection());
<del>
<del> // re append head content
<del> for (Node node : existingHeadContent) {
<del> head.appendChild(node);
<del> }
<ide>
<ide> injectOnLoadHandlers(body);
<ide>
<ide> "gadgets.util.runOnLoadHandlers();"));
<ide> }
<ide>
<del> protected void injectGadgetBeacon(Gadget gadget, Node headTag) throws GadgetException {
<add> protected void injectGadgetBeacon(Gadget gadget, Node headTag, Node firstHeadChild)
<add> throws GadgetException {
<ide> Element beaconNode = headTag.getOwnerDocument().createElement("script");
<ide> beaconNode.setTextContent(IS_GADGET_BEACON);
<del> headTag.appendChild(beaconNode);
<add> headTag.insertBefore(beaconNode, firstHeadChild);
<ide> }
<ide>
<ide> /**
<ide> * Injects javascript libraries needed to satisfy feature dependencies.
<ide> */
<del> protected void injectFeatureLibraries(Gadget gadget, Node headTag) throws GadgetException {
<add> protected void injectFeatureLibraries(Gadget gadget, Node headTag, Node firstHeadChild)
<add> throws GadgetException {
<ide> // TODO: If there isn't any js in the document, we can skip this. Unfortunately, that means
<ide> // both script tags (easy to detect) and event handlers (much more complex).
<ide> GadgetContext context = gadget.getContext();
<ide> String jsUrl = jsUriManager.makeExternJsUri(gadget, externForcedLibs).toString();
<ide> Element libsTag = headTag.getOwnerDocument().createElement("script");
<ide> libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
<del> headTag.appendChild(libsTag);
<add> headTag.insertBefore(libsTag, firstHeadChild);
<ide> }
<ide>
<ide> List<String> unsupported = Lists.newLinkedList();
<ide> String jsUrl = jsUriManager.makeExternJsUri(gadget, externGadgetLibs).toString();
<ide> Element libsTag = headTag.getOwnerDocument().createElement("script");
<ide> libsTag.setAttribute("src", StringUtils.replace(jsUrl, "&", "&"));
<del> headTag.appendChild(libsTag);
<add> headTag.insertBefore(libsTag, firstHeadChild);
<ide> }
<ide> } else {
<ide> inlineResources.addAll(gadgetResources);
<ide> if (resource.isExternal()) {
<ide> if (inlineJs.length() > 0) {
<ide> Element inlineTag = headTag.getOwnerDocument().createElement("script");
<del> headTag.appendChild(inlineTag);
<add> headTag.insertBefore(inlineTag, firstHeadChild);
<ide> inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
<ide> inlineJs.setLength(0);
<ide> }
<ide> Element referenceTag = headTag.getOwnerDocument().createElement("script");
<ide> referenceTag.setAttribute("src", StringUtils.replace(theContent, "&", "&"));
<del> headTag.appendChild(referenceTag);
<add> headTag.insertBefore(referenceTag, firstHeadChild);
<ide> } else {
<ide> inlineJs.append(theContent).append(";\n");
<ide> }
<ide>
<ide> if (inlineJs.length() > 0) {
<ide> Element inlineTag = headTag.getOwnerDocument().createElement("script");
<del> headTag.appendChild(inlineTag);
<add> headTag.insertBefore(inlineTag, firstHeadChild);
<ide> inlineTag.appendChild(headTag.getOwnerDocument().createTextNode(inlineJs.toString()));
<ide> }
<ide> } |
|
Java | bsd-3-clause | 97c626ac6636b9b2fda99bc4612a4fae61dede8c | 0 | ndexbio/ndex-common | package org.ndexbio.common.persistence.orientdb;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import java.util.logging.Logger;
import org.ndexbio.common.NdexClasses;
import org.ndexbio.common.access.NdexDatabase;
import org.ndexbio.common.exceptions.NdexException;
import org.ndexbio.common.exceptions.ObjectNotFoundException;
import org.ndexbio.common.exceptions.ValidationException;
import org.ndexbio.common.models.dao.orientdb.Helper;
import org.ndexbio.common.models.dao.orientdb.NetworkDAO;
import org.ndexbio.common.models.object.network.RawCitation;
import org.ndexbio.common.models.object.network.RawNamespace;
import org.ndexbio.common.models.object.network.RawSupport;
import org.ndexbio.model.object.network.Citation;
import org.ndexbio.model.object.network.Edge;
import org.ndexbio.model.object.network.FunctionTerm;
import org.ndexbio.model.object.network.Network;
import org.ndexbio.model.object.network.NetworkSummary;
import org.ndexbio.model.object.network.Support;
import org.ndexbio.model.object.network.VisibilityType;
import org.ndexbio.model.object.NdexPropertyValuePair;
import org.ndexbio.model.object.ProvenanceEntity;
import org.ndexbio.model.object.SimplePropertyValuePair;
import org.ndexbio.common.util.NdexUUIDFactory;
import org.ndexbio.model.object.network.Namespace;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Preconditions;
import com.orientechnologies.orient.core.metadata.schema.OType;
import com.orientechnologies.orient.core.record.impl.ODocument;
import com.orientechnologies.orient.core.sql.query.OSQLSynchQuery;
import com.tinkerpop.blueprints.impls.orient.OrientVertex;
/*
* An implementation of the NDExPersistenceService interface that uses a
* in-memory cache to provide persistence for new ndex doain objects
*
*
* Utilizes a Google Guava cache that uses Jdexids as keys and VertexFrame implementations
* as values
*/
public class NdexPersistenceService extends PersistenceService {
public static final String defaultCitationType="URI";
public static final String pmidPrefix = "pmid:";
// key is the element_id of a BaseTerm, value is the id of the node which this BaseTerm represents
private Map<Long, Long> baseTermNodeIdMap;
// Store the mapping in memory to have better performance.
// private NdexDatabase database;
// key is the edge id which this term reifed.
private Map<Long,Long> edgeIdReifiedEdgeTermIdMap;
// maps an external node id to new node id created in Ndex.
private Map<String, Long> externalIdNodeMap;
//key is a function term Id, value is the node id which uses
// that function as represents term
private Map<Long,Long> functionTermIdNodeIdMap;
// maps a node name to Node Id.
private Map<String, Long> namedNodeMap;
// key is the full URI or other fully qualified baseTerm as a string.
// private LoadingCache<String, BaseTerm> baseTermStrCache;
private ODocument networkDoc;
// protected OrientVertex networkVertex;
private ODocument ownerDoc;
private Map<RawCitation, Long> rawCitationMap;
private Map<FunctionTerm, Long> rawFunctionTermFunctionTermIdMap;
private Map<RawSupport, Long> rawSupportMap;
// key is a "rawFunctionTerm", which has element id as -1. This table
// matches the key to a functionTerm that has been stored in the db.
private Map<Long, Long> reifiedEdgeTermIdNodeIdMap;
// private LoadingCache<Long, Node> reifiedEdgeTermNodeCache;
//key is the name of the node. This cache is for loading simple SIF
// for now
// private LoadingCache<String, Node> namedNodeCache;
/*
* Currently, the procces flow of this class is:
*
* 1. create object
* 2. Create New network
*/
public NdexPersistenceService(NdexDatabase db) {
super(db);
this.network = null;
this.ownerDoc = null;
this.rawCitationMap = new TreeMap <RawCitation, Long> ();
this.baseTermNodeIdMap = new TreeMap <Long,Long> ();
this.namedNodeMap = new TreeMap <String, Long> ();
this.reifiedEdgeTermIdNodeIdMap = new HashMap<Long,Long>(100);
this.edgeIdReifiedEdgeTermIdMap = new HashMap<Long,Long>(100);
this.rawFunctionTermFunctionTermIdMap = new TreeMap<FunctionTerm, Long> ();
this.rawSupportMap = new TreeMap<RawSupport, Long> ();
this.functionTermIdNodeIdMap = new HashMap<Long,Long>(100);
// intialize caches.
externalIdNodeMap = new TreeMap<String,Long>();
logger = Logger.getLogger(NdexPersistenceService.class.getName());
}
public NdexPersistenceService(NdexDatabase db, UUID networkID) throws NdexException {
super(db);
this.networkDoc = this.networkDAO.getNetworkDocByUUID(networkID);
this.network = NetworkDAO.getNetworkSummary(networkDoc);
this.rawCitationMap = new TreeMap <RawCitation, Long> ();
this.baseTermNodeIdMap = new TreeMap <Long,Long> ();
this.namedNodeMap = new TreeMap <String, Long> ();
this.reifiedEdgeTermIdNodeIdMap = new HashMap<Long,Long>(100);
this.edgeIdReifiedEdgeTermIdMap = new HashMap<Long,Long>(100);
this.rawFunctionTermFunctionTermIdMap = new TreeMap<FunctionTerm, Long> ();
this.rawSupportMap = new TreeMap<RawSupport, Long> ();
this.functionTermIdNodeIdMap = new HashMap<Long,Long>(100);
// intialize caches.
externalIdNodeMap = new TreeMap<String,Long>();
logger = Logger.getLogger(NdexPersistenceService.class.getName());
}
public void abortTransaction() {
System.out.println(this.getClass().getName()
+ ".abortTransaction has been invoked.");
//localConnection.rollback();
graph.rollback();
// make sure everything relate to the network is deleted.
//localConnection.begin();
logger.info("Deleting partial network "+ network.getExternalId().toString() + " in order to rollback in response to error");
this.networkDAO.deleteNetwork(network.getExternalId().toString());
//localConnection.commit();
graph.commit();
logger.info("Partial network "+ network.getExternalId().toString() + " is deleted.");
}
// alias is treated as a baseTerm
public void addAliasToNode(long nodeId, String[] aliases) throws ExecutionException, NdexException {
ODocument nodeDoc = elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
for (String alias : aliases) {
Long b= this.getBaseTermId(alias);
Long repNodeId = this.baseTermNodeIdMap.get(b);
if ( repNodeId != null && repNodeId.equals(nodeId)) {
// logger.warning("Alias '" + alias + "' is also the represented base term of node " +
// nodeId +". Alias ignored.");
} else {
ODocument bDoc = elementIdCache.get(b);
OrientVertex bV = graph.getVertex(bDoc);
nodeV.addEdge(NdexClasses.Node_E_alias, bV);
elementIdCache.put(b, bV.getRecord());
}
}
// nodeV.getRecord().reload();
elementIdCache.put(nodeId, nodeV.getRecord());
}
public void addCitationToElement(long elementId, Long citationId, String className) throws ExecutionException {
ODocument elementRec = elementIdCache.get(elementId);
OrientVertex nodeV = graph.getVertex(elementRec);
ODocument citationRec = elementIdCache.get(citationId);
OrientVertex citationV = graph.getVertex(citationRec);
if ( className.equals(NdexClasses.Node) ) {
nodeV.addEdge(NdexClasses.Node_E_ciations, graph.getVertex(citationV));
} else if ( className.equals(NdexClasses.Edge) ) {
nodeV.addEdge(NdexClasses.Edge_E_citations, graph.getVertex(citationV));
}
ODocument o = nodeV.getRecord();
// o.reload();
elementIdCache.put(elementId, o);
}
//TODO: generalize this function so that createEdge(....) can use it.
public void addMetaDataToNode (Long subjectNodeId, Long supportId, Long citationId, Map<String,String> annotations)
throws ExecutionException, NdexException {
ODocument nodeDoc = this.elementIdCache.get(subjectNodeId);
OrientVertex nodeVertex = graph.getVertex(nodeDoc);
if ( supportId != null) {
ODocument supportDoc = this.elementIdCache.get(supportId);
OrientVertex supportV = graph.getVertex(supportDoc);
nodeVertex.addEdge(NdexClasses.Node_E_supports, supportV);
this.elementIdCache.put(supportId, supportV.getRecord());
}
if (citationId != null) {
ODocument citationDoc = elementIdCache.get(citationId) ;
OrientVertex citationV = graph.getVertex(citationDoc);
nodeVertex.addEdge(NdexClasses.Node_E_ciations, citationV);
this.elementIdCache.put(citationId, citationV.getRecord());
}
if ( annotations != null) {
for (Map.Entry<String, String> e : annotations.entrySet()) {
OrientVertex pV = this.createNdexPropertyVertex(new NdexPropertyValuePair(e.getKey(),e.getValue()));
nodeVertex.addEdge(NdexClasses.E_ndexProperties, pV);
NdexPropertyValuePair p = new NdexPropertyValuePair();
p.setPredicateString(e.getKey());
p.setDataType(e.getValue());
}
}
// nodeDoc.reload();
this.elementIdCache.put(subjectNodeId, nodeVertex.getRecord());
}
private OrientVertex addPropertyToVertex(OrientVertex v, NdexPropertyValuePair p)
throws ExecutionException, NdexException {
OrientVertex pV = this.createNdexPropertyVertex(p);
v.addEdge(NdexClasses.E_ndexProperties, pV);
return v;
}
// alias is treated as a baseTerm
public void addRelatedTermToNode(long nodeId, String[] relatedTerms) throws ExecutionException, NdexException {
ODocument nodeDoc = elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
for (String rT : relatedTerms) {
Long bID= this.getBaseTermId(rT);
ODocument bDoc = elementIdCache.get(bID);
OrientVertex bV = graph.getVertex(bDoc);
nodeV.addEdge(NdexClasses.Node_E_relateTo, bV);
elementIdCache.put(bID, bV.getRecord());
}
// nodeV.getRecord().reload();
elementIdCache.put(nodeId, nodeV.getRecord());
}
/**
* Create an edge in the database.
* @param subjectNodeId
* @param objectNodeId
* @param predicateId
* @param support
* @param citation
* @param annotation
* @return The element id of the created edge.
* @throws NdexException
* @throws ExecutionException
*/
public Long createEdge(Long subjectNodeId, Long objectNodeId, Long predicateId,
Long supportId, Long citationId, Map<String,String> annotation )
throws NdexException, ExecutionException {
if (null != objectNodeId && null != subjectNodeId && null != predicateId) {
Long edgeId = database.getNextId();
ODocument subjectNodeDoc = elementIdCache.get(subjectNodeId) ;
ODocument objectNodeDoc = elementIdCache.get(objectNodeId) ;
ODocument predicateDoc = elementIdCache.get(predicateId) ;
ODocument edgeDoc = new ODocument(NdexClasses.Edge);
edgeDoc = edgeDoc.field(NdexClasses.Element_ID, edgeId)
.save();
OrientVertex edgeVertex = graph.getVertex(edgeDoc);
if ( annotation != null) {
for (Map.Entry<String, String> e : annotation.entrySet()) {
OrientVertex pV = this.createNdexPropertyVertex(
new NdexPropertyValuePair(e.getKey(),e.getValue()));
edgeVertex.addEdge(NdexClasses.E_ndexProperties, pV);
NdexPropertyValuePair p = new NdexPropertyValuePair();
p.setPredicateString(e.getKey());
p.setDataType(e.getValue());
}
}
networkVertex.addEdge(NdexClasses.Network_E_Edges, edgeVertex);
OrientVertex predicateV = graph.getVertex(predicateDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_predicate, predicateV);
OrientVertex objectV = graph.getVertex(objectNodeDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_object, objectV);
OrientVertex subjectV = graph.getVertex(subjectNodeDoc);
subjectV.addEdge(NdexClasses.Edge_E_subject, edgeVertex);
network.setEdgeCount(network.getEdgeCount()+1);
if (citationId != null) {
ODocument citationDoc = elementIdCache.get(citationId) ;
OrientVertex citationV = graph.getVertex(citationDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_citations, citationV);
this.elementIdCache.put(citationId, citationV.getRecord());
}
if ( supportId != null) {
ODocument supportDoc =elementIdCache.get(supportId);
OrientVertex supportV = graph.getVertex(supportDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_supports, supportV);
this.elementIdCache.put(supportId, supportV.getRecord());
}
elementIdCache.put(edgeId, edgeVertex.getRecord());
elementIdCache.put(subjectNodeId, subjectV.getRecord() );
elementIdCache.put(objectNodeId, objectV.getRecord());
elementIdCache.put(predicateId, predicateV.getRecord());
return edgeId;
}
throw new NdexException("Null value for one of the parameter when creating Edge.");
}
public Edge createEdge(Long subjectNodeId, Long objectNodeId, Long predicateId,
Support support, Citation citation, List<NdexPropertyValuePair> properties,
List<SimplePropertyValuePair> presentationProps )
throws NdexException, ExecutionException {
if (null != objectNodeId && null != subjectNodeId && null != predicateId) {
Edge edge = new Edge();
edge.setId(database.getNextId());
edge.setSubjectId(subjectNodeId);
edge.setObjectId(objectNodeId);
edge.setPredicateId(predicateId);
ODocument subjectNodeDoc = elementIdCache.get(subjectNodeId) ;
ODocument objectNodeDoc = elementIdCache.get(objectNodeId) ;
ODocument predicateDoc = elementIdCache.get(predicateId) ;
ODocument edgeDoc = new ODocument(NdexClasses.Edge);
edgeDoc = edgeDoc.field(NdexClasses.Element_ID, edge.getId())
.save();
OrientVertex edgeVertex = this.graph.getVertex(edgeDoc);
this.addPropertiesToVertex(edgeVertex, properties, presentationProps);
this.networkVertex.addEdge(NdexClasses.Network_E_Edges, edgeVertex);
OrientVertex predicateV = this.graph.getVertex(predicateDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_predicate, predicateV);
OrientVertex objectV = this.graph.getVertex(objectNodeDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_object, objectV);
OrientVertex subjectV = this.graph.getVertex(subjectNodeDoc);
subjectV.addEdge(NdexClasses.Edge_E_subject, edgeVertex);
this.network.setEdgeCount(this.network.getEdgeCount()+1);
// add citation.
if (citation != null) {
ODocument citationDoc = this.elementIdCache.get(citation.getId());
OrientVertex citationV = this.graph.getVertex(citationDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_citations, citationV);
edge.getCitations().add(citation.getId());
this.elementIdCache.put(citation.getId(),citationV.getRecord());
}
if ( support != null) {
ODocument supportDoc = this.elementIdCache.get(support.getId());
OrientVertex supportV = this.graph.getVertex(supportDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_supports, supportV);
edge.getSupports().add(support.getId());
this.elementIdCache.put(support.getId(), supportV.getRecord());
}
// edgeDoc.reload();
elementIdCache.put(edge.getId(), edgeVertex.getRecord());
elementIdCache.put(subjectNodeId, subjectV.getRecord());
elementIdCache.put(objectNodeId, objectV.getRecord());
elementIdCache.put(predicateId, predicateV.getRecord());
return edge;
}
throw new NdexException("Null value for one of the parameter when creating Edge.");
}
public void createNamespace2(String prefix, String URI) throws NdexException {
RawNamespace r = new RawNamespace(prefix, URI);
getNamespace(r);
}
/*
private ODocument createNdexPropertyDoc(String key, String value) {
ODocument pDoc = new ODocument(NdexClasses.NdexProperty);
pDoc.field(NdexClasses.ndexProp_P_predicateStr,key)
.field(NdexClasses.ndexProp_P_value, value)
.save();
return pDoc;
}
*/
private NetworkSummary createNetwork(String title, String version, UUID uuid) throws NdexException{
this.network = new NetworkSummary();
this.network.setExternalId(uuid);
this.network.setURI(NdexDatabase.getURIPrefix()+"/" + uuid.toString());
this.network.setName(title);
this.network.setVisibility(VisibilityType.PRIVATE);
this.network.setIsLocked(false);
this.network.setIsComplete(false);
this.networkDoc = new ODocument (NdexClasses.Network)
.fields(NdexClasses.Network_P_UUID,this.network.getExternalId().toString(),
NdexClasses.ExternalObj_cTime, this.network.getCreationTime(),
NdexClasses.ExternalObj_mTime, this.network.getModificationTime(),
NdexClasses.Network_P_name, this.network.getName(),
NdexClasses.Network_P_isLocked, this.network.getIsLocked(),
NdexClasses.Network_P_isComplete, this.network.getIsComplete(),
NdexClasses.Network_P_visibility, this.network.getVisibility().toString());
if ( version != null) {
this.network.setVersion(version);
this.networkDoc.field(NdexClasses.Network_P_version, version);
}
this.networkDoc =this.networkDoc.save();
this.networkVertex = this.graph.getVertex(getNetworkDoc());
OrientVertex ownerV = this.graph.getVertex(this.ownerDoc);
ownerV.addEdge(NdexClasses.E_admin, this.networkVertex);
return this.network;
}
/*
* public method to allow xbel parsing components to rollback the
* transaction and close the database connection if they encounter an error
* situation
*/
public void createNewNetwork(String ownerName, String networkTitle, String version) throws Exception {
createNewNetwork(ownerName, networkTitle, version,NdexUUIDFactory.INSTANCE.getNDExUUID() );
}
/*
* public method to persist INetwork to the orientdb database using cache
* contents.
*/
public void createNewNetwork(String ownerName, String networkTitle, String version, UUID uuid) throws NdexException {
Preconditions.checkNotNull(ownerName,"A network owner name is required");
Preconditions.checkNotNull(networkTitle,"A network title is required");
// find the network owner in the database
ownerDoc = findUserByAccountName(ownerName);
if( null == ownerDoc){
String message = "Account " +ownerName +" is not registered in the database";
logger.severe(message);
throw new NdexException(message);
}
createNetwork(networkTitle,version, uuid);
logger.info("A new NDex network titled: " +network.getName()
+" owned by " +ownerName +" has been created");
}
/*
public void networkProgressLogCheck() {
commitCounter++;
if (commitCounter % 1000 == 0) {
logger.info("Checkpoint: Number of edges " + this.edgeCache.size());
}
}
*/
/**
* performing delete the current network but not commiting it.
*/
/* public void deleteNetwork() {
// TODO Implement deletion of network
System.out
.println("deleteNetwork called. Not yet implemented");
} */
/**
*
* @param id the node id that was assigned by external source.
* @param name the name of the node. If the value is null, no node name will be
* created in Ndex.
* @return
*/
public Long findOrCreateNodeIdByExternalId(String id, String name) {
Long nodeId = this.externalIdNodeMap.get(id);
if ( nodeId != null) return nodeId;
//create a node for this external id.
nodeId = database.getNextId();
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc.field(NdexClasses.Element_ID, nodeId);
if ( name != null)
nodeDoc.field(NdexClasses.Node_P_name, name);
nodeDoc = nodeDoc.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
externalIdNodeMap.put(id, nodeId);
return nodeId;
}
private Long findOrCreateNodeIdFromBaseTermId(Long bTermId) throws ExecutionException {
Long nodeId = this.baseTermNodeIdMap.get(bTermId);
if (nodeId != null)
return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(bTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc =nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex bTermV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, bTermV);
network.setNodeCount(network.getNodeCount()+1);
nodeDoc = nodeV.getRecord();
elementIdCache.put(nodeId, nodeDoc);
elementIdCache.put(bTermId, bTermV.getRecord());
this.baseTermNodeIdMap.put(bTermId, nodeId);
return nodeId;
}
/**
* Find a user based on account name.
* @param accountName
* @return ODocument object that hold data for this user account
* @throws NdexException
*/
private ODocument findUserByAccountName(String accountName)
throws NdexException
{
if (accountName == null )
throw new ValidationException("No accountName was specified.");
final String query = "select * from " + NdexClasses.Account +
" where accountName = '" + accountName + "'";
List<ODocument> userDocumentList = localConnection
.query(new OSQLSynchQuery<ODocument>(query));
if ( ! userDocumentList.isEmpty()) {
return userDocumentList.get(0);
}
return null;
}
/*
@Override
protected Long createBaseTerm(String localTerm, long nsId) throws ExecutionException {
Long termId = database.getNextId();
ODocument btDoc = new ODocument(NdexClasses.BaseTerm)
.fields(NdexClasses.BTerm_P_name, localTerm,
NdexClasses.Element_ID, termId)
.save();
OrientVertex basetermV = graph.getVertex(btDoc);
if ( nsId >= 0) {
ODocument nsDoc = elementIdCache.get(nsId);
OrientVertex nsV = graph.getVertex(nsDoc);
basetermV.addEdge(NdexClasses.BTerm_E_Namespace, nsV);
}
networkVertex.addEdge(NdexClasses.Network_E_BaseTerms, basetermV);
elementIdCache.put(termId, btDoc);
return termId;
}
*/
public Long getBaseTermId (Namespace namespace, String localTerm) throws NdexException, ExecutionException {
if ( namespace.getPrefix() != null ) {
return getBaseTermId(namespace.getPrefix()+":"+localTerm);
}
return getBaseTermId(namespace.getUri()+localTerm);
}
public Long getCitationId(String title, String idType, String identifier,
List<String> contributors) throws NdexException, ExecutionException {
RawCitation rCitation = new RawCitation(title, idType, identifier, contributors);
Long citationId = rawCitationMap.get(rCitation);
if ( citationId != null ) {
return citationId;
}
// persist the citation object in db.
citationId = createCitation(title, idType, identifier, contributors, null,null);
rawCitationMap.put(rCitation, citationId);
return citationId;
}
public NetworkSummary getCurrentNetwork() {
return this.network;
}
// input parameter is a "rawFunctionTerm", which has element_id as -1;
public Long getFunctionTermId(Long baseTermId, List<Long> termList) throws ExecutionException {
FunctionTerm func = new FunctionTerm();
func.setFunctionTermId(baseTermId);
for ( Long termId : termList) {
func.getParameters().add( termId);
}
Long functionTermId = this.rawFunctionTermFunctionTermIdMap.get(func);
if ( functionTermId != null) return functionTermId;
functionTermId = createFunctionTerm(baseTermId, termList);
this.rawFunctionTermFunctionTermIdMap.put(func, functionTermId);
return functionTermId;
}
private ODocument getNetworkDoc() {
return networkDoc;
}
/**
* Create or Find a node from a baseTerm.
* @param termString
* @return
* @throws ExecutionException
* @throws NdexException
*/
public Long getNodeIdByBaseTerm(String termString) throws ExecutionException, NdexException {
Long id = this.getBaseTermId(termString);
return this.findOrCreateNodeIdFromBaseTermId(id);
}
public Long getNodeIdByFunctionTermId(Long funcTermId) throws ExecutionException {
Long nodeId = this.functionTermIdNodeIdMap.get(funcTermId) ;
if (nodeId != null) return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(funcTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc = nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
elementIdCache.put(funcTermId, termV.getRecord());
this.functionTermIdNodeIdMap.put(funcTermId, nodeId);
return nodeId;
}
public Long getNodeIdByName(String key) {
Long nodeId = this.namedNodeMap.get(key);
if ( nodeId !=null ) {
return nodeId;
}
// otherwise insert Node.
nodeId = database.getNextId();
ODocument nodeDoc = new ODocument(NdexClasses.Node)
.fields(NdexClasses.Element_ID, nodeId,
NdexClasses.Node_P_name, key)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
this.namedNodeMap.put(key,nodeId);
return nodeId;
}
public Long getNodeIdByReifiedEdgeTermId(Long reifiedEdgeTermId) throws ExecutionException {
Long nodeId = this.reifiedEdgeTermIdNodeIdMap.get(reifiedEdgeTermId);
if (nodeId != null)
return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(reifiedEdgeTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc = nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
elementIdCache.put(reifiedEdgeTermId, termV.getRecord());
this.reifiedEdgeTermIdNodeIdMap.put(reifiedEdgeTermId, nodeId);
return nodeId;
}
public Long getReifiedEdgeTermIdFromEdgeId(Long edgeId) throws ExecutionException {
Long reifiedEdgeTermId = this.edgeIdReifiedEdgeTermIdMap.get(edgeId);
if (reifiedEdgeTermId != null) return reifiedEdgeTermId;
// create new term
reifiedEdgeTermId = this.database.getNextId();
ODocument eTermdoc = new ODocument (NdexClasses.ReifiedEdgeTerm);
eTermdoc = eTermdoc.field(NdexClasses.Element_ID, reifiedEdgeTermId)
.save();
OrientVertex etV = graph.getVertex(eTermdoc);
ODocument edgeDoc = elementIdCache.get(edgeId);
OrientVertex edgeV = graph.getVertex(edgeDoc);
etV.addEdge(NdexClasses.ReifedEdge_E_edge, edgeV);
networkVertex.addEdge(NdexClasses.Network_E_ReifedEdgeTerms,
etV);
elementIdCache.put(reifiedEdgeTermId, etV.getRecord());
elementIdCache.put(edgeId,edgeV.getRecord());
this.edgeIdReifiedEdgeTermIdMap.put(edgeId, reifiedEdgeTermId);
return reifiedEdgeTermId;
}
public Long getSupportId(String literal, Long citationId) throws ExecutionException {
RawSupport r = new RawSupport(literal, citationId);
Long supportId = this.rawSupportMap.get(r);
if ( supportId != null ) return supportId;
// persist the support object in db.
supportId = createSupport(literal, citationId);
this.rawSupportMap.put(r, supportId);
return supportId;
}
public void persistNetwork() {
try {
network.setIsComplete(true);
getNetworkDoc().field(NdexClasses.Network_P_isComplete,true)
.field(NdexClasses.Network_P_edgeCount, network.getEdgeCount())
.field(NdexClasses.Network_P_nodeCount, network.getNodeCount())
.save();
System.out.println("The new network " + network.getName()
+ " is complete");
} catch (Exception e) {
System.out.println("unexpected error in persist network...");
e.printStackTrace();
} finally {
this.localConnection.commit();
localConnection.close();
this.database.close();
System.out
.println("Connection to orientdb database has been closed");
}
}
public void setNetworkProperties(Collection<NdexPropertyValuePair> properties,
Collection<SimplePropertyValuePair> presentationProperties) throws NdexException, ExecutionException {
addPropertiesToVertex ( networkVertex, properties, presentationProperties);
}
public void setNetworkProvenance(ProvenanceEntity e) throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
String provenanceString = mapper.writeValueAsString(e);
// store provenance string
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_provenance, provenanceString)
.save();
}
public void setNetworkTitleAndDescription(String title, String description) {
if ( description != null ) {
this.network.setDescription(description);
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_desc, description).save();
}
if ( title != null) {
this.network.setName(title);
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_name, title).save();
}
}
public void setNodeName(long nodeId, String name) throws ExecutionException {
ODocument nodeDoc = elementIdCache.get(nodeId);
nodeDoc = nodeDoc.field(NdexClasses.Node_P_name, name).save();
elementIdCache.put(nodeId, nodeDoc);
}
public void setElementProperty(Long elementId, String key, String value) throws ExecutionException, NdexException {
ODocument elementDoc = this.elementIdCache.get(elementId);
OrientVertex v = graph.getVertex(elementDoc);
v = this.addPropertyToVertex(v, new NdexPropertyValuePair(key,value));
elementDoc = v.getRecord();
this.elementIdCache.put(elementId, elementDoc);
}
public void setElementPresentationProperty(Long elementId, String key, String value) throws ExecutionException {
ODocument elementDoc = this.elementIdCache.get(elementId);
OrientVertex v = graph.getVertex(elementDoc);
ODocument pDoc = this.createSimplePropertyDoc(key,value);
pDoc = pDoc.save();
OrientVertex pV = graph.getVertex(pDoc);
v.addEdge(NdexClasses.E_ndexPresentationProps, pV);
elementDoc = v.getRecord();
this.elementIdCache.put(elementId, elementDoc);
}
public void setNodeProperties(Long nodeId, Collection<NdexPropertyValuePair> properties,
Collection<SimplePropertyValuePair> presentationProperties) throws ExecutionException, NdexException {
ODocument nodeDoc = this.elementIdCache.get(nodeId);
OrientVertex v = graph.getVertex(nodeDoc);
addPropertiesToVertex ( v, properties, presentationProperties);
this.elementIdCache.put(nodeId, v.getRecord());
}
/**
* create a represent edge from a node to a term.
* @param nodeId
* @param TermId
* @throws ExecutionException
*/
public void setNodeRepresentTerm(long nodeId, long termId) throws ExecutionException {
ODocument nodeDoc = this.elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
ODocument termDoc = this.elementIdCache.get(termId);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
this.elementIdCache.put(nodeId, nodeV.getRecord());
this.elementIdCache.put(termId, termV.getRecord());
}
public void updateNetworkSummary() throws ObjectNotFoundException, NdexException, ExecutionException {
networkDoc = Helper.updateNetworkProfile(networkDoc, network);
addPropertiesToVertex(this.networkVertex,
network.getProperties(),network.getPresentationProperties());
networkDoc = this.networkVertex.getRecord();
}
}
| src/main/java/org/ndexbio/common/persistence/orientdb/NdexPersistenceService.java | package org.ndexbio.common.persistence.orientdb;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.UUID;
import java.util.concurrent.ExecutionException;
import java.util.logging.Logger;
import org.ndexbio.common.NdexClasses;
import org.ndexbio.common.access.NdexDatabase;
import org.ndexbio.common.exceptions.NdexException;
import org.ndexbio.common.exceptions.ObjectNotFoundException;
import org.ndexbio.common.exceptions.ValidationException;
import org.ndexbio.common.models.dao.orientdb.Helper;
import org.ndexbio.common.models.dao.orientdb.NetworkDAO;
import org.ndexbio.common.models.object.network.RawCitation;
import org.ndexbio.common.models.object.network.RawNamespace;
import org.ndexbio.common.models.object.network.RawSupport;
import org.ndexbio.model.object.network.Citation;
import org.ndexbio.model.object.network.Edge;
import org.ndexbio.model.object.network.FunctionTerm;
import org.ndexbio.model.object.network.Network;
import org.ndexbio.model.object.network.NetworkSummary;
import org.ndexbio.model.object.network.Support;
import org.ndexbio.model.object.network.VisibilityType;
import org.ndexbio.model.object.NdexPropertyValuePair;
import org.ndexbio.model.object.ProvenanceEntity;
import org.ndexbio.model.object.SimplePropertyValuePair;
import org.ndexbio.common.util.NdexUUIDFactory;
import org.ndexbio.model.object.network.Namespace;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.base.Preconditions;
import com.orientechnologies.orient.core.metadata.schema.OType;
import com.orientechnologies.orient.core.record.impl.ODocument;
import com.orientechnologies.orient.core.sql.query.OSQLSynchQuery;
import com.tinkerpop.blueprints.impls.orient.OrientVertex;
/*
* An implementation of the NDExPersistenceService interface that uses a
* in-memory cache to provide persistence for new ndex doain objects
*
*
* Utilizes a Google Guava cache that uses Jdexids as keys and VertexFrame implementations
* as values
*/
public class NdexPersistenceService extends PersistenceService {
public static final String defaultCitationType="URI";
public static final String pmidPrefix = "pmid:";
// key is the element_id of a BaseTerm, value is the id of the node which this BaseTerm represents
private Map<Long, Long> baseTermNodeIdMap;
// Store the mapping in memory to have better performance.
// private NdexDatabase database;
// key is the edge id which this term reifed.
private Map<Long,Long> edgeIdReifiedEdgeTermIdMap;
// maps an external node id to new node id created in Ndex.
private Map<String, Long> externalIdNodeMap;
//key is a function term Id, value is the node id which uses
// that function as represents term
private Map<Long,Long> functionTermIdNodeIdMap;
// maps a node name to Node Id.
private Map<String, Long> namedNodeMap;
// key is the full URI or other fully qualified baseTerm as a string.
// private LoadingCache<String, BaseTerm> baseTermStrCache;
private ODocument networkDoc;
// protected OrientVertex networkVertex;
private ODocument ownerDoc;
private Map<RawCitation, Long> rawCitationMap;
private Map<FunctionTerm, Long> rawFunctionTermFunctionTermIdMap;
private Map<RawSupport, Long> rawSupportMap;
// key is a "rawFunctionTerm", which has element id as -1. This table
// matches the key to a functionTerm that has been stored in the db.
private Map<Long, Long> reifiedEdgeTermIdNodeIdMap;
// private LoadingCache<Long, Node> reifiedEdgeTermNodeCache;
//key is the name of the node. This cache is for loading simple SIF
// for now
// private LoadingCache<String, Node> namedNodeCache;
/*
* Currently, the procces flow of this class is:
*
* 1. create object
* 2. Create New network
*/
public NdexPersistenceService(NdexDatabase db) {
super(db);
this.network = null;
this.ownerDoc = null;
this.rawCitationMap = new TreeMap <RawCitation, Long> ();
this.baseTermNodeIdMap = new TreeMap <Long,Long> ();
this.namedNodeMap = new TreeMap <String, Long> ();
this.reifiedEdgeTermIdNodeIdMap = new HashMap<Long,Long>(100);
this.edgeIdReifiedEdgeTermIdMap = new HashMap<Long,Long>(100);
this.rawFunctionTermFunctionTermIdMap = new TreeMap<FunctionTerm, Long> ();
this.rawSupportMap = new TreeMap<RawSupport, Long> ();
this.functionTermIdNodeIdMap = new HashMap<Long,Long>(100);
// intialize caches.
externalIdNodeMap = new TreeMap<String,Long>();
logger = Logger.getLogger(NdexPersistenceService.class.getName());
}
public NdexPersistenceService(NdexDatabase db, UUID networkID) throws NdexException {
super(db);
this.networkDoc = this.networkDAO.getNetworkDocByUUID(networkID);
this.network = NetworkDAO.getNetworkSummary(networkDoc);
this.rawCitationMap = new TreeMap <RawCitation, Long> ();
this.baseTermNodeIdMap = new TreeMap <Long,Long> ();
this.namedNodeMap = new TreeMap <String, Long> ();
this.reifiedEdgeTermIdNodeIdMap = new HashMap<Long,Long>(100);
this.edgeIdReifiedEdgeTermIdMap = new HashMap<Long,Long>(100);
this.rawFunctionTermFunctionTermIdMap = new TreeMap<FunctionTerm, Long> ();
this.rawSupportMap = new TreeMap<RawSupport, Long> ();
this.functionTermIdNodeIdMap = new HashMap<Long,Long>(100);
// intialize caches.
externalIdNodeMap = new TreeMap<String,Long>();
logger = Logger.getLogger(NdexPersistenceService.class.getName());
}
public void abortTransaction() {
System.out.println(this.getClass().getName()
+ ".abortTransaction has been invoked.");
//localConnection.rollback();
graph.rollback();
// make sure everything relate to the network is deleted.
//localConnection.begin();
deleteNetwork();
//localConnection.commit();
graph.commit();
System.out.println("Deleting network in order to rollback in response to error");
}
// alias is treated as a baseTerm
public void addAliasToNode(long nodeId, String[] aliases) throws ExecutionException, NdexException {
ODocument nodeDoc = elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
for (String alias : aliases) {
Long b= this.getBaseTermId(alias);
Long repNodeId = this.baseTermNodeIdMap.get(b);
if ( repNodeId != null && repNodeId.equals(nodeId)) {
// logger.warning("Alias '" + alias + "' is also the represented base term of node " +
// nodeId +". Alias ignored.");
} else {
ODocument bDoc = elementIdCache.get(b);
OrientVertex bV = graph.getVertex(bDoc);
nodeV.addEdge(NdexClasses.Node_E_alias, bV);
elementIdCache.put(b, bV.getRecord());
}
}
// nodeV.getRecord().reload();
elementIdCache.put(nodeId, nodeV.getRecord());
}
public void addCitationToElement(long elementId, Long citationId, String className) throws ExecutionException {
ODocument elementRec = elementIdCache.get(elementId);
OrientVertex nodeV = graph.getVertex(elementRec);
ODocument citationRec = elementIdCache.get(citationId);
OrientVertex citationV = graph.getVertex(citationRec);
if ( className.equals(NdexClasses.Node) ) {
nodeV.addEdge(NdexClasses.Node_E_ciations, graph.getVertex(citationV));
} else if ( className.equals(NdexClasses.Edge) ) {
nodeV.addEdge(NdexClasses.Edge_E_citations, graph.getVertex(citationV));
}
ODocument o = nodeV.getRecord();
// o.reload();
elementIdCache.put(elementId, o);
}
//TODO: generalize this function so that createEdge(....) can use it.
public void addMetaDataToNode (Long subjectNodeId, Long supportId, Long citationId, Map<String,String> annotations)
throws ExecutionException, NdexException {
ODocument nodeDoc = this.elementIdCache.get(subjectNodeId);
OrientVertex nodeVertex = graph.getVertex(nodeDoc);
if ( supportId != null) {
ODocument supportDoc = this.elementIdCache.get(supportId);
OrientVertex supportV = graph.getVertex(supportDoc);
nodeVertex.addEdge(NdexClasses.Node_E_supports, supportV);
this.elementIdCache.put(supportId, supportV.getRecord());
}
if (citationId != null) {
ODocument citationDoc = elementIdCache.get(citationId) ;
OrientVertex citationV = graph.getVertex(citationDoc);
nodeVertex.addEdge(NdexClasses.Node_E_ciations, citationV);
this.elementIdCache.put(citationId, citationV.getRecord());
}
if ( annotations != null) {
for (Map.Entry<String, String> e : annotations.entrySet()) {
OrientVertex pV = this.createNdexPropertyVertex(new NdexPropertyValuePair(e.getKey(),e.getValue()));
nodeVertex.addEdge(NdexClasses.E_ndexProperties, pV);
NdexPropertyValuePair p = new NdexPropertyValuePair();
p.setPredicateString(e.getKey());
p.setDataType(e.getValue());
}
}
// nodeDoc.reload();
this.elementIdCache.put(subjectNodeId, nodeVertex.getRecord());
}
private OrientVertex addPropertyToVertex(OrientVertex v, NdexPropertyValuePair p)
throws ExecutionException, NdexException {
OrientVertex pV = this.createNdexPropertyVertex(p);
v.addEdge(NdexClasses.E_ndexProperties, pV);
return v;
}
// alias is treated as a baseTerm
public void addRelatedTermToNode(long nodeId, String[] relatedTerms) throws ExecutionException, NdexException {
ODocument nodeDoc = elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
for (String rT : relatedTerms) {
Long bID= this.getBaseTermId(rT);
ODocument bDoc = elementIdCache.get(bID);
OrientVertex bV = graph.getVertex(bDoc);
nodeV.addEdge(NdexClasses.Node_E_relateTo, bV);
elementIdCache.put(bID, bV.getRecord());
}
// nodeV.getRecord().reload();
elementIdCache.put(nodeId, nodeV.getRecord());
}
/**
* Create an edge in the database.
* @param subjectNodeId
* @param objectNodeId
* @param predicateId
* @param support
* @param citation
* @param annotation
* @return The element id of the created edge.
* @throws NdexException
* @throws ExecutionException
*/
public Long createEdge(Long subjectNodeId, Long objectNodeId, Long predicateId,
Long supportId, Long citationId, Map<String,String> annotation )
throws NdexException, ExecutionException {
if (null != objectNodeId && null != subjectNodeId && null != predicateId) {
Long edgeId = database.getNextId();
ODocument subjectNodeDoc = elementIdCache.get(subjectNodeId) ;
ODocument objectNodeDoc = elementIdCache.get(objectNodeId) ;
ODocument predicateDoc = elementIdCache.get(predicateId) ;
ODocument edgeDoc = new ODocument(NdexClasses.Edge);
edgeDoc = edgeDoc.field(NdexClasses.Element_ID, edgeId)
.save();
OrientVertex edgeVertex = graph.getVertex(edgeDoc);
if ( annotation != null) {
for (Map.Entry<String, String> e : annotation.entrySet()) {
OrientVertex pV = this.createNdexPropertyVertex(
new NdexPropertyValuePair(e.getKey(),e.getValue()));
edgeVertex.addEdge(NdexClasses.E_ndexProperties, pV);
NdexPropertyValuePair p = new NdexPropertyValuePair();
p.setPredicateString(e.getKey());
p.setDataType(e.getValue());
}
}
networkVertex.addEdge(NdexClasses.Network_E_Edges, edgeVertex);
OrientVertex predicateV = graph.getVertex(predicateDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_predicate, predicateV);
OrientVertex objectV = graph.getVertex(objectNodeDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_object, objectV);
OrientVertex subjectV = graph.getVertex(subjectNodeDoc);
subjectV.addEdge(NdexClasses.Edge_E_subject, edgeVertex);
network.setEdgeCount(network.getEdgeCount()+1);
if (citationId != null) {
ODocument citationDoc = elementIdCache.get(citationId) ;
OrientVertex citationV = graph.getVertex(citationDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_citations, citationV);
this.elementIdCache.put(citationId, citationV.getRecord());
}
if ( supportId != null) {
ODocument supportDoc =elementIdCache.get(supportId);
OrientVertex supportV = graph.getVertex(supportDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_supports, supportV);
this.elementIdCache.put(supportId, supportV.getRecord());
}
elementIdCache.put(edgeId, edgeVertex.getRecord());
elementIdCache.put(subjectNodeId, subjectV.getRecord() );
elementIdCache.put(objectNodeId, objectV.getRecord());
elementIdCache.put(predicateId, predicateV.getRecord());
return edgeId;
}
throw new NdexException("Null value for one of the parameter when creating Edge.");
}
public Edge createEdge(Long subjectNodeId, Long objectNodeId, Long predicateId,
Support support, Citation citation, List<NdexPropertyValuePair> properties,
List<SimplePropertyValuePair> presentationProps )
throws NdexException, ExecutionException {
if (null != objectNodeId && null != subjectNodeId && null != predicateId) {
Edge edge = new Edge();
edge.setId(database.getNextId());
edge.setSubjectId(subjectNodeId);
edge.setObjectId(objectNodeId);
edge.setPredicateId(predicateId);
ODocument subjectNodeDoc = elementIdCache.get(subjectNodeId) ;
ODocument objectNodeDoc = elementIdCache.get(objectNodeId) ;
ODocument predicateDoc = elementIdCache.get(predicateId) ;
ODocument edgeDoc = new ODocument(NdexClasses.Edge);
edgeDoc = edgeDoc.field(NdexClasses.Element_ID, edge.getId())
.save();
OrientVertex edgeVertex = this.graph.getVertex(edgeDoc);
this.addPropertiesToVertex(edgeVertex, properties, presentationProps);
this.networkVertex.addEdge(NdexClasses.Network_E_Edges, edgeVertex);
OrientVertex predicateV = this.graph.getVertex(predicateDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_predicate, predicateV);
OrientVertex objectV = this.graph.getVertex(objectNodeDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_object, objectV);
OrientVertex subjectV = this.graph.getVertex(subjectNodeDoc);
subjectV.addEdge(NdexClasses.Edge_E_subject, edgeVertex);
this.network.setEdgeCount(this.network.getEdgeCount()+1);
// add citation.
if (citation != null) {
ODocument citationDoc = this.elementIdCache.get(citation.getId());
OrientVertex citationV = this.graph.getVertex(citationDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_citations, citationV);
edge.getCitations().add(citation.getId());
this.elementIdCache.put(citation.getId(),citationV.getRecord());
}
if ( support != null) {
ODocument supportDoc = this.elementIdCache.get(support.getId());
OrientVertex supportV = this.graph.getVertex(supportDoc);
edgeVertex.addEdge(NdexClasses.Edge_E_supports, supportV);
edge.getSupports().add(support.getId());
this.elementIdCache.put(support.getId(), supportV.getRecord());
}
// edgeDoc.reload();
elementIdCache.put(edge.getId(), edgeVertex.getRecord());
elementIdCache.put(subjectNodeId, subjectV.getRecord());
elementIdCache.put(objectNodeId, objectV.getRecord());
elementIdCache.put(predicateId, predicateV.getRecord());
return edge;
}
throw new NdexException("Null value for one of the parameter when creating Edge.");
}
public void createNamespace2(String prefix, String URI) throws NdexException {
RawNamespace r = new RawNamespace(prefix, URI);
getNamespace(r);
}
/*
private ODocument createNdexPropertyDoc(String key, String value) {
ODocument pDoc = new ODocument(NdexClasses.NdexProperty);
pDoc.field(NdexClasses.ndexProp_P_predicateStr,key)
.field(NdexClasses.ndexProp_P_value, value)
.save();
return pDoc;
}
*/
private NetworkSummary createNetwork(String title, String version, UUID uuid) throws NdexException{
this.network = new NetworkSummary();
this.network.setExternalId(uuid);
this.network.setURI(NdexDatabase.getURIPrefix()+"/" + uuid.toString());
this.network.setName(title);
this.network.setVisibility(VisibilityType.PRIVATE);
this.network.setIsLocked(false);
this.network.setIsComplete(false);
this.networkDoc = new ODocument (NdexClasses.Network)
.fields(NdexClasses.Network_P_UUID,this.network.getExternalId().toString(),
NdexClasses.ExternalObj_cTime, this.network.getCreationTime(),
NdexClasses.ExternalObj_mTime, this.network.getModificationTime(),
NdexClasses.Network_P_name, this.network.getName(),
NdexClasses.Network_P_isLocked, this.network.getIsLocked(),
NdexClasses.Network_P_isComplete, this.network.getIsComplete(),
NdexClasses.Network_P_visibility, this.network.getVisibility().toString());
if ( version != null) {
this.network.setVersion(version);
this.networkDoc.field(NdexClasses.Network_P_version, version);
}
this.networkDoc =this.networkDoc.save();
this.networkVertex = this.graph.getVertex(getNetworkDoc());
OrientVertex ownerV = this.graph.getVertex(this.ownerDoc);
ownerV.addEdge(NdexClasses.E_admin, this.networkVertex);
return this.network;
}
/*
* public method to allow xbel parsing components to rollback the
* transaction and close the database connection if they encounter an error
* situation
*/
public void createNewNetwork(String ownerName, String networkTitle, String version) throws Exception {
createNewNetwork(ownerName, networkTitle, version,NdexUUIDFactory.INSTANCE.getNDExUUID() );
}
/*
* public method to persist INetwork to the orientdb database using cache
* contents.
*/
public void createNewNetwork(String ownerName, String networkTitle, String version, UUID uuid) throws NdexException {
Preconditions.checkNotNull(ownerName,"A network owner name is required");
Preconditions.checkNotNull(networkTitle,"A network title is required");
// find the network owner in the database
ownerDoc = findUserByAccountName(ownerName);
if( null == ownerDoc){
String message = "Account " +ownerName +" is not registered in the database";
logger.severe(message);
throw new NdexException(message);
}
createNetwork(networkTitle,version, uuid);
logger.info("A new NDex network titled: " +network.getName()
+" owned by " +ownerName +" has been created");
}
/*
public void networkProgressLogCheck() {
commitCounter++;
if (commitCounter % 1000 == 0) {
logger.info("Checkpoint: Number of edges " + this.edgeCache.size());
}
}
*/
/**
* performing delete the current network but not commiting it.
*/
public void deleteNetwork() {
// TODO Implement deletion of network
System.out
.println("deleteNetwork called. Not yet implemented");
}
/**
*
* @param id the node id that was assigned by external source.
* @param name the name of the node. If the value is null, no node name will be
* created in Ndex.
* @return
*/
public Long findOrCreateNodeIdByExternalId(String id, String name) {
Long nodeId = this.externalIdNodeMap.get(id);
if ( nodeId != null) return nodeId;
//create a node for this external id.
nodeId = database.getNextId();
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc.field(NdexClasses.Element_ID, nodeId);
if ( name != null)
nodeDoc.field(NdexClasses.Node_P_name, name);
nodeDoc = nodeDoc.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
externalIdNodeMap.put(id, nodeId);
return nodeId;
}
private Long findOrCreateNodeIdFromBaseTermId(Long bTermId) throws ExecutionException {
Long nodeId = this.baseTermNodeIdMap.get(bTermId);
if (nodeId != null)
return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(bTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc =nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex bTermV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, bTermV);
network.setNodeCount(network.getNodeCount()+1);
nodeDoc = nodeV.getRecord();
elementIdCache.put(nodeId, nodeDoc);
elementIdCache.put(bTermId, bTermV.getRecord());
this.baseTermNodeIdMap.put(bTermId, nodeId);
return nodeId;
}
/**
* Find a user based on account name.
* @param accountName
* @return ODocument object that hold data for this user account
* @throws NdexException
*/
private ODocument findUserByAccountName(String accountName)
throws NdexException
{
if (accountName == null )
throw new ValidationException("No accountName was specified.");
final String query = "select * from " + NdexClasses.Account +
" where accountName = '" + accountName + "'";
List<ODocument> userDocumentList = localConnection
.query(new OSQLSynchQuery<ODocument>(query));
if ( ! userDocumentList.isEmpty()) {
return userDocumentList.get(0);
}
return null;
}
/*
@Override
protected Long createBaseTerm(String localTerm, long nsId) throws ExecutionException {
Long termId = database.getNextId();
ODocument btDoc = new ODocument(NdexClasses.BaseTerm)
.fields(NdexClasses.BTerm_P_name, localTerm,
NdexClasses.Element_ID, termId)
.save();
OrientVertex basetermV = graph.getVertex(btDoc);
if ( nsId >= 0) {
ODocument nsDoc = elementIdCache.get(nsId);
OrientVertex nsV = graph.getVertex(nsDoc);
basetermV.addEdge(NdexClasses.BTerm_E_Namespace, nsV);
}
networkVertex.addEdge(NdexClasses.Network_E_BaseTerms, basetermV);
elementIdCache.put(termId, btDoc);
return termId;
}
*/
public Long getBaseTermId (Namespace namespace, String localTerm) throws NdexException, ExecutionException {
if ( namespace.getPrefix() != null ) {
return getBaseTermId(namespace.getPrefix()+":"+localTerm);
}
return getBaseTermId(namespace.getUri()+localTerm);
}
public Long getCitationId(String title, String idType, String identifier,
List<String> contributors) throws NdexException, ExecutionException {
RawCitation rCitation = new RawCitation(title, idType, identifier, contributors);
Long citationId = rawCitationMap.get(rCitation);
if ( citationId != null ) {
return citationId;
}
// persist the citation object in db.
citationId = createCitation(title, idType, identifier, contributors, null,null);
rawCitationMap.put(rCitation, citationId);
return citationId;
}
public NetworkSummary getCurrentNetwork() {
return this.network;
}
// input parameter is a "rawFunctionTerm", which has element_id as -1;
public Long getFunctionTermId(Long baseTermId, List<Long> termList) throws ExecutionException {
FunctionTerm func = new FunctionTerm();
func.setFunctionTermId(baseTermId);
for ( Long termId : termList) {
func.getParameters().add( termId);
}
Long functionTermId = this.rawFunctionTermFunctionTermIdMap.get(func);
if ( functionTermId != null) return functionTermId;
functionTermId = createFunctionTerm(baseTermId, termList);
this.rawFunctionTermFunctionTermIdMap.put(func, functionTermId);
return functionTermId;
}
private ODocument getNetworkDoc() {
return networkDoc;
}
/**
* Create or Find a node from a baseTerm.
* @param termString
* @return
* @throws ExecutionException
* @throws NdexException
*/
public Long getNodeIdByBaseTerm(String termString) throws ExecutionException, NdexException {
Long id = this.getBaseTermId(termString);
return this.findOrCreateNodeIdFromBaseTermId(id);
}
public Long getNodeIdByFunctionTermId(Long funcTermId) throws ExecutionException {
Long nodeId = this.functionTermIdNodeIdMap.get(funcTermId) ;
if (nodeId != null) return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(funcTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc = nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
elementIdCache.put(funcTermId, termV.getRecord());
this.functionTermIdNodeIdMap.put(funcTermId, nodeId);
return nodeId;
}
public Long getNodeIdByName(String key) {
Long nodeId = this.namedNodeMap.get(key);
if ( nodeId !=null ) {
return nodeId;
}
// otherwise insert Node.
nodeId = database.getNextId();
ODocument nodeDoc = new ODocument(NdexClasses.Node)
.fields(NdexClasses.Element_ID, nodeId,
NdexClasses.Node_P_name, key)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
this.namedNodeMap.put(key,nodeId);
return nodeId;
}
public Long getNodeIdByReifiedEdgeTermId(Long reifiedEdgeTermId) throws ExecutionException {
Long nodeId = this.reifiedEdgeTermIdNodeIdMap.get(reifiedEdgeTermId);
if (nodeId != null)
return nodeId;
// otherwise insert Node.
nodeId = database.getNextId();
ODocument termDoc = elementIdCache.get(reifiedEdgeTermId);
ODocument nodeDoc = new ODocument(NdexClasses.Node);
nodeDoc = nodeDoc.field(NdexClasses.Element_ID, nodeId)
.save();
OrientVertex nodeV = graph.getVertex(nodeDoc);
networkVertex.addEdge(NdexClasses.Network_E_Nodes,nodeV);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
network.setNodeCount(network.getNodeCount()+1);
elementIdCache.put(nodeId, nodeV.getRecord());
elementIdCache.put(reifiedEdgeTermId, termV.getRecord());
this.reifiedEdgeTermIdNodeIdMap.put(reifiedEdgeTermId, nodeId);
return nodeId;
}
public Long getReifiedEdgeTermIdFromEdgeId(Long edgeId) throws ExecutionException {
Long reifiedEdgeTermId = this.edgeIdReifiedEdgeTermIdMap.get(edgeId);
if (reifiedEdgeTermId != null) return reifiedEdgeTermId;
// create new term
reifiedEdgeTermId = this.database.getNextId();
ODocument eTermdoc = new ODocument (NdexClasses.ReifiedEdgeTerm);
eTermdoc = eTermdoc.field(NdexClasses.Element_ID, reifiedEdgeTermId)
.save();
OrientVertex etV = graph.getVertex(eTermdoc);
ODocument edgeDoc = elementIdCache.get(edgeId);
OrientVertex edgeV = graph.getVertex(edgeDoc);
etV.addEdge(NdexClasses.ReifedEdge_E_edge, edgeV);
networkVertex.addEdge(NdexClasses.Network_E_ReifedEdgeTerms,
etV);
elementIdCache.put(reifiedEdgeTermId, etV.getRecord());
elementIdCache.put(edgeId,edgeV.getRecord());
this.edgeIdReifiedEdgeTermIdMap.put(edgeId, reifiedEdgeTermId);
return reifiedEdgeTermId;
}
public Long getSupportId(String literal, Long citationId) throws ExecutionException {
RawSupport r = new RawSupport(literal, citationId);
Long supportId = this.rawSupportMap.get(r);
if ( supportId != null ) return supportId;
// persist the support object in db.
supportId = createSupport(literal, citationId);
this.rawSupportMap.put(r, supportId);
return supportId;
}
public void persistNetwork() {
try {
network.setIsComplete(true);
getNetworkDoc().field(NdexClasses.Network_P_isComplete,true)
.field(NdexClasses.Network_P_edgeCount, network.getEdgeCount())
.field(NdexClasses.Network_P_nodeCount, network.getNodeCount())
.save();
System.out.println("The new network " + network.getName()
+ " is complete");
} catch (Exception e) {
System.out.println("unexpected error in persist network...");
e.printStackTrace();
} finally {
this.localConnection.commit();
localConnection.close();
this.database.close();
System.out
.println("Connection to orientdb database has been closed");
}
}
public void setNetworkProperties(Collection<NdexPropertyValuePair> properties,
Collection<SimplePropertyValuePair> presentationProperties) throws NdexException, ExecutionException {
addPropertiesToVertex ( networkVertex, properties, presentationProperties);
}
public void setNetworkProvenance(ProvenanceEntity e) throws JsonProcessingException {
ObjectMapper mapper = new ObjectMapper();
String provenanceString = mapper.writeValueAsString(e);
// store provenance string
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_provenance, provenanceString)
.save();
}
public void setNetworkTitleAndDescription(String title, String description) {
if ( description != null ) {
this.network.setDescription(description);
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_desc, description).save();
}
if ( title != null) {
this.network.setName(title);
this.networkDoc = this.networkDoc.field(NdexClasses.Network_P_name, title).save();
}
}
public void setNodeName(long nodeId, String name) throws ExecutionException {
ODocument nodeDoc = elementIdCache.get(nodeId);
nodeDoc = nodeDoc.field(NdexClasses.Node_P_name, name).save();
elementIdCache.put(nodeId, nodeDoc);
}
public void setElementProperty(Long elementId, String key, String value) throws ExecutionException, NdexException {
ODocument elementDoc = this.elementIdCache.get(elementId);
OrientVertex v = graph.getVertex(elementDoc);
v = this.addPropertyToVertex(v, new NdexPropertyValuePair(key,value));
elementDoc = v.getRecord();
this.elementIdCache.put(elementId, elementDoc);
}
public void setElementPresentationProperty(Long elementId, String key, String value) throws ExecutionException {
ODocument elementDoc = this.elementIdCache.get(elementId);
OrientVertex v = graph.getVertex(elementDoc);
ODocument pDoc = this.createSimplePropertyDoc(key,value);
pDoc = pDoc.save();
OrientVertex pV = graph.getVertex(pDoc);
v.addEdge(NdexClasses.E_ndexPresentationProps, pV);
elementDoc = v.getRecord();
this.elementIdCache.put(elementId, elementDoc);
}
public void setNodeProperties(Long nodeId, Collection<NdexPropertyValuePair> properties,
Collection<SimplePropertyValuePair> presentationProperties) throws ExecutionException, NdexException {
ODocument nodeDoc = this.elementIdCache.get(nodeId);
OrientVertex v = graph.getVertex(nodeDoc);
addPropertiesToVertex ( v, properties, presentationProperties);
this.elementIdCache.put(nodeId, v.getRecord());
}
/**
* create a represent edge from a node to a term.
* @param nodeId
* @param TermId
* @throws ExecutionException
*/
public void setNodeRepresentTerm(long nodeId, long termId) throws ExecutionException {
ODocument nodeDoc = this.elementIdCache.get(nodeId);
OrientVertex nodeV = graph.getVertex(nodeDoc);
ODocument termDoc = this.elementIdCache.get(termId);
OrientVertex termV = graph.getVertex(termDoc);
nodeV.addEdge(NdexClasses.Node_E_represents, termV);
this.elementIdCache.put(nodeId, nodeV.getRecord());
this.elementIdCache.put(termId, termV.getRecord());
}
public void updateNetworkSummary() throws ObjectNotFoundException, NdexException, ExecutionException {
networkDoc = Helper.updateNetworkProfile(networkDoc, network);
addPropertiesToVertex(this.networkVertex,
network.getProperties(),network.getPresentationProperties());
networkDoc = this.networkVertex.getRecord();
}
}
| clean up partial network when loading failed. | src/main/java/org/ndexbio/common/persistence/orientdb/NdexPersistenceService.java | clean up partial network when loading failed. | <ide><path>rc/main/java/org/ndexbio/common/persistence/orientdb/NdexPersistenceService.java
<ide>
<ide> // make sure everything relate to the network is deleted.
<ide> //localConnection.begin();
<del> deleteNetwork();
<add> logger.info("Deleting partial network "+ network.getExternalId().toString() + " in order to rollback in response to error");
<add> this.networkDAO.deleteNetwork(network.getExternalId().toString());
<ide> //localConnection.commit();
<ide> graph.commit();
<del> System.out.println("Deleting network in order to rollback in response to error");
<add> logger.info("Partial network "+ network.getExternalId().toString() + " is deleted.");
<ide> }
<ide>
<ide> // alias is treated as a baseTerm
<ide> /**
<ide> * performing delete the current network but not commiting it.
<ide> */
<del> public void deleteNetwork() {
<add>/* public void deleteNetwork() {
<ide> // TODO Implement deletion of network
<ide> System.out
<ide> .println("deleteNetwork called. Not yet implemented");
<ide>
<ide>
<del> }
<add> } */
<ide>
<ide>
<ide> /** |
|
JavaScript | mit | fd9ec1cb0cb5b043d231f3342c782e05c3b1bb71 | 0 | mhoffman/CatAppBrowser,mhoffman/CatAppBrowser | /*
*
* Upload
*
*/
import _ from 'lodash';
import React from 'react';
import PropTypes from 'prop-types';
import Script from 'react-load-script';
import { connect } from 'react-redux';
import FileDrop from 'react-file-drop';
import GeometryCanvasWithOptions from 'components/GeometryCanvasWithOptions';
import { withStyles } from 'material-ui/styles';
import Paper from 'material-ui/Paper';
import Popover from 'material-ui/Popover';
import Button from 'material-ui/Button';
import TextField from 'material-ui/TextField';
import Grid from 'material-ui/Grid';
import {
MdRefresh,
MdThumbUp,
MdChevronRight,
MdPublic,
MdDelete,
MdWarning,
} from 'react-icons/lib/md';
import Modal from 'material-ui/Modal';
import { CircularProgress } from 'material-ui/Progress';
import IFrame from 'react-iframe';
import ReactGA from 'react-ga';
import { createStructuredSelector } from 'reselect';
import axios from 'axios';
/* import { apiRoot, uploadGraphqlRoot } from 'utils/constants';*/
/* import { apiRoot } from 'utils/constants';*/
import * as snackbarActions from 'containers/AppSnackBar/actions';
import PublicationView from 'components/PublicationView';
import { prettyPrintReference } from 'utils/functions';
import { apiRoot } from 'utils/constants';
import { styles } from './styles';
import makeSelectUpload from './selectors';
/* const apiRoot = 'https://catappdatabase2-pr-63.herokuapp.com';*/
/* const apiRoot = 'http://localhost:5000';*/
const backendRoot = `${apiRoot}/apps/upload`;
const url = `${backendRoot}/upload_dataset/`;
const userInfoUrl = `${backendRoot}/user_info`;
const logoutUrl = `${backendRoot}/logout`;
const releaseUrl = `${backendRoot}/release`;
const endorseUrl = `${backendRoot}/endorse`;
const deleteUrl = `${backendRoot}/delete`;
/* const fileDropUrl = `${apiRoot}/apps/catKitDemo/convert_atoms`;*/
const fileDropUrl = `${apiRoot}/apps/bulkEnumerator/get_wyckoff_from_structure`;
// TODO: COMMENT OUT IN PRODUCTION
/* const uploadGraphqlRoot = 'http://localhost:5000/apps/upload/graphql';*/
const uploadGraphqlRoot = `${apiRoot}/apps/upload/graphql`;
const showUploadForm = false;
export class Upload extends React.Component { // eslint-disable-line react/prefer-stateless-function
constructor(props) {
super(props);
this.state = {
uploadError: '',
loginModalOpen: false,
loginUrl: '',
userInfo: {},
datasets: [],
pubId: '',
showHelp: true,
pubEntries: {},
popoverAnchorElement: null,
deleting: false,
molecules: [],
reactions: [{}],
};
this.logout = this.logout.bind(this);
this.fetchUserInfo = this.fetchUserInfo.bind(this);
this.getDatasets = this.getDatasets.bind(this);
this.handleFileDrop = this.handleFileDrop.bind(this);
this.handleSocialLogin = this.handleSocialLogin.bind(this);
this.handleSocialLoginFailure = this.handleSocialLoginFailure.bind(this);
this.handleRelease = this.handleRelease.bind(this);
this.handleEndorse = this.handleEndorse.bind(this);
this.handleDelete = this.handleDelete.bind(this);
this.handlePopoverOpen = this.handlePopoverOpen.bind(this);
this.handlePopoverClose = this.handlePopoverClose.bind(this);
this.handleDrop = this.handleDrop.bind(this);
this.login = this.login.bind(this);
this.removeMolecule = this.removeMolecule.bind(this);
this.setDataset = this.setDataset.bind(this);
this.toggleHelp = this.toggleHelp.bind(this);
this.windowLogin = this.windowLogin.bind(this);
this.moleculeInput = null;
this.reactantInput = null;
this.productInput = null;
}
componentDidMount() {
if (_.get(this.props, 'location.query.login') === 'success') {
this.fetchUserInfo();
this.getDatasets();
}
}
componentWillReceiveProps(nextProps) {
if (_.get(nextProps, 'location.query.login') === 'success') {
this.fetchUserInfo();
this.getDatasets();
}
}
getDatasets() {
const datasetQuery = `{publications { totalCount edges { node {
title authors doi pubId journal volume pages year
} } }}`;
axios.default.withCredentials = true;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: datasetQuery,
},
withCredentials: true,
}).then((response) => {
this.setState({
datasets: response.data.data.publications.edges.map(
(edge) => edge.node),
});
});
const pubEntryQuery = `{reactions(username:"~", distinct: true) {
edges { node { pubId username } } }}`;
axios({
url: uploadGraphqlRoot,
method: 'POST',
data: {
query: pubEntryQuery,
},
withCredentials: true,
}).then((response) => {
const pubEntries = _.groupBy(response.data.data.reactions.edges.map((x) => x.node),
'pubId');
this.setState({
pubEntries,
});
});
}
setDataset(dataset) {
this.setState({
pubId: dataset.pubId,
});
}
removeMolecule(i) {
this.setState({
molecules: this.state.molecules.filter((elem, x) => x !== i),
});
}
handleDrop(field) {
return (files, event) => {
/* console.log(event.toElement.innerText)*/
const formData = new FormData();
formData.append('file', files[0]);
formData.append('field', field);
formData.append('event', JSON.stringify(event));
axios.post(fileDropUrl, formData,
{ headers:
{
'content-type': 'multipart/form-data',
} }).then((response) => {
/* console.log(response)*/
this.setState({
loading: false,
molecules: _.concat(
this.state.molecules,
[response.data.cif]
),
});
});
};
}
handlePopoverOpen(event) {
this.setState({
popoverAnchorElement: event.currentTarget,
});
}
handlePopoverClose() {
this.setState({
popoverAnchorElement: null,
});
}
handleEndorse(dataset) {
ReactGA.event({
category: 'Endorse',
action: 'Endorse a Dataset',
label: dataset.pubId,
});
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(endorseUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
});
});
}
handleRelease(dataset) {
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(releaseUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
});
});
}
handleDelete(dataset) {
// TODO: Implement confirmation dialogue
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
this.setState({
deleting: true,
});
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(deleteUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
this.getDatasets();
this.setState({
deleting: false,
});
});
});
}
handleSocialLogin() {
}
handleSocialLoginFailure() {
}
fetchUserInfo() {
axios.get(userInfoUrl, {
data: {},
withCredentials: true,
}).then((response) => {
this.setState({
userInfo: response.data,
});
});
}
login() {
const uploadUrl = `${apiRoot}/apps/upload/submit`;
axios.get(uploadUrl).then((response) => {
this.setState({
loginModalOpen: true,
loginUrl: response.data.location,
});
});
}
logout() {
axios(logoutUrl, {
method: 'post',
data: {},
withCredentials: true,
}).then(() => {
this.setState({
userInfo: {},
datasets: [],
pubId: '',
});
});
}
windowLogin(provider = 'slack') {
const uploadUrl = `${apiRoot}/apps/upload/`;
/* console.log("WINDOW LOGIN")*/
/* console.log(uploadUrl)*/
axios(uploadUrl, {
method: 'get',
params: {
provider,
},
mode: 'no-cors',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
},
withCredentials: true,
credentials: 'same-origin',
}).then((response) => {
/* console.log(response)*/
window.open(response.data.location);
window.focus();
window.close();
});
}
handleClose() {
this.setState({
loginModalOpen: false,
});
}
handleFileDrop(files) {
const formData = new FormData();
formData.append('file', files[0]);
axios.post(url, formData, { headers: { 'content-type': 'multipart/form-data' } }).then((response) => response);
}
toggleHelp() {
this.setState({
showHelp: !this.state.showHelp,
});
}
render() {
return (
<div>
<Script url="https://code.jquery.com/jquery-3.2.1.min.js" />
<Script url="/static/ChemDoodleWeb.js" />
<Modal
aria-labelledby="simple-modal-title"
aria-describedby="simple-modal-description"
open={this.state.loginModalOpen}
onClose={() => { this.handleClose(); }}
style={{
backgroundColor: 'white',
}}
>
<IFrame
url={this.state.loginUrl}
width="95vw"
height="95vh"
position="relative"
top="50px"
display="initial"
/>
</Modal>
<Grid container direction="row" justify="space-between">
<Grid item>
<h2>Upload Datasets [beta]
{!_.isEmpty(this.state.userInfo) ?
`\u00A0\u00A0(${this.state.userInfo.email})`
: null} </h2>
</Grid>
<Grid item>
{_.isEmpty(this.state.userInfo) ? null :
<img
src={this.state.userInfo.picture}
height="72"
width="72"
alt="Portrait"
/>
}
</Grid>
</Grid>
<Paper className={this.props.classes.paper}>
{!_.isEmpty(this.state.userInfo) ? null :
<Grid container direction="row" justify="flex-end">
<Grid item>
<Button
raised
onClick={() => { this.toggleHelp(); }}
>
{this.state.showHelp ? 'Hide Help' : 'Show Help' }
</Button>
</Grid>
<Grid item>
<Button
raised
color="primary"
onClick={(event) => {
this.handlePopoverOpen(event);
}}
>
Login
</Button>
<Popover
open={Boolean(this.state.popoverAnchorElement)}
anchorEl={this.state.popoverAnchorElement}
onClose={this.handlePopoverClose}
origin={{
vertical: 'bottom',
horizontal: 'left',
}}
transformOrigin={{
vertical: 'bottom',
horizontal: 'right',
}}
><div
className={this.props.classes.loginPopover}
>
<Button
onClick={() => this.windowLogin('google')}
> Google </Button>
<Button
onClick={() => this.windowLogin('slack')}
> Slack </Button>
</div>
</Popover>
</Grid>
</Grid>
}
{_.isEmpty(this.state.userInfo) ? null :
<Grid container direction="row" justify="flex-end">
<Grid item>
<Button
raised
onClick={() => { this.toggleHelp(); }}
>
{this.state.showHelp ? 'Hide Help' : 'Show Help' }
</Button>
</Grid>
<Grid item>
<Button
onClick={() => this.logout()}
>
Logout
</Button>
</Grid>
</Grid>
}
{_.isEmpty(this.state.uploadError) ? null :
<div className={this.props.classes.error}>{this.state.uploadError}</div>
}
</Paper>
{!this.state.showHelp ? null :
<Paper className={this.props.classes.paper}>
<div>
<Paper className={this.props.classes.paper}>
<MdWarning /> Disclaimer: data submitted to the preview section can be seen by all registered users
of catalysis-hub.org.
</Paper>
<h3>Why should I submit calculations of reaction energies?</h3>
<ul>
<li>Create an easy-to-use interactive supplementary information for your <a href="/publications">publication</a> with its own URL.</li>
<li>Get your own <a href="/profile">profile page</a></li>
<li>Inspect your data with a growing number of web <a href="/appsIndex">apps</a> (activity maps, scaling relations)</li>
<li>Accelerate transfer of your theoretical insight to experimentalists in the field.</li>
<li>Support ongoing machine-learning efforts in the community by providing first-principles based training data.</li>
</ul>
<h3>How to Submit Reactions from Terminal</h3>
<div>
For SUNCAT Users: check <a target="_blank" href="http://docs.catalysis-hub.org/en/latest/tutorials/upload.html#suncat-group-members">docs.catalysis-hub.org</a> for info how to upload data.
</div>
<div>
For general audience, follow the steps below in the near future.
</div>
<ol>
<li>Install catkit: <pre>pip install git+https://github.com/SUNCAT-Center/CatKit.git#egg=catkit</pre></li>
<li>Organize converged calculations, run <pre>cathub organize {'<foldername>'}</pre></li>
<li>Turn organized folder into sqlite database, run <pre>cathub folder2db --userhandle {this.state.userInfo.email} {'<foldername>'}.organized</pre></li>
<li>Upload database, run <pre>cathub db2server {'<NameTitlewordYear>'}.db</pre></li>
<li>Click on {'"Fetch Data Sets"'} to see your uploaded dataset.
</li>
</ol>
</div>
</Paper>
}
{!showUploadForm ? null :
<Paper className={this.props.classes.paper}>
<h1>Manual Upload</h1>
<TextField
className={this.props.classes.textField}
id="title"
label="Title *"
InputLabelProps={{
shrink: true,
}}
placeholder="Highly Efficient Catalyst from Non-Toxic Earth Abundant Materials for XY"
fullWidth
margin="normal"
/>
<TextField
className={this.props.classes.textField}
id="authors"
label="Authors *"
InputLabelProps={{
shrink: true,
}}
placeholder="A Einstein"
fullWidth
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Volume"
InputLabelProps={{
shrink: true,
}}
placeholder="8"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Number"
InputLabelProps={{
shrink: true,
}}
placeholder="13"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Pages"
InputLabelProps={{
shrink: true,
}}
placeholder="2140-2267"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Year *"
InputLabelProps={{
shrink: true,
}}
placeholder="2018"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Publisher"
InputLabelProps={{
shrink: true,
}}
placeholder="Wiley"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DOI"
InputLabelProps={{
shrink: true,
}}
placeholder="10.1002/cssc.201500322"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DFT Code"
InputLabelProps={{
shrink: true,
}}
placeholder="Quantum Espresso"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DFT Functional(s)"
InputLabelProps={{
shrink: true,
}}
placeholder="BEEF-vdW"
margin="normal"
/>
<h2>Gas Phase Molecules</h2>
<div>
<input
accept="text/*"
id="molecule-upload-button"
ref={(el) => { this.moleculeInput = el; }}
type="file"
className={this.props.classes.input}
multiple
/>
<label
htmlFor="molecule-upload-button"
>
<Button
raised
type="file"
className={this.props.classes.button}
component="span"
>
+ Molecule
{/* frame={this.moleculeInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
</div>
<div>
<Grid container direction="row" justify="flex-start">
{this.state.molecules.map((molecule, i) => (
<Grid
item
key={`ml_${i}`}
>
<Grid container direction="column" justify="flex-start">
<Grid item>
<GeometryCanvasWithOptions
key={`mc_${i}`}
cifdata={molecule}
unique_id={`molecule_${i}`}
id={`molecule_${i}`}
height={400}
width={400}
showButtons={false}
x={1} y={1} z={2}
/>
</Grid>
<Grid>
<Grid container direction="row" justify="flex-start">
<Grid item>
<Button
onClick={() => { this.removeMolecule(i); }}
raised
>
<MdDelete /> Remove
</Button>
</Grid>
</Grid>
</Grid>
</Grid>
</Grid>
))}
</Grid>
</div>
<h2>Reactions</h2>
<Grid container direction="column" justify="flex-start">
{this.state.reactions.map((reaction, i) => (
<Grid item key={`reaction_${i}`}>
<h3>Reaction {i + 1}</h3>
</Grid>
))}
</Grid>
<div>
<input
accept="text/*"
ref={(el) => { this.reactantInput = el; }}
id="reactants-upload-button"
type="file"
className={this.props.classes.input}
multiple
/>
<label
htmlFor="reactants-upload-button"
>
<Button
raised
component="span"
className={this.props.classes.button}
>
+ Reactant
{/* frame={this.reactantInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
<input
accept="text/*"
id="products-upload-button"
type="file"
className={this.props.classes.input}
ref={(el) => { this.productInput = el; }}
multiple
/>
<label
htmlFor="products-upload-button"
>
<Button
raised
component="span"
className={this.props.classes.button}
>
+ Product
{/* frame={this.productInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
</div>
</Paper>
}
{_.isEmpty(this.state.userInfo) ? null :
<Paper className={this.props.classes.paper}>
<Grid container justify="space-between" direction="row">
<Grid item>
<h1>Data Sets</h1>
</Grid>
<Grid item>
<Button
raised
color="primary"
onClick={() => { this.getDatasets(); }}
>
<MdRefresh /> Fetch Data Sets
</Button>
</Grid>
</Grid>
{_.isEmpty(this.state.datasets) ? null :
this.state.datasets.map((dataset, i) => (
<Paper key={`ds_${i}`} className={this.props.classes.paper}>
{prettyPrintReference(dataset)}
{(this.state.userInfo.email !== _.get(this.state.pubEntries,
`${dataset.pubId}.0.username`, '')) ?
<div>
<Button
raised
onClick={() => {
this.handleEndorse(dataset);
}}
>
Endorse {'\u00A0\u00A0'} <MdThumbUp />
</Button> {'\u00A0\u00A0'}
</div>
: <div>
<Button
raised
onClick={() => {
this.handleRelease(dataset);
}}
>
Release {'\u00A0\u00A0'} <MdPublic />
</Button>
{'\u00A0\u00A0\u00A0'}
<Button
raised
onClick={() => {
this.handleDelete(dataset);
}}
>
Delete {'\u00A0\u00A0'} <MdDelete />
{ this.state.deleting ? <CircularProgress size={16} /> : null }
</Button>
{'\u00A0\u00A0\u00A0'}
<Button
raised
onClick={() => { this.setDataset(dataset); }}
> Details <MdChevronRight /> </Button>
</div>
}
</Paper>
))
}
</Paper>
}
{_.isEmpty(this.state.pubId) ? null :
<Paper>
<PublicationView
preview
pubId={this.state.pubId}
graphqlRoot={uploadGraphqlRoot}
privilegedAccess
/>
</Paper>
}
</div>
);
}
}
Upload.propTypes = {
classes: PropTypes.object,
openSnackbar: PropTypes.func,
};
const mapStateToProps = createStructuredSelector({
Upload: makeSelectUpload(),
});
const mapDispatchToProps = (dispatch) => ({
openSnackbar: (message) => {
dispatch(snackbarActions.open(message));
},
});
export default connect(mapStateToProps, mapDispatchToProps)(withStyles(styles, { withTheme: true })(Upload));
| app/containers/Upload/index.js | /*
*
* Upload
*
*/
import _ from 'lodash';
import React from 'react';
import PropTypes from 'prop-types';
import Script from 'react-load-script';
import { connect } from 'react-redux';
import FileDrop from 'react-file-drop';
import GeometryCanvasWithOptions from 'components/GeometryCanvasWithOptions';
import { withStyles } from 'material-ui/styles';
import Paper from 'material-ui/Paper';
import Popover from 'material-ui/Popover';
import Button from 'material-ui/Button';
import TextField from 'material-ui/TextField';
import Grid from 'material-ui/Grid';
import {
MdRefresh,
MdThumbUp,
MdChevronRight,
MdPublic,
MdDelete,
MdWarning,
} from 'react-icons/lib/md';
import Modal from 'material-ui/Modal';
import { CircularProgress } from 'material-ui/Progress';
import IFrame from 'react-iframe';
import ReactGA from 'react-ga';
import { createStructuredSelector } from 'reselect';
import axios from 'axios';
/* import { apiRoot, uploadGraphqlRoot } from 'utils/constants';*/
/* import { apiRoot } from 'utils/constants';*/
import * as snackbarActions from 'containers/AppSnackBar/actions';
import PublicationView from 'components/PublicationView';
import { prettyPrintReference } from 'utils/functions';
import { apiRoot } from 'utils/constants';
import { styles } from './styles';
import makeSelectUpload from './selectors';
/* const apiRoot = 'https://catappdatabase2-pr-63.herokuapp.com';*/
/* const apiRoot = 'http://localhost:5000';*/
const backendRoot = `${apiRoot}/apps/upload`;
const url = `${backendRoot}/upload_dataset/`;
const userInfoUrl = `${backendRoot}/user_info`;
const logoutUrl = `${backendRoot}/logout`;
const releaseUrl = `${backendRoot}/release`;
const endorseUrl = `${backendRoot}/endorse`;
const deleteUrl = `${backendRoot}/delete`;
/* const fileDropUrl = `${apiRoot}/apps/catKitDemo/convert_atoms`;*/
const fileDropUrl = `${apiRoot}/apps/bulkEnumerator/get_wyckoff_from_structure`;
// TODO: COMMENT OUT IN PRODUCTION
/* const uploadGraphqlRoot = 'http://localhost:5000/apps/upload/graphql';*/
const uploadGraphqlRoot = `${apiRoot}/apps/upload/graphql`;
const showUploadForm = false;
export class Upload extends React.Component { // eslint-disable-line react/prefer-stateless-function
constructor(props) {
super(props);
this.state = {
uploadError: '',
loginModalOpen: false,
loginUrl: '',
userInfo: {},
datasets: [],
pubId: '',
showHelp: true,
pubEntries: {},
popoverAnchorElement: null,
deleting: false,
molecules: [],
reactions: [{}],
};
this.logout = this.logout.bind(this);
this.fetchUserInfo = this.fetchUserInfo.bind(this);
this.getDatasets = this.getDatasets.bind(this);
this.handleFileDrop = this.handleFileDrop.bind(this);
this.handleSocialLogin = this.handleSocialLogin.bind(this);
this.handleSocialLoginFailure = this.handleSocialLoginFailure.bind(this);
this.handleRelease = this.handleRelease.bind(this);
this.handleEndorse = this.handleEndorse.bind(this);
this.handleDelete = this.handleDelete.bind(this);
this.handlePopoverOpen = this.handlePopoverOpen.bind(this);
this.handlePopoverClose = this.handlePopoverClose.bind(this);
this.handleDrop = this.handleDrop.bind(this);
this.login = this.login.bind(this);
this.removeMolecule = this.removeMolecule.bind(this);
this.setDataset = this.setDataset.bind(this);
this.toggleHelp = this.toggleHelp.bind(this);
this.windowLogin = this.windowLogin.bind(this);
this.moleculeInput = null;
this.reactantInput = null;
this.productInput = null;
}
componentDidMount() {
if (_.get(this.props, 'location.query.login') === 'success') {
this.fetchUserInfo();
this.getDatasets();
}
}
componentWillReceiveProps(nextProps) {
if (_.get(nextProps, 'location.query.login') === 'success') {
this.fetchUserInfo();
this.getDatasets();
}
}
getDatasets() {
const datasetQuery = `{publications { totalCount edges { node {
title authors doi pubId journal volume pages year
} } }}`;
axios.default.withCredentials = true;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: datasetQuery,
},
withCredentials: true,
}).then((response) => {
this.setState({
datasets: response.data.data.publications.edges.map(
(edge) => edge.node),
});
});
const pubEntryQuery = `{reactions(username:"~", distinct: true) {
edges { node { pubId username } } }}`;
axios({
url: uploadGraphqlRoot,
method: 'POST',
data: {
query: pubEntryQuery,
},
withCredentials: true,
}).then((response) => {
const pubEntries = _.groupBy(response.data.data.reactions.edges.map((x) => x.node),
'pubId');
this.setState({
pubEntries,
});
});
}
setDataset(dataset) {
this.setState({
pubId: dataset.pubId,
});
}
removeMolecule(i) {
this.setState({
molecules: this.state.molecules.filter((elem, x) => x !== i),
});
}
handleDrop(field) {
return (files, event) => {
/* console.log(event.toElement.innerText)*/
const formData = new FormData();
formData.append('file', files[0]);
formData.append('field', field);
formData.append('event', JSON.stringify(event));
axios.post(fileDropUrl, formData,
{ headers:
{
'content-type': 'multipart/form-data',
} }).then((response) => {
/* console.log(response)*/
this.setState({
loading: false,
molecules: _.concat(
this.state.molecules,
[response.data.cif]
),
});
});
};
}
handlePopoverOpen(event) {
this.setState({
popoverAnchorElement: event.currentTarget,
});
}
handlePopoverClose() {
this.setState({
popoverAnchorElement: null,
});
}
handleEndorse(dataset) {
ReactGA.event({
category: 'Endorse',
action: 'Endorse a Dataset',
label: dataset.pubId,
});
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(endorseUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
});
});
}
handleRelease(dataset) {
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(releaseUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
});
});
}
handleDelete(dataset) {
// TODO: Implement confirmation dialogue
const correspondentQuery = `{reactions(first: 1, pubId: "${dataset.pubId}") {
edges {
node {
id
username
}
}
}}`;
this.setState({
deleting: true,
});
axios.post(uploadGraphqlRoot, {}, {
method: 'POST',
data: {
query: correspondentQuery,
},
withCredentials: true,
}).then((response) => {
axios.post(deleteUrl, {
dataset,
userInfo: this.state.userInfo,
corresponding_email: response.data.data.reactions.edges[0].node.username,
}).then((messageResponse) => {
this.props.openSnackbar(messageResponse.data.message);
this.getDatasets();
this.setState({
deleting: false,
});
});
});
}
handleSocialLogin() {
}
handleSocialLoginFailure() {
}
fetchUserInfo() {
axios.get(userInfoUrl, {
data: {},
withCredentials: true,
}).then((response) => {
this.setState({
userInfo: response.data,
});
});
}
login() {
const uploadUrl = `${apiRoot}/apps/upload/submit`;
axios.get(uploadUrl).then((response) => {
this.setState({
loginModalOpen: true,
loginUrl: response.data.location,
});
});
}
logout() {
axios(logoutUrl, {
method: 'post',
data: {},
withCredentials: true,
}).then(() => {
this.setState({
userInfo: {},
datasets: [],
pubId: '',
});
});
}
windowLogin(provider = 'slack') {
const uploadUrl = `${apiRoot}/apps/upload/`;
/* console.log("WINDOW LOGIN")*/
/* console.log(uploadUrl)*/
axios(uploadUrl, {
method: 'get',
params: {
provider,
},
mode: 'no-cors',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
},
withCredentials: true,
credentials: 'same-origin',
}).then((response) => {
/* console.log(response)*/
window.open(response.data.location);
window.focus();
window.close();
});
}
handleClose() {
this.setState({
loginModalOpen: false,
});
}
handleFileDrop(files) {
const formData = new FormData();
formData.append('file', files[0]);
axios.post(url, formData, { headers: { 'content-type': 'multipart/form-data' } }).then((response) => response);
}
toggleHelp() {
this.setState({
showHelp: !this.state.showHelp,
});
}
render() {
return (
<div>
<Script url="https://code.jquery.com/jquery-3.2.1.min.js" />
<Script url="/static/ChemDoodleWeb.js" />
<Modal
aria-labelledby="simple-modal-title"
aria-describedby="simple-modal-description"
open={this.state.loginModalOpen}
onClose={() => { this.handleClose(); }}
style={{
backgroundColor: 'white',
}}
>
<IFrame
url={this.state.loginUrl}
width="95vw"
height="95vh"
position="relative"
top="50px"
display="initial"
/>
</Modal>
<Grid container direction="row" justify="space-between">
<Grid item>
<h2>Upload Datasets [beta]
{!_.isEmpty(this.state.userInfo) ?
`\u00A0\u00A0(${this.state.userInfo.email})`
: null} </h2>
</Grid>
<Grid item>
{_.isEmpty(this.state.userInfo) ? null :
<img
src={this.state.userInfo.picture}
height="72"
width="72"
alt="Portrait"
/>
}
</Grid>
</Grid>
<Paper className={this.props.classes.paper}>
{!_.isEmpty(this.state.userInfo) ? null :
<Grid container direction="row" justify="flex-end">
<Grid item>
<Button
raised
onClick={() => { this.toggleHelp(); }}
>
{this.state.showHelp ? 'Hide Help' : 'Show Help' }
</Button>
</Grid>
<Grid item>
<Button
raised
color="primary"
onClick={(event) => {
this.handlePopoverOpen(event);
}}
>
Login
</Button>
<Popover
open={Boolean(this.state.popoverAnchorElement)}
anchorEl={this.state.popoverAnchorElement}
onClose={this.handlePopoverClose}
origin={{
vertical: 'bottom',
horizontal: 'left',
}}
transformOrigin={{
vertical: 'bottom',
horizontal: 'right',
}}
><div
className={this.props.classes.loginPopover}
>
<Button
onClick={() => this.windowLogin('google')}
> Google </Button>
<Button
onClick={() => this.windowLogin('slack')}
> Slack </Button>
</div>
</Popover>
</Grid>
</Grid>
}
{_.isEmpty(this.state.userInfo) ? null :
<Grid container direction="row" justify="flex-end">
<Grid item>
<Button
raised
onClick={() => { this.toggleHelp(); }}
>
{this.state.showHelp ? 'Hide Help' : 'Show Help' }
</Button>
</Grid>
<Grid item>
<Button
onClick={() => this.logout()}
>
Logout
</Button>
</Grid>
</Grid>
}
{_.isEmpty(this.state.uploadError) ? null :
<div className={this.props.classes.error}>{this.state.uploadError}</div>
}
</Paper>
{!this.state.showHelp ? null :
<Paper className={this.props.classes.paper}>
<div>
<Paper className={this.props.classes.paper}>
<MdWarning /> Disclaimer: data submitted to the preview section can be seen by all registered users
of catalysis-hub.org.
</Paper>
<h3>Why should I submit calculations of reactions energies?</h3>
<ul>
<li>Create an easy-to-use interactive supplementary information for your <a href="/publications">publication</a> with its own URL.</li>
<li>Get your own <a href="/profile">profile page</a></li>
<li>Inspect your data with a growing number of web <a href="/appsIndex">apps</a> (activity maps, scaling relations)</li>
<li>Accelerate transfer of your theoretical insight to experimentalists in the field.</li>
<li>Support ongoing machine-learning efforts in the community by providing first-principles based training data.</li>
</ul>
<h3>How to Submit Reactions from Terminal</h3>
<div>
For SUNCAT Users: check <a target="_blank" href="http://docs.catalysis-hub.org/en/latest/tutorials/upload.html#suncat-group-members">docs.catalysis-hub.org</a> for info how to upload data.
</div>
<div>
For general audience, follow the steps below in the near future.
</div>
<ol>
<li>Install catkit: <pre>pip install git+https://github.com/SUNCAT-Center/CatKit.git#egg=catkit</pre></li>
<li>Organize converged calculations, run <pre>cathub organize {'<foldername>'}</pre></li>
<li>Turn organized folder into sqlite database, run <pre>cathub folder2db --userhandle {this.state.userInfo.email} {'<foldername>'}.organized</pre></li>
<li>Upload database, run <pre>cathub db2server {'<NameTitlewordYear>'}.db</pre></li>
<li>Click on {'"Fetch Data Sets"'} to see your uploaded dataset.
</li>
</ol>
</div>
</Paper>
}
{!showUploadForm ? null :
<Paper className={this.props.classes.paper}>
<h1>Manual Upload</h1>
<TextField
className={this.props.classes.textField}
id="title"
label="Title *"
InputLabelProps={{
shrink: true,
}}
placeholder="Highly Efficient Catalyst from Non-Toxic Earth Abundant Materials for XY"
fullWidth
margin="normal"
/>
<TextField
className={this.props.classes.textField}
id="authors"
label="Authors *"
InputLabelProps={{
shrink: true,
}}
placeholder="A Einstein"
fullWidth
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Volume"
InputLabelProps={{
shrink: true,
}}
placeholder="8"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Number"
InputLabelProps={{
shrink: true,
}}
placeholder="13"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Pages"
InputLabelProps={{
shrink: true,
}}
placeholder="2140-2267"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Year *"
InputLabelProps={{
shrink: true,
}}
placeholder="2018"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="Publisher"
InputLabelProps={{
shrink: true,
}}
placeholder="Wiley"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DOI"
InputLabelProps={{
shrink: true,
}}
placeholder="10.1002/cssc.201500322"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DFT Code"
InputLabelProps={{
shrink: true,
}}
placeholder="Quantum Espresso"
margin="normal"
/>
<TextField
className={this.props.classes.textField}
label="DFT Functional(s)"
InputLabelProps={{
shrink: true,
}}
placeholder="BEEF-vdW"
margin="normal"
/>
<h2>Gas Phase Molecules</h2>
<div>
<input
accept="text/*"
id="molecule-upload-button"
ref={(el) => { this.moleculeInput = el; }}
type="file"
className={this.props.classes.input}
multiple
/>
<label
htmlFor="molecule-upload-button"
>
<Button
raised
type="file"
className={this.props.classes.button}
component="span"
>
+ Molecule
{/* frame={this.moleculeInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
</div>
<div>
<Grid container direction="row" justify="flex-start">
{this.state.molecules.map((molecule, i) => (
<Grid
item
key={`ml_${i}`}
>
<Grid container direction="column" justify="flex-start">
<Grid item>
<GeometryCanvasWithOptions
key={`mc_${i}`}
cifdata={molecule}
unique_id={`molecule_${i}`}
id={`molecule_${i}`}
height={400}
width={400}
showButtons={false}
x={1} y={1} z={2}
/>
</Grid>
<Grid>
<Grid container direction="row" justify="flex-start">
<Grid item>
<Button
onClick={() => { this.removeMolecule(i); }}
raised
>
<MdDelete /> Remove
</Button>
</Grid>
</Grid>
</Grid>
</Grid>
</Grid>
))}
</Grid>
</div>
<h2>Reactions</h2>
<Grid container direction="column" justify="flex-start">
{this.state.reactions.map((reaction, i) => (
<Grid item key={`reaction_${i}`}>
<h3>Reaction {i + 1}</h3>
</Grid>
))}
</Grid>
<div>
<input
accept="text/*"
ref={(el) => { this.reactantInput = el; }}
id="reactants-upload-button"
type="file"
className={this.props.classes.input}
multiple
/>
<label
htmlFor="reactants-upload-button"
>
<Button
raised
component="span"
className={this.props.classes.button}
>
+ Reactant
{/* frame={this.reactantInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
<input
accept="text/*"
id="products-upload-button"
type="file"
className={this.props.classes.input}
ref={(el) => { this.productInput = el; }}
multiple
/>
<label
htmlFor="products-upload-button"
>
<Button
raised
component="span"
className={this.props.classes.button}
>
+ Product
{/* frame={this.productInput}*/}
<FileDrop
onDrop={this.handleDrop('molecule')}
dropEffect="copy"
>
(Drop)
</FileDrop>
</Button>
</label>
</div>
</Paper>
}
{_.isEmpty(this.state.userInfo) ? null :
<Paper className={this.props.classes.paper}>
<Grid container justify="space-between" direction="row">
<Grid item>
<h1>Data Sets</h1>
</Grid>
<Grid item>
<Button
raised
color="primary"
onClick={() => { this.getDatasets(); }}
>
<MdRefresh /> Fetch Data Sets
</Button>
</Grid>
</Grid>
{_.isEmpty(this.state.datasets) ? null :
this.state.datasets.map((dataset, i) => (
<Paper key={`ds_${i}`} className={this.props.classes.paper}>
{prettyPrintReference(dataset)}
{(this.state.userInfo.email !== _.get(this.state.pubEntries,
`${dataset.pubId}.0.username`, '')) ?
<div>
<Button
raised
onClick={() => {
this.handleEndorse(dataset);
}}
>
Endorse {'\u00A0\u00A0'} <MdThumbUp />
</Button> {'\u00A0\u00A0'}
</div>
: <div>
<Button
raised
onClick={() => {
this.handleRelease(dataset);
}}
>
Release {'\u00A0\u00A0'} <MdPublic />
</Button>
{'\u00A0\u00A0\u00A0'}
<Button
raised
onClick={() => {
this.handleDelete(dataset);
}}
>
Delete {'\u00A0\u00A0'} <MdDelete />
{ this.state.deleting ? <CircularProgress size={16} /> : null }
</Button>
{'\u00A0\u00A0\u00A0'}
<Button
raised
onClick={() => { this.setDataset(dataset); }}
> Details <MdChevronRight /> </Button>
</div>
}
</Paper>
))
}
</Paper>
}
{_.isEmpty(this.state.pubId) ? null :
<Paper>
<PublicationView
preview
pubId={this.state.pubId}
graphqlRoot={uploadGraphqlRoot}
privilegedAccess
/>
</Paper>
}
</div>
);
}
}
Upload.propTypes = {
classes: PropTypes.object,
openSnackbar: PropTypes.func,
};
const mapStateToProps = createStructuredSelector({
Upload: makeSelectUpload(),
});
const mapDispatchToProps = (dispatch) => ({
openSnackbar: (message) => {
dispatch(snackbarActions.open(message));
},
});
export default connect(mapStateToProps, mapDispatchToProps)(withStyles(styles, { withTheme: true })(Upload));
| Fixed typo
| app/containers/Upload/index.js | Fixed typo | <ide><path>pp/containers/Upload/index.js
<ide> <MdWarning /> Disclaimer: data submitted to the preview section can be seen by all registered users
<ide> of catalysis-hub.org.
<ide> </Paper>
<del> <h3>Why should I submit calculations of reactions energies?</h3>
<add> <h3>Why should I submit calculations of reaction energies?</h3>
<ide> <ul>
<ide> <li>Create an easy-to-use interactive supplementary information for your <a href="/publications">publication</a> with its own URL.</li>
<ide> <li>Get your own <a href="/profile">profile page</a></li> |
|
Java | mit | e882318413eee2bfd99fbb190a506f088e79d754 | 0 | Iron-Panthers/FTC-2016 | package org.firstinspires.ftc.team7316.util.input;
/**
* A wrapper for a single joystick axis.
*/
public class AxisWrapper {
private GamepadAxis inputName;
private GamepadWrapper gpWrapper;
private double power;
public AxisWrapper(GamepadAxis inputName, GamepadWrapper gpWrapper, double power) {
this.inputName = inputName;
this.gpWrapper = gpWrapper;
this.power = power;
}
public AxisWrapper(GamepadAxis inputName, GamepadWrapper gpWrapper) {
this(inputName, gpWrapper, 1);
}
public float value() {
float input = gpWrapper.axisValue(inputName);
float value = (float) Math.abs(Math.pow(input, power));
return input > 0 ? value : -value;
}
public String name() {
return String.valueOf(this.inputName);
}
}
| FtcRobotController/src/main/java/org/firstinspires/ftc/team7316/util/input/AxisWrapper.java | package org.firstinspires.ftc.team7316.util.input;
/**
* A wrapper for a single joystick axis.
*/
public class AxisWrapper {
private GamepadAxis inputName;
private GamepadWrapper gpWrapper;
public AxisWrapper (GamepadAxis inputName, GamepadWrapper gpWrapper) {
this.inputName = inputName;
this.gpWrapper = gpWrapper;
}
public float value() {
return gpWrapper.axisValue(inputName);
}
public String name() {
return String.valueOf(this.inputName);
}
}
| Add exponentials to AxisWrapper
| FtcRobotController/src/main/java/org/firstinspires/ftc/team7316/util/input/AxisWrapper.java | Add exponentials to AxisWrapper | <ide><path>tcRobotController/src/main/java/org/firstinspires/ftc/team7316/util/input/AxisWrapper.java
<ide>
<ide> private GamepadAxis inputName;
<ide> private GamepadWrapper gpWrapper;
<add> private double power;
<ide>
<del> public AxisWrapper (GamepadAxis inputName, GamepadWrapper gpWrapper) {
<add> public AxisWrapper(GamepadAxis inputName, GamepadWrapper gpWrapper, double power) {
<ide> this.inputName = inputName;
<ide> this.gpWrapper = gpWrapper;
<add> this.power = power;
<add> }
<add>
<add> public AxisWrapper(GamepadAxis inputName, GamepadWrapper gpWrapper) {
<add> this(inputName, gpWrapper, 1);
<ide> }
<ide>
<ide> public float value() {
<del> return gpWrapper.axisValue(inputName);
<add> float input = gpWrapper.axisValue(inputName);
<add> float value = (float) Math.abs(Math.pow(input, power));
<add> return input > 0 ? value : -value;
<ide> }
<ide>
<ide> public String name() { |
|
Java | apache-2.0 | 0e54beff45fb2dc5da146b3d37b4e71f2fa45ad4 | 0 | duzhen1996/SSM,huafengw/SSM,huafengw/SSM,drankye/SSM,duzhen1996/SSM,duzhen1996/SSM,littlezhou/SSM-1,littlezhou/SSM-1,Intel-bigdata/SSM,Intel-bigdata/SSM,Intel-bigdata/SSM,huafengw/SSM,drankye/SSM,Intel-bigdata/SSM,drankye/SSM,duzhen1996/SSM,littlezhou/SSM-1,littlezhou/SSM-1,drankye/SSM,drankye/SSM,Intel-bigdata/SSM,drankye/SSM,duzhen1996/SSM,huafengw/SSM,littlezhou/SSM-1,drankye/SSM,huafengw/SSM,Intel-bigdata/SSM,littlezhou/SSM-1,duzhen1996/SSM,Intel-bigdata/SSM,huafengw/SSM,duzhen1996/SSM,huafengw/SSM | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.smartdata.server.engine;
import org.apache.hadoop.conf.Configuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.smartdata.AbstractService;
import org.smartdata.SmartConstants;
import org.smartdata.SmartContext;
import org.smartdata.metastore.ActionSchedulerService;
import org.smartdata.metastore.MetaStore;
import org.smartdata.metastore.StatesUpdateService;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.List;
public class AbstractServiceFactory {
private static final Logger LOG = LoggerFactory.getLogger(AbstractServiceFactory.class);
public static AbstractService createStatesUpdaterService(Configuration conf,
SmartContext context, MetaStore metaStore) throws IOException {
String source = getStatesUpdaterName(conf);
try {
Class clazz = Class.forName(source);
Constructor c = clazz.getConstructor(SmartContext.class, MetaStore.class);
return (StatesUpdateService) c.newInstance(context, metaStore);
} catch (ClassNotFoundException | IllegalAccessException
| InstantiationException | NoSuchMethodException
| InvocationTargetException | NullPointerException e) {
throw new IOException(e);
}
}
public static String getStatesUpdaterName(Configuration conf) {
return SmartConstants.SMART_STATES_UPDATE_SERVICE_IMPL;
}
public static List<ActionSchedulerService> createActionSchedulerServices(Configuration conf,
SmartContext context, MetaStore metaStore, boolean allMustSuccess) throws IOException {
List<ActionSchedulerService> services = new ArrayList<>();
String[] serviceNames = getActionSchedulerNames(conf);
for (String name : serviceNames) {
try {
Class clazz = Class.forName(name);
Constructor c = clazz.getConstructor(SmartContext.class, MetaStore.class);
services.add((ActionSchedulerService) c.newInstance(context, metaStore));
} catch (ClassNotFoundException | IllegalAccessException
| InstantiationException | NoSuchMethodException
| InvocationTargetException | NullPointerException e) {
if (allMustSuccess) {
throw new IOException(e);
} else {
LOG.warn("Error while create action scheduler service '" + name + "'.", e);
}
}
}
return services;
}
public static String[] getActionSchedulerNames(Configuration conf) {
return SmartConstants.SMART_ACTION_SCHEDULER_SERVICE_IMPL.trim().split("\\s*,\\s*");
}
}
| smart-engine/src/main/java/org/smartdata/server/engine/AbstractServiceFactory.java | /**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.smartdata.server.engine;
import org.apache.hadoop.conf.Configuration;
import org.smartdata.AbstractService;
import org.smartdata.SmartConstants;
import org.smartdata.SmartContext;
import org.smartdata.metastore.ActionSchedulerService;
import org.smartdata.metastore.MetaStore;
import org.smartdata.metastore.StatesUpdateService;
import java.io.IOException;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.List;
public class AbstractServiceFactory {
public static AbstractService createStatesUpdaterService(Configuration conf,
SmartContext context, MetaStore metaStore) throws IOException {
String source = getStatesUpdaterName(conf);
try {
Class clazz = Class.forName(source);
Constructor c = clazz.getConstructor(SmartContext.class, MetaStore.class);
return (StatesUpdateService) c.newInstance(context, metaStore);
} catch (ClassNotFoundException | IllegalAccessException
| InstantiationException | NoSuchMethodException
| InvocationTargetException e) {
throw new IOException(e);
}
}
public static String getStatesUpdaterName(Configuration conf) {
return SmartConstants.SMART_STATES_UPDATE_SERVICE_IMPL;
}
public static List<ActionSchedulerService> createActionSchedulerServices(Configuration conf,
SmartContext context, MetaStore metaStore, boolean allMustSuccess) throws IOException {
List<ActionSchedulerService> services = new ArrayList<>();
String[] serviceNames = getActionSchedulerNames(conf);
for (String name : serviceNames) {
try {
Class clazz = Class.forName(name);
Constructor c = clazz.getConstructor(SmartContext.class, MetaStore.class);
services.add((ActionSchedulerService) c.newInstance(context, metaStore));
} catch (ClassNotFoundException | IllegalAccessException
| InstantiationException | NoSuchMethodException
| InvocationTargetException e) {
if (allMustSuccess) {
throw new IOException(e);
} else {
// ignore this
}
}
}
return services;
}
public static String[] getActionSchedulerNames(Configuration conf) {
return SmartConstants.SMART_ACTION_SCHEDULER_SERVICE_IMPL.trim().split("\\s*,\\s*");
}
}
| Add log for AbstractServiceFactory (#958)
| smart-engine/src/main/java/org/smartdata/server/engine/AbstractServiceFactory.java | Add log for AbstractServiceFactory (#958) | <ide><path>mart-engine/src/main/java/org/smartdata/server/engine/AbstractServiceFactory.java
<ide> package org.smartdata.server.engine;
<ide>
<ide> import org.apache.hadoop.conf.Configuration;
<add>import org.slf4j.Logger;
<add>import org.slf4j.LoggerFactory;
<ide> import org.smartdata.AbstractService;
<ide> import org.smartdata.SmartConstants;
<ide> import org.smartdata.SmartContext;
<ide> import java.util.List;
<ide>
<ide> public class AbstractServiceFactory {
<add> private static final Logger LOG = LoggerFactory.getLogger(AbstractServiceFactory.class);
<add>
<ide> public static AbstractService createStatesUpdaterService(Configuration conf,
<ide> SmartContext context, MetaStore metaStore) throws IOException {
<ide> String source = getStatesUpdaterName(conf);
<ide> return (StatesUpdateService) c.newInstance(context, metaStore);
<ide> } catch (ClassNotFoundException | IllegalAccessException
<ide> | InstantiationException | NoSuchMethodException
<del> | InvocationTargetException e) {
<add> | InvocationTargetException | NullPointerException e) {
<ide> throw new IOException(e);
<ide> }
<ide> }
<ide> services.add((ActionSchedulerService) c.newInstance(context, metaStore));
<ide> } catch (ClassNotFoundException | IllegalAccessException
<ide> | InstantiationException | NoSuchMethodException
<del> | InvocationTargetException e) {
<add> | InvocationTargetException | NullPointerException e) {
<ide> if (allMustSuccess) {
<ide> throw new IOException(e);
<ide> } else {
<del> // ignore this
<add> LOG.warn("Error while create action scheduler service '" + name + "'.", e);
<ide> }
<ide> }
<ide> } |
|
Java | mit | 45427570f91ac956c31cf1ddc1f2e2bf399e6529 | 0 | code-orchestra/colt-core,SlavaRa/colt-core,SlavaRa/colt-core,SlavaRa/colt-core,code-orchestra/colt-core,code-orchestra/colt-core | package codeOrchestra.colt.core.logging.model;
import codeOrchestra.colt.core.logging.Level;
import codeOrchestra.util.StringUtils;
import codeOrchestra.util.XMLUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author Alexander Eliseyev
*/
public final class LoggerMessageEncoder {
private static final String LOG_MESSAGE_ELEMENT = "logMessage";
private static final String SOURCE_ELEMENT = "source";
private static final String MESSAGE_ELEMENT = "message";
private static final String SEVERITY_ATTRIBUTE = "severity";
private static final String ROOT_ELEMENT = "root";
private static final String SCOPES_ELEMENT = "scopes";
private static final String SCOPE_ELEMENT = "scope";
private static final String ID_ATTRIBUTE = "id";
private static final String STACK_TRACE_ELEMENT = "stackTrace";
private static final String TIMESTAMP_ELEMENT = "timestamp";
private static final Level DEFAULT_LEVEL = Level.INFO;
private static Map<String, Level> severityMap;
static {
severityMap = new HashMap<>();
severityMap.put("fatal", Level.ERROR);
severityMap.put("error", Level.ERROR);
severityMap.put("warn", Level.WARN);
severityMap.put("debug", Level.INFO);
severityMap.put("info", Level.INFO);
severityMap.put("trace", Level.DEBUG);
severityMap.put("live", Level.LIVE);
}
private static Level getLevel(String severity) {
Level level = severityMap.get(severity);
if (level == null) {
level = DEFAULT_LEVEL;
}
return level;
}
public static boolean isLegitSeverityLevel(String severity) {
return severityMap.get(severity) != null;
}
private LoggerMessageEncoder() {
}
public static LoggerMessage encode(String xmlString) {
Document document = XMLUtils.stringToDOM(xmlString);
Element logMessageRootElement = document.getDocumentElement();
if (LOG_MESSAGE_ELEMENT.equals(document)) {
throw new RuntimeException(LOG_MESSAGE_ELEMENT + " root element expected");
}
// Root FQ Name
NodeList rootNodeList = logMessageRootElement.getElementsByTagName(ROOT_ELEMENT);
String rootFQName = null;
if (rootNodeList != null && rootNodeList.getLength() > 0) {
Element rootElement = (Element) rootNodeList.item(0);
rootFQName = rootElement.getTextContent();
}
// Timestamp
NodeList timestampNodeList = logMessageRootElement.getElementsByTagName(TIMESTAMP_ELEMENT);
if (timestampNodeList == null || timestampNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + TIMESTAMP_ELEMENT + " subelement expected");
}
Element timestampElement = (Element) timestampNodeList.item(0);
String timestsampStr = timestampElement.getTextContent();
// Source node model & node Id
NodeList sourceNodeList = logMessageRootElement.getElementsByTagName(SOURCE_ELEMENT);
if (sourceNodeList == null || sourceNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + SOURCE_ELEMENT + " subelement expected");
}
// Scopes
List<LoggerScopeWrapper> scopesList = new ArrayList<>();
NodeList scopeRootElementNodeList = logMessageRootElement.getElementsByTagName(SCOPES_ELEMENT);
if (scopeRootElementNodeList != null && scopeRootElementNodeList.getLength() > 0) {
Element scopeRootElement = (Element) scopeRootElementNodeList.item(0);
NodeList scopeNodeList = scopeRootElement.getElementsByTagName(SCOPE_ELEMENT);
if (scopeNodeList != null && scopeNodeList.getLength() > 0) {
for (int i = 0; i < scopeNodeList.getLength(); i++) {
Element scopeElement = (Element) scopeNodeList.item(i);
String scopeName = scopeElement.getTextContent();
String scopeId = scopeElement.getAttribute(ID_ATTRIBUTE);
scopesList.add(new LoggerScopeWrapper(scopeId, scopeName));
}
}
}
// Message content & severity
NodeList messageNodeList = logMessageRootElement.getElementsByTagName(MESSAGE_ELEMENT);
if (messageNodeList == null || messageNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + MESSAGE_ELEMENT + " subelement expected");
}
Element messageElement = (Element) messageNodeList.item(0);
String command = messageElement.getAttribute(SEVERITY_ATTRIBUTE);
if (StringUtils.isEmpty(command)) {
throw new RuntimeException(SEVERITY_ATTRIBUTE + " " + MESSAGE_ELEMENT + " element attribute expected");
}
// Stack trace
String stackTrace = null;
NodeList stackTraceNodeList = logMessageRootElement.getElementsByTagName(STACK_TRACE_ELEMENT);
if (stackTraceNodeList != null && stackTraceNodeList.getLength() == 1) {
Element stackTraceElement = (Element) stackTraceNodeList.item(0);
stackTrace = stackTraceElement.getTextContent();
}
// RE-2174
String content = messageElement.getTextContent();
if (content.startsWith("|")) {
content = content.substring(1);
}
Level severityLevel = getLevel(command);
Long timestamp = null;
try {
timestamp = Long.valueOf(timestsampStr);
} catch (Throwable t) {
throw new RuntimeException("Can't parse timestamp " + timestsampStr);
}
LoggerMessage message = new LoggerMessage.Builder()
.command(command)
.message(content)
.rootFQName(rootFQName)
.scopes(scopesList)
.severity(severityLevel)
.timestamp(timestamp)
.stackTrace(stackTrace)
.build();
return message;
}
}
| src/codeOrchestra/colt/core/logging/model/LoggerMessageEncoder.java | package codeOrchestra.colt.core.logging.model;
import codeOrchestra.colt.core.logging.Level;
import codeOrchestra.util.StringUtils;
import codeOrchestra.util.XMLUtils;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* @author Alexander Eliseyev
*/
public final class LoggerMessageEncoder {
private static final String LOG_MESSAGE_ELEMENT = "logMessage";
private static final String SOURCE_ELEMENT = "source";
private static final String MESSAGE_ELEMENT = "message";
private static final String SEVERITY_ATTRIBUTE = "severity";
private static final String ROOT_ELEMENT = "root";
private static final String SCOPES_ELEMENT = "scopes";
private static final String SCOPE_ELEMENT = "scope";
private static final String ID_ATTRIBUTE = "id";
private static final String STACK_TRACE_ELEMENT = "stackTrace";
private static final String TIMESTAMP_ELEMENT = "timestamp";
private static final Level DEFAULT_LEVEL = Level.INFO;
private static Map<String, Level> severityMap;
static {
severityMap = new HashMap<>();
severityMap.put("fatal", Level.ERROR);
severityMap.put("error", Level.ERROR);
severityMap.put("warn", Level.WARN);
severityMap.put("debug", Level.INFO);
severityMap.put("info", Level.INFO);
severityMap.put("trace", Level.INFO);
}
private static Level getLevel(String severity) {
Level level = severityMap.get(severity);
if (level == null) {
level = DEFAULT_LEVEL;
}
return level;
}
public static boolean isLegitSeverityLevel(String severity) {
return severityMap.get(severity) != null;
}
private LoggerMessageEncoder() {
}
public static LoggerMessage encode(String xmlString) {
Document document = XMLUtils.stringToDOM(xmlString);
Element logMessageRootElement = document.getDocumentElement();
if (LOG_MESSAGE_ELEMENT.equals(document)) {
throw new RuntimeException(LOG_MESSAGE_ELEMENT + " root element expected");
}
// Root FQ Name
NodeList rootNodeList = logMessageRootElement.getElementsByTagName(ROOT_ELEMENT);
String rootFQName = null;
if (rootNodeList != null && rootNodeList.getLength() > 0) {
Element rootElement = (Element) rootNodeList.item(0);
rootFQName = rootElement.getTextContent();
}
// Timestamp
NodeList timestampNodeList = logMessageRootElement.getElementsByTagName(TIMESTAMP_ELEMENT);
if (timestampNodeList == null || timestampNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + TIMESTAMP_ELEMENT + " subelement expected");
}
Element timestampElement = (Element) timestampNodeList.item(0);
String timestsampStr = timestampElement.getTextContent();
// Source node model & node Id
NodeList sourceNodeList = logMessageRootElement.getElementsByTagName(SOURCE_ELEMENT);
if (sourceNodeList == null || sourceNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + SOURCE_ELEMENT + " subelement expected");
}
// Scopes
List<LoggerScopeWrapper> scopesList = new ArrayList<>();
NodeList scopeRootElementNodeList = logMessageRootElement.getElementsByTagName(SCOPES_ELEMENT);
if (scopeRootElementNodeList != null && scopeRootElementNodeList.getLength() > 0) {
Element scopeRootElement = (Element) scopeRootElementNodeList.item(0);
NodeList scopeNodeList = scopeRootElement.getElementsByTagName(SCOPE_ELEMENT);
if (scopeNodeList != null && scopeNodeList.getLength() > 0) {
for (int i = 0; i < scopeNodeList.getLength(); i++) {
Element scopeElement = (Element) scopeNodeList.item(i);
String scopeName = scopeElement.getTextContent();
String scopeId = scopeElement.getAttribute(ID_ATTRIBUTE);
scopesList.add(new LoggerScopeWrapper(scopeId, scopeName));
}
}
}
// Message content & severity
NodeList messageNodeList = logMessageRootElement.getElementsByTagName(MESSAGE_ELEMENT);
if (messageNodeList == null || messageNodeList.getLength() != 1) {
throw new RuntimeException("Exactly one " + MESSAGE_ELEMENT + " subelement expected");
}
Element messageElement = (Element) messageNodeList.item(0);
String command = messageElement.getAttribute(SEVERITY_ATTRIBUTE);
if (StringUtils.isEmpty(command)) {
throw new RuntimeException(SEVERITY_ATTRIBUTE + " " + MESSAGE_ELEMENT + " element attribute expected");
}
// Stack trace
String stackTrace = null;
NodeList stackTraceNodeList = logMessageRootElement.getElementsByTagName(STACK_TRACE_ELEMENT);
if (stackTraceNodeList != null && stackTraceNodeList.getLength() == 1) {
Element stackTraceElement = (Element) stackTraceNodeList.item(0);
stackTrace = stackTraceElement.getTextContent();
}
// RE-2174
String content = messageElement.getTextContent();
if (content.startsWith("|")) {
content = content.substring(1);
}
Level severityLevel = getLevel(command);
Long timestamp = null;
try {
timestamp = Long.valueOf(timestsampStr);
} catch (Throwable t) {
throw new RuntimeException("Can't parse timestamp " + timestsampStr);
}
LoggerMessage message = new LoggerMessage.Builder()
.command(command)
.message(content)
.rootFQName(rootFQName)
.scopes(scopesList)
.severity(severityLevel)
.timestamp(timestamp)
.stackTrace(stackTrace)
.build();
return message;
}
}
| logger fixes
| src/codeOrchestra/colt/core/logging/model/LoggerMessageEncoder.java | logger fixes | <ide><path>rc/codeOrchestra/colt/core/logging/model/LoggerMessageEncoder.java
<ide> severityMap.put("warn", Level.WARN);
<ide> severityMap.put("debug", Level.INFO);
<ide> severityMap.put("info", Level.INFO);
<del> severityMap.put("trace", Level.INFO);
<add> severityMap.put("trace", Level.DEBUG);
<add> severityMap.put("live", Level.LIVE);
<ide> }
<ide>
<ide> private static Level getLevel(String severity) { |
|
Java | mit | 20a55004762bcc9e1bfdaa6844a3ba3711450652 | 0 | wakaleo/maven-schemaspy-plugin,wakaleo/maven-schemaspy-plugin | package com.wakaleo.schemaspy;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import net.sourceforge.schemaspy.Config;
import net.sourceforge.schemaspy.SchemaAnalyzer;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import com.wakaleo.schemaspy.util.JDBCHelper;
/**
* The SchemaSpy Maven plugin report.
*
* @author John Smart
* @mainpage The SchemaSpy Maven plugin This plugin is designed to generate
* SchemaSpy reports for a Maven web site.
*
* SchemaSpy (http://schemaspy.sourceforge.net) does not need to be
* installed and accessible on your machine. However, SchemaSpy also
* needs the Graphviz tool (http://www.graphviz.org/) in order to
* generate graphical representations of the table/view relationships,
* so this needs to be installed on your machine.
*
* The schemaspy goal invokes the SchemaSpy command-line tool.
* SchemaSpy generates a graphical and HTML report describing a given
* relational database.
*
* @goal schemaspy
*/
public class SchemaSpyReport extends AbstractMavenReport {
/**
* The output directory for the intermediate report.
*
* @parameter expression="${project.build.directory}"
* @required
*/
private File targetDirectory;
/**
* The output directory where the final HTML reports will be generated. Note
* that the reports are always generated in a directory called "schemaspy".
* The output directory refers to the directory in which the "schemaspy"
* will be generated.
*
* @parameter expression="${project.reporting.outputDirectory}"
* default-value="${project.build.directory}/site"
* @required
*/
private String outputDirectory;
/**
* Site rendering component for generating the HTML report.
*
* @component
*/
private Renderer siteRenderer;
/**
* The Maven project object.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project;
/**
* The name of the database being analysed.
*
* @parameter database
* @required
*/
private String database;
/**
* The host address of the database being analysed.
*
* @parameter host
*/
private String host;
/**
* The port, required by some drivers.
*
* @parameter port
*/
private String port;
/**
* The JDBC URL to be used to connect to the database. Rather than defining
* the database and host names and letting SchemaSpy build the URL, you can
* alternatively specify the complete JDBC URL using this parameter. If this
* parameter is defined, it will override the host address (which, as a
* result, is not needed). Note that you still need to specify the database
* type, since SchemaSpy uses its own database properties file for extra
* information about each database.
*
* @todo Would it be possible to guess the database type from the form of
* the URL?
* @parameter jdbcUrl
*/
private String jdbcUrl;
/**
* The type of database being analysed - defaults to ora.
*
* @parameter databaseType
*/
private String databaseType;
/**
* Connect to the database with this user id.
*
* @parameter user
*/
private String user;
/**
* Database schema to use - defaults to the specified user.
*
* @parameter schema
*/
private String schema;
/**
* Database password to use - defaults to none.
*
* @parameter password
*/
private String password;
/**
* If specified, SchemaSpy will look for JDBC drivers on this path, rather
* than using the application classpath. Useful if your database has a
* non-O/S driver not bundled with the plugin.
*
* @parameter pathToDrivers
*/
private String pathToDrivers;
/**
* Schema description. Displays the specified textual description on summary
* pages. If your description includes an equals sign then escape it with a
* backslash. NOTE: This field doesn't seem to be used by SchemaSpy in the
* current version.
*
* @parameter schemaDescription
*/
private String schemaDescription;
/**
* Only include matching tables/views. This is a regular expression that's
* used to determine which tables/views to include. For example: -i
* "(.*book.*)|(library.*)" includes only those tables/views with 'book' in
* their names or that start with 'library'. You might want to use
* "description" with this option to describe the subset of tables.
*
* @parameter includeTableNamesRegex
*/
private String includeTableNamesRegex;
/**
* Exclude matching columns from relationship analysis to simplify the
* generated graphs. This is a regular expression that's used to determine
* which columns to exclude. It must match table name, followed by a dot,
* followed by column name. For example: -x "(book.isbn)|(borrower.address)"
* Note that each column name regular expression must be surround by ()'s
* and separated from other column names by a |.
*
* @parameter excludeColumnNamesRegex
*/
private String excludeColumnNamesRegex;
/**
* Allow HTML In Comments. Any HTML embedded in comments normally gets
* encoded so that it's rendered as text. This option allows it to be
* rendered as HTML.
*
* @parameter allowHtmlInComments
*/
private Boolean allowHtmlInComments;
/**
* Comments Initially Displayed. Column comments are normally hidden by
* default. This option displays them by default.
*
* @parameter commentsInitiallyDisplayed
*/
private Boolean commentsInitiallyDisplayed;
/**
* Don't include implied foreign key relationships in the generated table
* details.
*
* @parameter noImplied
*/
private Boolean noImplied;
/**
* Only generate files needed for insertion/deletion of data (e.g. for
* scripts).
*
* @parameter noHtml
*/
private Boolean noHtml;
/**
* Some databases, like Derby, will crash if you use the old driver object
* to establish a connection (eg "connection = driver.connect(...)"). In
* this case, set useDriverManager to true to use the
* DriverManager.getConnection() method instead (eg "connection =
* java.sql.DriverManager.getConnection(...)"). Other databases (eg MySQL)
* seem to only work with the first method, so don't use this parameter
* unless you have to.
*
* @parameter useDriverManager
*/
private Boolean useDriverManager;
/**
* The CSS Stylesheet. Allows you to override the default SchemaSpyCSS
* stylesheet.
*
* @parameter cssStylesheet
*/
private String cssStylesheet;
/**
* Single Sign-On. Don't require a user to be specified with -user to
* simplify configuration when running in a single sign-on environment.
*
* @parameter singleSignOn
*/
private Boolean singleSignOn;
/**
* Generate lower-quality diagrams. Various installations of Graphviz (depending on OS
* and/or version) will default to generating either higher or lower quality images.
* That is, some might not have the "lower quality" libraries and others might not have
* the "higher quality" libraries.
* @parameter lowQuality
*/
private Boolean lowQuality;
/**
* Generate higher-quality diagrams. Various installations of Graphviz (depending on OS
* and/or version) will default to generating either higher or lower quality images.
* That is, some might not have the "lower quality" libraries and others might not have
* the "higher quality" libraries.
* @parameter highQuality
*/
private Boolean highQuality;
/**
* Evaluate all schemas in a database. Generates a high-level index of the schemas
* evaluated and allows for traversal of cross-schema foreign key relationships.
* Use with -schemaSpec "schemaRegularExpression" to narrow-down the schemas to include.
* @parameter showAllSchemas
*/
private Boolean showAllSchemas;
/**
* Evaluate specified schemas.
* Similar to -showAllSchemas, but explicitly specifies which schema to evaluate without
* interrogating the database's metadata. Can be used with databases like MySQL where a
* database isn't composed of multiple schemas.
* @parameter schemas
*/
private String schemas;
/**
* No schema required for this database (e.g. derby).
* @parameter noSchema
*/
private Boolean noSchema;
/**
* Don't query or display row counts.
* @parameter noRows
*/
private Boolean noRows;
/**
* Don't query or display row counts.
* @parameter noViews
*/
private Boolean noViews;
/**
* Specifies additional properties to be used when connecting to the database.
* Specify the entries directly, escaping the ='s with \= and separating each key\=value
* pair with a ;.
*
* May also be a file name, useful for hiding connection properties from public logs.
*
* @parameter connprops
*/
private String connprops;
/**
* Don't generate ads in reports
*
* @parameter noAds
*/
private Boolean noAds;
/**
* Don't generate sourceforge logos in reports
*
* @parameter noLogo
*/
private Boolean noLogo;
/**
* Whether to create the report only on the execution root of a multi-module project.
*
* @parameter expression="${runOnExecutionRoot}" default-value="false"
* @since 5.0.4
*/
protected boolean runOnExecutionRoot = false;
/**
* The SchemaSpy analyser that generates the actual report.
* Can be overridden for testing purposes.
*/
SchemaAnalyzer analyzer = new SchemaAnalyzer();
/**
* Utility class to help determine the type of the target database.
*/
private JDBCHelper jdbcHelper = new JDBCHelper();
protected void setSchemaAnalyzer(SchemaAnalyzer analyzer) {
this.analyzer = analyzer;
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addToArguments(final List<String> argList,
final String parameter, final Boolean value) {
if ((value != null) && (value)) {
argList.add(parameter + "=" + value);
}
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addFlagToArguments(final List<String> argList,
final String parameter, final Boolean value) {
if ((value != null) && (value)) {
argList.add(parameter);
}
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addToArguments(final List<String> argList,
final String parameter, final String value) {
if (value != null) {
argList.add(parameter + "=" + value);
}
}
/**
* Generate the Schemaspy report.
*
* @throws MavenReportException
* if schemaspy crashes
* @param locale
* the language of the report - currently ignored.
*/
@Override
protected void executeReport(Locale locale) throws MavenReportException {
//
// targetDirectory should be set by the maven framework. This is
// jusr for unit testing purposes
//
if (targetDirectory == null) {
targetDirectory = new File("target");
}
targetDirectory.mkdirs();
File siteDir = new File(targetDirectory, "site");
siteDir.mkdirs();
File outputDir = null;
if (outputDirectory == null) {
outputDir = new File(siteDir, "schemaspy");
outputDir.mkdirs();
outputDirectory = outputDir.getAbsolutePath();
} else {
outputDir = new File(new File(outputDirectory), "schemaspy");
outputDir.mkdirs();
}
String schemaSpyDirectory = outputDir.getAbsolutePath();
List<String> argList = new ArrayList<String>();
if ((jdbcUrl != null) && (databaseType == null)) {
databaseType = jdbcHelper.extractDatabaseType(jdbcUrl);
}
addToArguments(argList, "-dp", pathToDrivers);
addToArguments(argList, "-db", database);
addToArguments(argList, "-host", host);
addToArguments(argList, "-port", port);
addToArguments(argList, "-t", databaseType);
addToArguments(argList, "-u", user);
addToArguments(argList, "-p", password);
addToArguments(argList, "-s", schema);
addToArguments(argList, "-o", schemaSpyDirectory);
addToArguments(argList, "-desc", schemaDescription);
addToArguments(argList, "-i", includeTableNamesRegex);
addToArguments(argList, "-x", excludeColumnNamesRegex);
addFlagToArguments(argList, "-ahic", allowHtmlInComments);
addFlagToArguments(argList, "-noimplied", noImplied);
addFlagToArguments(argList, "-nohtml", noHtml);
addFlagToArguments(argList, "-norows", noRows);
addFlagToArguments(argList, "-noviews", noViews);
addFlagToArguments(argList, "-noschema", noSchema);
addFlagToArguments(argList, "-all", showAllSchemas);
addToArguments(argList, "-schemas", schemas);
addToArguments(argList, "-useDriverManager", useDriverManager);
addToArguments(argList, "-css", cssStylesheet);
addFlagToArguments(argList, "-sso", singleSignOn);
addFlagToArguments(argList, "-lq", lowQuality);
addFlagToArguments(argList, "-hq", highQuality);
addToArguments(argList, "-connprops", connprops);
addFlagToArguments(argList, "-cid", commentsInitiallyDisplayed);
addFlagToArguments(argList, "-noads", noAds);
addFlagToArguments(argList, "-nologo", noLogo);
/*
addToArguments(argList, "-jdbcUrl", jdbcUrl);
*/
String[] args = (String[]) argList.toArray(new String[0]);
getLog().info("Generating SchemaSpy report with parameters:");
for (String arg : args) {
getLog().info(arg);
}
try {
analyzer.analyze(new Config(args));
} catch (Exception e) {
throw new MavenReportException(e.getMessage(), e);
}
}
@Override
public boolean canGenerateReport() {
return !runOnExecutionRoot || project.isExecutionRoot();
}
@Override
protected String getOutputDirectory() {
return outputDirectory;
}
@Override
protected MavenProject getProject() {
return project;
}
@Override
protected Renderer getSiteRenderer() {
return siteRenderer;
}
/**
* Describes the report.
*/
public String getDescription(Locale locale) {
return "SchemaSpy database documentation";
}
/**
* Not really sure what this does ;-).
*/
public String getName(Locale locale) {
return "SchemaSpy";
}
public String getOutputName() {
return "schemaspy/index";
}
/**
* Always return true as we're using the report generated by SchemaSpy
* rather than creating our own report.
*
* @return true
*/
public boolean isExternalReport() {
return true;
}
}
| src/main/java/com/wakaleo/schemaspy/SchemaSpyReport.java | package com.wakaleo.schemaspy;
import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import net.sourceforge.schemaspy.Config;
import net.sourceforge.schemaspy.SchemaAnalyzer;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.project.MavenProject;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import com.wakaleo.schemaspy.util.JDBCHelper;
/**
* The SchemaSpy Maven plugin report.
*
* @author John Smart
* @mainpage The SchemaSpy Maven plugin This plugin is designed to generate
* SchemaSpy reports for a Maven web site.
*
* SchemaSpy (http://schemaspy.sourceforge.net) does not need to be
* installed and accessible on your machine. However, SchemaSpy also
* needs the Graphviz tool (http://www.graphviz.org/) in order to
* generate graphical representations of the table/view relationships,
* so this needs to be installed on your machine.
*
* The schemaspy goal invokes the SchemaSpy command-line tool.
* SchemaSpy generates a graphical and HTML report describing a given
* relational database.
*
* @goal schemaspy
*/
public class SchemaSpyReport extends AbstractMavenReport {
/**
* The output directory for the intermediate report.
*
* @parameter expression="${project.build.directory}"
* @required
*/
private File targetDirectory;
/**
* The output directory where the final HTML reports will be generated. Note
* that the reports are always generated in a directory called "schemaspy".
* The output directory refers to the directory in which the "schemaspy"
* will be generated.
*
* @parameter expression="${project.reporting.outputDirectory}"
* default-value="${project.build.directory}/site"
* @required
*/
private String outputDirectory;
/**
* Site rendering component for generating the HTML report.
*
* @component
*/
private Renderer siteRenderer;
/**
* The Maven project object.
*
* @parameter expression="${project}"
* @required
* @readonly
*/
private MavenProject project;
/**
* The name of the database being analysed.
*
* @parameter database
* @required
*/
private String database;
/**
* The host address of the database being analysed.
*
* @parameter host
*/
private String host;
/**
* The port, required by some drivers.
*
* @parameter port
*/
private String port;
/**
* The JDBC URL to be used to connect to the database. Rather than defining
* the database and host names and letting SchemaSpy build the URL, you can
* alternatively specify the complete JDBC URL using this parameter. If this
* parameter is defined, it will override the host address (which, as a
* result, is not needed). Note that you still need to specify the database
* type, since SchemaSpy uses its own database properties file for extra
* information about each database.
*
* @todo Would it be possible to guess the database type from the form of
* the URL?
* @parameter jdbcUrl
*/
private String jdbcUrl;
/**
* The type of database being analysed - defaults to ora.
*
* @parameter databaseType
*/
private String databaseType;
/**
* Connect to the database with this user id.
*
* @parameter user
*/
private String user;
/**
* Database schema to use - defaults to the specified user.
*
* @parameter schema
*/
private String schema;
/**
* Database password to use - defaults to none.
*
* @parameter password
*/
private String password;
/**
* If specified, SchemaSpy will look for JDBC drivers on this path, rather
* than using the application classpath. Useful if your database has a
* non-O/S driver not bundled with the plugin.
*
* @parameter pathToDrivers
*/
private String pathToDrivers;
/**
* Schema description. Displays the specified textual description on summary
* pages. If your description includes an equals sign then escape it with a
* backslash. NOTE: This field doesn't seem to be used by SchemaSpy in the
* current version.
*
* @parameter schemaDescription
*/
private String schemaDescription;
/**
* Only include matching tables/views. This is a regular expression that's
* used to determine which tables/views to include. For example: -i
* "(.*book.*)|(library.*)" includes only those tables/views with 'book' in
* their names or that start with 'library'. You might want to use
* "description" with this option to describe the subset of tables.
*
* @parameter includeTableNamesRegex
*/
private String includeTableNamesRegex;
/**
* Exclude matching columns from relationship analysis to simplify the
* generated graphs. This is a regular expression that's used to determine
* which columns to exclude. It must match table name, followed by a dot,
* followed by column name. For example: -x "(book.isbn)|(borrower.address)"
* Note that each column name regular expression must be surround by ()'s
* and separated from other column names by a |.
*
* @parameter excludeColumnNamesRegex
*/
private String excludeColumnNamesRegex;
/**
* Allow HTML In Comments. Any HTML embedded in comments normally gets
* encoded so that it's rendered as text. This option allows it to be
* rendered as HTML.
*
* @parameter allowHtmlInComments
*/
private Boolean allowHtmlInComments;
/**
* Comments Initially Displayed. Column comments are normally hidden by
* default. This option displays them by default.
*
* @parameter commentsInitiallyDisplayed
*/
private Boolean commentsInitiallyDisplayed;
/**
* Don't include implied foreign key relationships in the generated table
* details.
*
* @parameter noImplied
*/
private Boolean noImplied;
/**
* Only generate files needed for insertion/deletion of data (e.g. for
* scripts).
*
* @parameter noHtml
*/
private Boolean noHtml;
/**
* Some databases, like Derby, will crash if you use the old driver object
* to establish a connection (eg "connection = driver.connect(...)"). In
* this case, set useDriverManager to true to use the
* DriverManager.getConnection() method instead (eg "connection =
* java.sql.DriverManager.getConnection(...)"). Other databases (eg MySQL)
* seem to only work with the first method, so don't use this parameter
* unless you have to.
*
* @parameter useDriverManager
*/
private Boolean useDriverManager;
/**
* The CSS Stylesheet. Allows you to override the default SchemaSpyCSS
* stylesheet.
*
* @parameter cssStylesheet
*/
private String cssStylesheet;
/**
* Single Sign-On. Don't require a user to be specified with -user to
* simplify configuration when running in a single sign-on environment.
*
* @parameter singleSignOn
*/
private Boolean singleSignOn;
/**
* Generate lower-quality diagrams. Various installations of Graphviz (depending on OS
* and/or version) will default to generating either higher or lower quality images.
* That is, some might not have the "lower quality" libraries and others might not have
* the "higher quality" libraries.
* @parameter lowQuality
*/
private Boolean lowQuality;
/**
* Generate higher-quality diagrams. Various installations of Graphviz (depending on OS
* and/or version) will default to generating either higher or lower quality images.
* That is, some might not have the "lower quality" libraries and others might not have
* the "higher quality" libraries.
* @parameter highQuality
*/
private Boolean highQuality;
/**
* Evaluate all schemas in a database. Generates a high-level index of the schemas
* evaluated and allows for traversal of cross-schema foreign key relationships.
* Use with -schemaSpec "schemaRegularExpression" to narrow-down the schemas to include.
* @parameter showAllSchemas
*/
private Boolean showAllSchemas;
/**
* Evaluate specified schemas.
* Similar to -showAllSchemas, but explicitly specifies which schema to evaluate without
* interrogating the database's metadata. Can be used with databases like MySQL where a
* database isn't composed of multiple schemas.
* @parameter schemas
*/
private String schemas;
/**
* No schema required for this database (e.g. derby).
* @parameter noSchema
*/
private Boolean noSchema;
/**
* Don't query or display row counts.
* @parameter noRows
*/
private Boolean noRows;
/**
* Don't query or display row counts.
* @parameter noViews
*/
private Boolean noViews;
/**
* Specifies additional properties to be used when connecting to the database.
* Specify the entries directly, escaping the ='s with \= and separating each key\=value
* pair with a ;.
* @parameter connprops
*/
private String connprops;
/**
* Don't generate ads in reports
*
* @parameter noAds
*/
private Boolean noAds;
/**
* Don't generate sourceforge logos in reports
*
* @parameter noLogo
*/
private Boolean noLogo;
/**
* Whether to create the report only on the execution root of a multi-module project.
*
* @parameter expression="${runOnExecutionRoot}" default-value="false"
* @since 5.0.4
*/
protected boolean runOnExecutionRoot = false;
/**
* The SchemaSpy analyser that generates the actual report.
* Can be overridden for testing purposes.
*/
SchemaAnalyzer analyzer = new SchemaAnalyzer();
/**
* Utility class to help determine the type of the target database.
*/
private JDBCHelper jdbcHelper = new JDBCHelper();
protected void setSchemaAnalyzer(SchemaAnalyzer analyzer) {
this.analyzer = analyzer;
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addToArguments(final List<String> argList,
final String parameter, final Boolean value) {
if ((value != null) && (value)) {
argList.add(parameter + "=" + value);
}
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addFlagToArguments(final List<String> argList,
final String parameter, final Boolean value) {
if ((value != null) && (value)) {
argList.add(parameter);
}
}
/**
* Convenience method used to build the schemaspy command line parameters.
*
* @param argList
* the current list of schemaspy parameter options.
* @param parameter
* a new parameter to add
* @param value
* the value for this parameter
*/
private void addToArguments(final List<String> argList,
final String parameter, final String value) {
if (value != null) {
argList.add(parameter + "=" + value);
}
}
/**
* Generate the Schemaspy report.
*
* @throws MavenReportException
* if schemaspy crashes
* @param locale
* the language of the report - currently ignored.
*/
@Override
protected void executeReport(Locale locale) throws MavenReportException {
//
// targetDirectory should be set by the maven framework. This is
// jusr for unit testing purposes
//
if (targetDirectory == null) {
targetDirectory = new File("target");
}
targetDirectory.mkdirs();
File siteDir = new File(targetDirectory, "site");
siteDir.mkdirs();
File outputDir = null;
if (outputDirectory == null) {
outputDir = new File(siteDir, "schemaspy");
outputDir.mkdirs();
outputDirectory = outputDir.getAbsolutePath();
} else {
outputDir = new File(new File(outputDirectory), "schemaspy");
outputDir.mkdirs();
}
String schemaSpyDirectory = outputDir.getAbsolutePath();
List<String> argList = new ArrayList<String>();
if ((jdbcUrl != null) && (databaseType == null)) {
databaseType = jdbcHelper.extractDatabaseType(jdbcUrl);
}
addToArguments(argList, "-dp", pathToDrivers);
addToArguments(argList, "-db", database);
addToArguments(argList, "-host", host);
addToArguments(argList, "-port", port);
addToArguments(argList, "-t", databaseType);
addToArguments(argList, "-u", user);
addToArguments(argList, "-p", password);
addToArguments(argList, "-s", schema);
addToArguments(argList, "-o", schemaSpyDirectory);
addToArguments(argList, "-desc", schemaDescription);
addToArguments(argList, "-i", includeTableNamesRegex);
addToArguments(argList, "-x", excludeColumnNamesRegex);
addFlagToArguments(argList, "-ahic", allowHtmlInComments);
addFlagToArguments(argList, "-noimplied", noImplied);
addFlagToArguments(argList, "-nohtml", noHtml);
addFlagToArguments(argList, "-norows", noRows);
addFlagToArguments(argList, "-noviews", noViews);
addFlagToArguments(argList, "-noschema", noSchema);
addFlagToArguments(argList, "-all", showAllSchemas);
addToArguments(argList, "-schemas", schemas);
addToArguments(argList, "-useDriverManager", useDriverManager);
addToArguments(argList, "-css", cssStylesheet);
addFlagToArguments(argList, "-sso", singleSignOn);
addFlagToArguments(argList, "-lq", lowQuality);
addFlagToArguments(argList, "-hq", highQuality);
addToArguments(argList, "connprops", connprops);
addFlagToArguments(argList, "-cid", commentsInitiallyDisplayed);
addFlagToArguments(argList, "-noads", noAds);
addFlagToArguments(argList, "-nologo", noLogo);
/*
addToArguments(argList, "-jdbcUrl", jdbcUrl);
*/
String[] args = (String[]) argList.toArray(new String[0]);
getLog().info("Generating SchemaSpy report with parameters:");
for (String arg : args) {
getLog().info(arg);
}
try {
analyzer.analyze(new Config(args));
} catch (Exception e) {
throw new MavenReportException(e.getMessage(), e);
}
}
@Override
public boolean canGenerateReport() {
return !runOnExecutionRoot || project.isExecutionRoot();
}
@Override
protected String getOutputDirectory() {
return outputDirectory;
}
@Override
protected MavenProject getProject() {
return project;
}
@Override
protected Renderer getSiteRenderer() {
return siteRenderer;
}
/**
* Describes the report.
*/
public String getDescription(Locale locale) {
return "SchemaSpy database documentation";
}
/**
* Not really sure what this does ;-).
*/
public String getName(Locale locale) {
return "SchemaSpy";
}
public String getOutputName() {
return "schemaspy/index";
}
/**
* Always return true as we're using the report generated by SchemaSpy
* rather than creating our own report.
*
* @return true
*/
public boolean isExternalReport() {
return true;
}
}
| Add missing hyphen to connprops argument
| src/main/java/com/wakaleo/schemaspy/SchemaSpyReport.java | Add missing hyphen to connprops argument | <ide><path>rc/main/java/com/wakaleo/schemaspy/SchemaSpyReport.java
<ide> * Specifies additional properties to be used when connecting to the database.
<ide> * Specify the entries directly, escaping the ='s with \= and separating each key\=value
<ide> * pair with a ;.
<add> *
<add> * May also be a file name, useful for hiding connection properties from public logs.
<add> *
<ide> * @parameter connprops
<ide> */
<ide> private String connprops;
<ide> addFlagToArguments(argList, "-sso", singleSignOn);
<ide> addFlagToArguments(argList, "-lq", lowQuality);
<ide> addFlagToArguments(argList, "-hq", highQuality);
<del> addToArguments(argList, "connprops", connprops);
<add> addToArguments(argList, "-connprops", connprops);
<ide> addFlagToArguments(argList, "-cid", commentsInitiallyDisplayed);
<ide> addFlagToArguments(argList, "-noads", noAds);
<ide> addFlagToArguments(argList, "-nologo", noLogo); |
|
Java | apache-2.0 | a6bb17b4fecafd099299eaa1ee0133cd37d8418b | 0 | flux-capacitor-io/flux-capacitor-client,flux-capacitor-io/flux-capacitor-client,flux-capacitor-io/flux-capacitor-client,flux-capacitor-io/flux-capacitor-client | /*
* Copyright (c) 2016-2021 Flux Capacitor.
*
* 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.fluxcapacitor.javaclient.configuration;
import io.fluxcapacitor.common.MessageType;
import io.fluxcapacitor.common.Registration;
import io.fluxcapacitor.common.handling.ParameterResolver;
import io.fluxcapacitor.javaclient.FluxCapacitor;
import io.fluxcapacitor.javaclient.common.ClientUtils;
import io.fluxcapacitor.javaclient.common.serialization.DeserializingMessage;
import io.fluxcapacitor.javaclient.common.serialization.MessageSerializer;
import io.fluxcapacitor.javaclient.common.serialization.Serializer;
import io.fluxcapacitor.javaclient.common.serialization.jackson.JacksonSerializer;
import io.fluxcapacitor.javaclient.configuration.client.Client;
import io.fluxcapacitor.javaclient.modeling.AggregateRepository;
import io.fluxcapacitor.javaclient.modeling.CompositeAggregateRepository;
import io.fluxcapacitor.javaclient.persisting.caching.Cache;
import io.fluxcapacitor.javaclient.persisting.caching.CachingAggregateRepository;
import io.fluxcapacitor.javaclient.persisting.caching.DefaultCache;
import io.fluxcapacitor.javaclient.persisting.caching.SelectiveCache;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultEventSourcingHandlerFactory;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultEventStore;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultSnapshotRepository;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventSourcingHandlerFactory;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventSourcingRepository;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventStore;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventStoreSerializer;
import io.fluxcapacitor.javaclient.persisting.keyvalue.DefaultKeyValueStore;
import io.fluxcapacitor.javaclient.persisting.keyvalue.KeyValueStore;
import io.fluxcapacitor.javaclient.publishing.CommandGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultCommandGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultErrorGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultEventGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultGenericGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultMetricsGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultQueryGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultRequestHandler;
import io.fluxcapacitor.javaclient.publishing.DefaultResultGateway;
import io.fluxcapacitor.javaclient.publishing.DispatchInterceptor;
import io.fluxcapacitor.javaclient.publishing.ErrorGateway;
import io.fluxcapacitor.javaclient.publishing.EventGateway;
import io.fluxcapacitor.javaclient.publishing.GenericGateway;
import io.fluxcapacitor.javaclient.publishing.MetricsGateway;
import io.fluxcapacitor.javaclient.publishing.QueryGateway;
import io.fluxcapacitor.javaclient.publishing.RequestHandler;
import io.fluxcapacitor.javaclient.publishing.ResultGateway;
import io.fluxcapacitor.javaclient.publishing.correlation.CorrelatingInterceptor;
import io.fluxcapacitor.javaclient.publishing.dataprotection.DataProtectionInterceptor;
import io.fluxcapacitor.javaclient.publishing.routing.MessageRoutingInterceptor;
import io.fluxcapacitor.javaclient.scheduling.DefaultScheduler;
import io.fluxcapacitor.javaclient.scheduling.Scheduler;
import io.fluxcapacitor.javaclient.scheduling.SchedulingInterceptor;
import io.fluxcapacitor.javaclient.tracking.BatchInterceptor;
import io.fluxcapacitor.javaclient.tracking.ConsumerConfiguration;
import io.fluxcapacitor.javaclient.tracking.DefaultTracking;
import io.fluxcapacitor.javaclient.tracking.Tracking;
import io.fluxcapacitor.javaclient.tracking.TrackingException;
import io.fluxcapacitor.javaclient.tracking.handling.DefaultHandlerFactory;
import io.fluxcapacitor.javaclient.tracking.handling.HandlerInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.HandlerRegistry;
import io.fluxcapacitor.javaclient.tracking.handling.LocalHandlerRegistry;
import io.fluxcapacitor.javaclient.tracking.handling.authentication.AuthenticatingInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.authentication.UserProvider;
import io.fluxcapacitor.javaclient.tracking.handling.errorreporting.ErrorReportingInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.validation.ValidatingInterceptor;
import io.fluxcapacitor.javaclient.tracking.metrics.HandlerMonitor;
import io.fluxcapacitor.javaclient.tracking.metrics.TrackerMonitor;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;
import java.time.Clock;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.Callable;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.UnaryOperator;
import java.util.stream.Stream;
import static io.fluxcapacitor.common.MessageType.COMMAND;
import static io.fluxcapacitor.common.MessageType.ERROR;
import static io.fluxcapacitor.common.MessageType.EVENT;
import static io.fluxcapacitor.common.MessageType.METRICS;
import static io.fluxcapacitor.common.MessageType.NOTIFICATION;
import static io.fluxcapacitor.common.MessageType.QUERY;
import static io.fluxcapacitor.common.MessageType.RESULT;
import static io.fluxcapacitor.common.MessageType.SCHEDULE;
import static io.fluxcapacitor.javaclient.common.serialization.DeserializingMessage.defaultParameterResolvers;
import static java.lang.Runtime.getRuntime;
import static java.lang.String.format;
import static java.util.Arrays.stream;
import static java.util.Collections.singletonList;
import static java.util.Collections.unmodifiableMap;
import static java.util.function.Function.identity;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toMap;
@Slf4j
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@Getter
@Accessors(fluent = true)
public class DefaultFluxCapacitor implements FluxCapacitor {
private final Map<MessageType, ? extends Tracking> trackingSupplier;
private final CommandGateway commandGateway;
private final QueryGateway queryGateway;
private final EventGateway eventGateway;
private final ResultGateway resultGateway;
private final ErrorGateway errorGateway;
private final MetricsGateway metricsGateway;
private final AggregateRepository aggregateRepository;
private final EventStore eventStore;
private final KeyValueStore keyValueStore;
private final Scheduler scheduler;
private final UserProvider userProvider;
private final Cache cache;
private final Serializer serializer;
private final AtomicReference<Clock> clock = new AtomicReference<>(Clock.systemUTC());
private final Client client;
private final Runnable shutdownHandler;
private final AtomicBoolean closed = new AtomicBoolean();
private final Collection<Runnable> cleanupTasks = new CopyOnWriteArrayList<>();
public static Builder builder() {
return new Builder();
}
@Override
public Tracking tracking(MessageType messageType) {
return Optional.ofNullable(trackingSupplier.get(messageType)).orElseThrow(
() -> new TrackingException(String.format("Tracking is not supported for type %s", messageType)));
}
@Override
public void withClock(@NonNull Clock clock) {
this.clock.set(clock);
}
public Clock clock() {
return clock.get();
}
@Override
public Registration beforeShutdown(Runnable task) {
cleanupTasks.add(task);
return () -> cleanupTasks.remove(task);
}
@Override
public void close() {
if (closed.compareAndSet(false, true)) {
log.info("Initiating controlled shutdown");
cleanupTasks.forEach(ClientUtils::tryRun);
shutdownHandler.run();
if (FluxCapacitor.applicationInstance.get() == this) {
FluxCapacitor.applicationInstance.set(null);
}
log.info("Completed shutdown");
}
}
public static class Builder implements FluxCapacitorBuilder {
private Serializer serializer = new JacksonSerializer();
private Serializer snapshotSerializer = serializer;
private final Map<MessageType, List<ConsumerConfiguration>> consumerConfigurations = defaultConfigurations();
private final List<ParameterResolver<? super DeserializingMessage>> parameterResolvers =
new ArrayList<>(defaultParameterResolvers);
private final Map<MessageType, DispatchInterceptor> dispatchInterceptors =
Arrays.stream(MessageType.values()).collect(toMap(identity(), m -> (f, messageType) -> f));
private final Map<MessageType, HandlerInterceptor> handlerInterceptors =
Arrays.stream(MessageType.values()).collect(toMap(identity(), m -> (f, h, c) -> f));
private final Map<MessageType, List<BatchInterceptor>> batchInterceptors = new HashMap<>();
private DispatchInterceptor messageRoutingInterceptor = new MessageRoutingInterceptor();
private SchedulingInterceptor schedulingInterceptor = new SchedulingInterceptor();
private Cache cache = new DefaultCache();
private boolean disableErrorReporting;
private boolean disableMessageCorrelation;
private boolean disablePayloadValidation;
private boolean disableDataProtection;
private boolean disableAutomaticAggregateCaching;
private boolean disableShutdownHook;
private boolean collectTrackingMetrics;
private boolean makeApplicationInstance;
private UserProvider userProvider = UserProvider.defaultUserSupplier;
protected Map<MessageType, List<ConsumerConfiguration>> defaultConfigurations() {
return unmodifiableMap(stream(MessageType.values()).collect(toMap(identity(), messageType ->
new ArrayList<>(singletonList(ConsumerConfiguration.getDefault(messageType))))));
}
@Override
public Builder replaceSerializer(@NonNull Serializer serializer) {
if (snapshotSerializer == this.serializer) {
snapshotSerializer = serializer;
}
this.serializer = serializer;
return this;
}
@Override
public Builder replaceSnapshotSerializer(@NonNull Serializer serializer) {
this.snapshotSerializer = serializer;
return this;
}
@Override
public FluxCapacitorBuilder registerUserSupplier(UserProvider userProvider) {
this.userProvider = userProvider;
return this;
}
@Override
public Builder configureDefaultConsumer(@NonNull MessageType messageType,
@NonNull UnaryOperator<ConsumerConfiguration> updateFunction) {
List<ConsumerConfiguration> configurations = consumerConfigurations.get(messageType);
ConsumerConfiguration defaultConfiguration = configurations.get(configurations.size() - 1);
ConsumerConfiguration updatedConfiguration = updateFunction.apply(defaultConfiguration);
if (configurations.subList(0, configurations.size() - 1).stream()
.map(ConsumerConfiguration::getName)
.anyMatch(n -> Objects.equals(n, updatedConfiguration.getName()))) {
throw new IllegalArgumentException(
format("Consumer name %s is already in use", updatedConfiguration.getName()));
}
configurations.set(configurations.size() - 1, updatedConfiguration);
return this;
}
@Override
public Builder addConsumerConfiguration(@NonNull ConsumerConfiguration consumerConfiguration) {
List<ConsumerConfiguration> configurations =
consumerConfigurations.get(consumerConfiguration.getMessageType());
if (configurations.stream().map(ConsumerConfiguration::getName)
.anyMatch(n -> Objects.equals(n, consumerConfiguration.getName()))) {
throw new IllegalArgumentException(
format("Consumer name %s is already in use", consumerConfiguration.getName()));
}
configurations.add(configurations.size() - 1, consumerConfiguration);
return this;
}
@Override
public FluxCapacitorBuilder addBatchInterceptor(BatchInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> batchInterceptors.computeIfAbsent(type, t -> new ArrayList<>()).add(interceptor));
return this;
}
@Override
public Builder addDispatchInterceptor(@NonNull DispatchInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor)));
return this;
}
@Override
public Builder addHandlerInterceptor(@NonNull HandlerInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor)));
return this;
}
@Override
public Builder replaceMessageRoutingInterceptor(@NonNull DispatchInterceptor messageRoutingInterceptor) {
this.messageRoutingInterceptor = messageRoutingInterceptor;
return this;
}
@Override
public FluxCapacitorBuilder replaceCache(@NonNull Cache cache) {
this.cache = cache;
return this;
}
@Override
public FluxCapacitorBuilder withAggregateCache(Class<?> aggregateType, Cache cache) {
this.cache = new SelectiveCache(cache, SelectiveCache.aggregateSelector(aggregateType), this.cache);
return this;
}
@Override
public Builder addParameterResolver(@NonNull ParameterResolver<DeserializingMessage> parameterResolver) {
parameterResolvers.add(parameterResolver);
return this;
}
@Override
public FluxCapacitorBuilder disableErrorReporting() {
disableErrorReporting = true;
return this;
}
@Override
public FluxCapacitorBuilder disableShutdownHook() {
disableShutdownHook = true;
return this;
}
@Override
public Builder disableMessageCorrelation() {
disableMessageCorrelation = true;
return this;
}
@Override
public Builder disablePayloadValidation() {
disablePayloadValidation = true;
return this;
}
@Override
public FluxCapacitorBuilder disableDataProtection() {
disableDataProtection = true;
return this;
}
@Override
public FluxCapacitorBuilder disableAutomaticAggregateCaching() {
disableAutomaticAggregateCaching = true;
return this;
}
@Override
public FluxCapacitorBuilder enableTrackingMetrics() {
collectTrackingMetrics = true;
return this;
}
@Override
public FluxCapacitorBuilder makeApplicationInstance(boolean makeApplicationInstance) {
this.makeApplicationInstance = makeApplicationInstance;
return this;
}
@Override
public FluxCapacitor build(@NonNull Client client) {
Map<MessageType, DispatchInterceptor> dispatchInterceptors = new HashMap<>(this.dispatchInterceptors);
Map<MessageType, HandlerInterceptor> handlerInterceptors = new HashMap<>(this.handlerInterceptors);
Map<MessageType, List<BatchInterceptor>> batchInterceptors = new HashMap<>(this.batchInterceptors);
Map<MessageType, List<ConsumerConfiguration>> consumerConfigurations =
new HashMap<>(this.consumerConfigurations);
KeyValueStore keyValueStore = new DefaultKeyValueStore(client.getKeyValueClient(), serializer);
//enable message routing
Arrays.stream(MessageType.values()).forEach(
type -> dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(messageRoutingInterceptor)));
//enable authentication
if (userProvider != null) {
AuthenticatingInterceptor interceptor = new AuthenticatingInterceptor(userProvider);
Stream.of(COMMAND, QUERY, SCHEDULE).forEach(type -> {
dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
});
}
//enable data protection
if (!disableDataProtection) {
DataProtectionInterceptor interceptor = new DataProtectionInterceptor(keyValueStore, serializer);
Stream.of(COMMAND, EVENT, QUERY, RESULT, SCHEDULE).forEach(type -> {
dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
});
}
//enable message correlation
if (!disableMessageCorrelation) {
CorrelatingInterceptor correlatingInterceptor = new CorrelatingInterceptor();
Arrays.stream(MessageType.values()).forEach(
type -> dispatchInterceptors.compute(type, (t, i) -> correlatingInterceptor.merge(i)));
}
//enable command and query validation
if (!disablePayloadValidation) {
Stream.of(COMMAND, QUERY).forEach(type -> handlerInterceptors
.computeIfPresent(type, (t, i) -> i.merge(new ValidatingInterceptor())));
}
//enable scheduling interceptor
dispatchInterceptors.computeIfPresent(SCHEDULE, (t, i) -> i.merge(schedulingInterceptor));
handlerInterceptors.computeIfPresent(SCHEDULE, (t, i) -> i.merge(schedulingInterceptor));
//collect metrics about consumers and handlers
if (collectTrackingMetrics) {
BatchInterceptor batchInterceptor = new TrackerMonitor();
HandlerMonitor handlerMonitor = new HandlerMonitor();
Arrays.stream(MessageType.values()).forEach(type -> {
consumerConfigurations.computeIfPresent(type, (t, list) ->
t == METRICS ? list :
list.stream().map(c -> c.toBuilder().batchInterceptor(batchInterceptor).build())
.collect(toList()));
handlerInterceptors.compute(type, (t, i) -> t == METRICS ? i : handlerMonitor.merge(i));
});
}
//event sourcing
EventSourcingHandlerFactory eventSourcingHandlerFactory =
new DefaultEventSourcingHandlerFactory(parameterResolvers);
EventStoreSerializer eventStoreSerializer = new EventStoreSerializer(this.serializer,
dispatchInterceptors.get(EVENT));
EventStore eventStore = new DefaultEventStore(client.getEventStoreClient(),
eventStoreSerializer,
localHandlerRegistry(EVENT, handlerInterceptors));
DefaultSnapshotRepository snapshotRepository =
new DefaultSnapshotRepository(client.getKeyValueClient(), snapshotSerializer);
AggregateRepository aggregateRepository = new CompositeAggregateRepository(
new EventSourcingRepository(eventStore, snapshotRepository, cache, eventStoreSerializer,
eventSourcingHandlerFactory));
if (!disableAutomaticAggregateCaching) {
aggregateRepository =
new CachingAggregateRepository(aggregateRepository, eventSourcingHandlerFactory, cache,
client, this.serializer);
}
//enable error reporter as the outermost handler interceptor
ErrorGateway errorGateway =
new DefaultErrorGateway(client.getGatewayClient(ERROR),
messageSerializer(ERROR, dispatchInterceptors),
localHandlerRegistry(ERROR, handlerInterceptors));
if (!disableErrorReporting) {
ErrorReportingInterceptor interceptor = new ErrorReportingInterceptor(errorGateway);
Arrays.stream(MessageType.values())
.forEach(type -> handlerInterceptors.compute(type, (t, i) -> interceptor.merge(i)));
}
//create gateways
ResultGateway resultGateway =
new DefaultResultGateway(client.getGatewayClient(RESULT),
messageSerializer(RESULT, dispatchInterceptors));
RequestHandler requestHandler = new DefaultRequestHandler(this.serializer, client);
CommandGateway commandGateway =
new DefaultCommandGateway(createRequestGateway(client, COMMAND, requestHandler,
dispatchInterceptors, handlerInterceptors));
QueryGateway queryGateway =
new DefaultQueryGateway(createRequestGateway(client, QUERY, requestHandler,
dispatchInterceptors, handlerInterceptors));
EventGateway eventGateway =
new DefaultEventGateway(client.getGatewayClient(EVENT),
messageSerializer(EVENT, dispatchInterceptors),
localHandlerRegistry(EVENT, handlerInterceptors));
MetricsGateway metricsGateway =
new DefaultMetricsGateway(client.getGatewayClient(METRICS),
messageSerializer(METRICS, dispatchInterceptors));
//tracking
batchInterceptors.forEach((type, interceptors) -> consumerConfigurations.computeIfPresent(
type, (t, configs) -> configs.stream().map(
c -> c.toBuilder().batchInterceptors(interceptors).build()).collect(toList())));
Map<MessageType, Tracking> trackingMap = stream(MessageType.values())
.collect(toMap(identity(), m -> new DefaultTracking(m, client, resultGateway,
consumerConfigurations.get(m), this.serializer,
new DefaultHandlerFactory(m, handlerInterceptors
.get(m == NOTIFICATION ? EVENT : m),
parameterResolvers))));
//misc
Scheduler scheduler = new DefaultScheduler(client.getSchedulingClient(),
messageSerializer(SCHEDULE, dispatchInterceptors),
localHandlerRegistry(SCHEDULE, handlerInterceptors));
Runnable shutdownHandler = () -> {
ForkJoinPool.commonPool().invokeAll(trackingMap.values().stream().map(t -> (Callable<?>) () -> {
t.close();
return null;
}).collect(toList()));
requestHandler.close();
client.shutDown();
};
//and finally...
FluxCapacitor fluxCapacitor = doBuild(trackingMap, commandGateway, queryGateway, eventGateway,
resultGateway, errorGateway, metricsGateway, aggregateRepository,
eventStore, keyValueStore, scheduler, userProvider,
cache, serializer, client, shutdownHandler);
if (makeApplicationInstance) {
FluxCapacitor.applicationInstance.set(fluxCapacitor);
}
//perform a controlled shutdown when the vm exits
if (!disableShutdownHook) {
getRuntime().addShutdownHook(new Thread(fluxCapacitor::close));
}
return fluxCapacitor;
}
protected FluxCapacitor doBuild(Map<MessageType, ? extends Tracking> trackingSupplier,
CommandGateway commandGateway, QueryGateway queryGateway,
EventGateway eventGateway, ResultGateway resultGateway,
ErrorGateway errorGateway, MetricsGateway metricsGateway,
AggregateRepository aggregateRepository,
EventStore eventStore, KeyValueStore keyValueStore, Scheduler scheduler,
UserProvider userProvider, Cache cache, Serializer serializer, Client client,
Runnable shutdownHandler) {
return new DefaultFluxCapacitor(trackingSupplier, commandGateway, queryGateway, eventGateway, resultGateway,
errorGateway, metricsGateway, aggregateRepository, eventStore,
keyValueStore, scheduler, userProvider, cache, serializer, client, shutdownHandler);
}
protected GenericGateway createRequestGateway(Client client, MessageType messageType,
RequestHandler requestHandler,
Map<MessageType, DispatchInterceptor> dispatchInterceptors,
Map<MessageType, HandlerInterceptor> handlerInterceptors) {
return new DefaultGenericGateway(client.getGatewayClient(messageType), requestHandler,
messageSerializer(messageType, dispatchInterceptors),
localHandlerRegistry(messageType, handlerInterceptors));
}
protected MessageSerializer messageSerializer(MessageType messageType,
Map<MessageType, DispatchInterceptor> dispatchInterceptors) {
return new MessageSerializer(this.serializer, dispatchInterceptors.get(messageType), messageType);
}
protected HandlerRegistry localHandlerRegistry(MessageType messageType,
Map<MessageType, HandlerInterceptor> handlerInterceptors) {
return new LocalHandlerRegistry(messageType,
new DefaultHandlerFactory(messageType, handlerInterceptors.get(messageType),
parameterResolvers));
}
}
}
| java-client/src/main/java/io/fluxcapacitor/javaclient/configuration/DefaultFluxCapacitor.java | /*
* Copyright (c) 2016-2021 Flux Capacitor.
*
* 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.fluxcapacitor.javaclient.configuration;
import io.fluxcapacitor.common.MessageType;
import io.fluxcapacitor.common.Registration;
import io.fluxcapacitor.common.handling.ParameterResolver;
import io.fluxcapacitor.javaclient.FluxCapacitor;
import io.fluxcapacitor.javaclient.common.ClientUtils;
import io.fluxcapacitor.javaclient.common.serialization.DeserializingMessage;
import io.fluxcapacitor.javaclient.common.serialization.MessageSerializer;
import io.fluxcapacitor.javaclient.common.serialization.Serializer;
import io.fluxcapacitor.javaclient.common.serialization.jackson.JacksonSerializer;
import io.fluxcapacitor.javaclient.configuration.client.Client;
import io.fluxcapacitor.javaclient.modeling.AggregateRepository;
import io.fluxcapacitor.javaclient.modeling.CompositeAggregateRepository;
import io.fluxcapacitor.javaclient.persisting.caching.Cache;
import io.fluxcapacitor.javaclient.persisting.caching.CachingAggregateRepository;
import io.fluxcapacitor.javaclient.persisting.caching.DefaultCache;
import io.fluxcapacitor.javaclient.persisting.caching.SelectiveCache;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultEventSourcingHandlerFactory;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultEventStore;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.DefaultSnapshotRepository;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventSourcingHandlerFactory;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventSourcingRepository;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventStore;
import io.fluxcapacitor.javaclient.persisting.eventsourcing.EventStoreSerializer;
import io.fluxcapacitor.javaclient.persisting.keyvalue.DefaultKeyValueStore;
import io.fluxcapacitor.javaclient.persisting.keyvalue.KeyValueStore;
import io.fluxcapacitor.javaclient.publishing.CommandGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultCommandGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultErrorGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultEventGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultGenericGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultMetricsGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultQueryGateway;
import io.fluxcapacitor.javaclient.publishing.DefaultRequestHandler;
import io.fluxcapacitor.javaclient.publishing.DefaultResultGateway;
import io.fluxcapacitor.javaclient.publishing.DispatchInterceptor;
import io.fluxcapacitor.javaclient.publishing.ErrorGateway;
import io.fluxcapacitor.javaclient.publishing.EventGateway;
import io.fluxcapacitor.javaclient.publishing.GenericGateway;
import io.fluxcapacitor.javaclient.publishing.MetricsGateway;
import io.fluxcapacitor.javaclient.publishing.QueryGateway;
import io.fluxcapacitor.javaclient.publishing.RequestHandler;
import io.fluxcapacitor.javaclient.publishing.ResultGateway;
import io.fluxcapacitor.javaclient.publishing.correlation.CorrelatingInterceptor;
import io.fluxcapacitor.javaclient.publishing.dataprotection.DataProtectionInterceptor;
import io.fluxcapacitor.javaclient.publishing.routing.MessageRoutingInterceptor;
import io.fluxcapacitor.javaclient.scheduling.DefaultScheduler;
import io.fluxcapacitor.javaclient.scheduling.Scheduler;
import io.fluxcapacitor.javaclient.scheduling.SchedulingInterceptor;
import io.fluxcapacitor.javaclient.tracking.BatchInterceptor;
import io.fluxcapacitor.javaclient.tracking.ConsumerConfiguration;
import io.fluxcapacitor.javaclient.tracking.DefaultTracking;
import io.fluxcapacitor.javaclient.tracking.Tracking;
import io.fluxcapacitor.javaclient.tracking.TrackingException;
import io.fluxcapacitor.javaclient.tracking.handling.DefaultHandlerFactory;
import io.fluxcapacitor.javaclient.tracking.handling.HandlerInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.HandlerRegistry;
import io.fluxcapacitor.javaclient.tracking.handling.LocalHandlerRegistry;
import io.fluxcapacitor.javaclient.tracking.handling.authentication.AuthenticatingInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.authentication.UserProvider;
import io.fluxcapacitor.javaclient.tracking.handling.errorreporting.ErrorReportingInterceptor;
import io.fluxcapacitor.javaclient.tracking.handling.validation.ValidatingInterceptor;
import io.fluxcapacitor.javaclient.tracking.metrics.HandlerMonitor;
import io.fluxcapacitor.javaclient.tracking.metrics.TrackerMonitor;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;
import lombok.experimental.Accessors;
import lombok.extern.slf4j.Slf4j;
import java.time.Clock;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.concurrent.Callable;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.UnaryOperator;
import java.util.stream.Stream;
import static io.fluxcapacitor.common.MessageType.COMMAND;
import static io.fluxcapacitor.common.MessageType.ERROR;
import static io.fluxcapacitor.common.MessageType.EVENT;
import static io.fluxcapacitor.common.MessageType.METRICS;
import static io.fluxcapacitor.common.MessageType.NOTIFICATION;
import static io.fluxcapacitor.common.MessageType.QUERY;
import static io.fluxcapacitor.common.MessageType.RESULT;
import static io.fluxcapacitor.common.MessageType.SCHEDULE;
import static io.fluxcapacitor.javaclient.common.serialization.DeserializingMessage.defaultParameterResolvers;
import static java.lang.Runtime.getRuntime;
import static java.lang.String.format;
import static java.util.Arrays.stream;
import static java.util.Collections.singletonList;
import static java.util.Collections.unmodifiableMap;
import static java.util.function.Function.identity;
import static java.util.stream.Collectors.toList;
import static java.util.stream.Collectors.toMap;
@Slf4j
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@Getter
@Accessors(fluent = true)
public class DefaultFluxCapacitor implements FluxCapacitor {
private final Map<MessageType, ? extends Tracking> trackingSupplier;
private final CommandGateway commandGateway;
private final QueryGateway queryGateway;
private final EventGateway eventGateway;
private final ResultGateway resultGateway;
private final ErrorGateway errorGateway;
private final MetricsGateway metricsGateway;
private final AggregateRepository aggregateRepository;
private final EventStore eventStore;
private final KeyValueStore keyValueStore;
private final Scheduler scheduler;
private final UserProvider userProvider;
private final Cache cache;
private final Serializer serializer;
private final AtomicReference<Clock> clock = new AtomicReference<>(Clock.systemUTC());
private final Client client;
private final Runnable shutdownHandler;
private final AtomicBoolean closed = new AtomicBoolean();
private final Collection<Runnable> cleanupTasks = new CopyOnWriteArrayList<>();
public static Builder builder() {
return new Builder();
}
@Override
public Tracking tracking(MessageType messageType) {
return Optional.ofNullable(trackingSupplier.get(messageType)).orElseThrow(
() -> new TrackingException(String.format("Tracking is not supported for type %s", messageType)));
}
@Override
public void withClock(@NonNull Clock clock) {
this.clock.set(clock);
}
public Clock clock() {
return clock.get();
}
@Override
public Registration beforeShutdown(Runnable task) {
cleanupTasks.add(task);
return () -> cleanupTasks.remove(task);
}
@Override
public void close() {
if (closed.compareAndSet(false, true)) {
log.info("Initiating controlled shutdown");
cleanupTasks.forEach(ClientUtils::tryRun);
shutdownHandler.run();
if (FluxCapacitor.applicationInstance.get() == this) {
FluxCapacitor.applicationInstance.set(null);
}
log.info("Completed shutdown");
}
}
public static class Builder implements FluxCapacitorBuilder {
private Serializer serializer = new JacksonSerializer();
private Serializer snapshotSerializer = serializer;
private final Map<MessageType, List<ConsumerConfiguration>> consumerConfigurations = defaultConfigurations();
private final List<ParameterResolver<? super DeserializingMessage>> parameterResolvers =
new ArrayList<>(defaultParameterResolvers);
private final Map<MessageType, DispatchInterceptor> dispatchInterceptors =
Arrays.stream(MessageType.values()).collect(toMap(identity(), m -> (f, messageType) -> f));
private final Map<MessageType, HandlerInterceptor> handlerInterceptors =
Arrays.stream(MessageType.values()).collect(toMap(identity(), m -> (f, h, c) -> f));
private final Map<MessageType, List<BatchInterceptor>> batchInterceptors = new HashMap<>();
private DispatchInterceptor messageRoutingInterceptor = new MessageRoutingInterceptor();
private SchedulingInterceptor schedulingInterceptor = new SchedulingInterceptor();
private Cache cache = new DefaultCache();
private boolean disableErrorReporting;
private boolean disableMessageCorrelation;
private boolean disablePayloadValidation;
private boolean disableDataProtection;
private boolean disableAutomaticAggregateCaching;
private boolean disableShutdownHook;
private boolean collectTrackingMetrics;
private boolean makeApplicationInstance;
private UserProvider userProvider = UserProvider.defaultUserSupplier;
protected Map<MessageType, List<ConsumerConfiguration>> defaultConfigurations() {
return unmodifiableMap(stream(MessageType.values()).collect(toMap(identity(), messageType ->
new ArrayList<>(singletonList(ConsumerConfiguration.getDefault(messageType))))));
}
@Override
public Builder replaceSerializer(@NonNull Serializer serializer) {
if (snapshotSerializer == this.serializer) {
snapshotSerializer = serializer;
}
this.serializer = serializer;
return this;
}
@Override
public Builder replaceSnapshotSerializer(@NonNull Serializer serializer) {
this.snapshotSerializer = serializer;
return this;
}
@Override
public FluxCapacitorBuilder registerUserSupplier(UserProvider userProvider) {
this.userProvider = userProvider;
return this;
}
@Override
public Builder configureDefaultConsumer(@NonNull MessageType messageType,
@NonNull UnaryOperator<ConsumerConfiguration> updateFunction) {
List<ConsumerConfiguration> configurations = consumerConfigurations.get(messageType);
ConsumerConfiguration defaultConfiguration = configurations.get(configurations.size() - 1);
ConsumerConfiguration updatedConfiguration = updateFunction.apply(defaultConfiguration);
if (configurations.subList(0, configurations.size() - 1).stream()
.map(ConsumerConfiguration::getName)
.anyMatch(n -> Objects.equals(n, updatedConfiguration.getName()))) {
throw new IllegalArgumentException(
format("Consumer name %s is already in use", updatedConfiguration.getName()));
}
configurations.set(configurations.size() - 1, updatedConfiguration);
return this;
}
@Override
public Builder addConsumerConfiguration(@NonNull ConsumerConfiguration consumerConfiguration) {
List<ConsumerConfiguration> configurations =
consumerConfigurations.get(consumerConfiguration.getMessageType());
if (configurations.stream().map(ConsumerConfiguration::getName)
.anyMatch(n -> Objects.equals(n, consumerConfiguration.getName()))) {
throw new IllegalArgumentException(
format("Consumer name %s is already in use", consumerConfiguration.getName()));
}
configurations.add(configurations.size() - 1, consumerConfiguration);
return this;
}
@Override
public FluxCapacitorBuilder addBatchInterceptor(BatchInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> batchInterceptors.computeIfAbsent(type, t -> new ArrayList<>()).add(interceptor));
return this;
}
@Override
public Builder addDispatchInterceptor(@NonNull DispatchInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor)));
return this;
}
@Override
public Builder addHandlerInterceptor(@NonNull HandlerInterceptor interceptor, MessageType... forTypes) {
Arrays.stream(forTypes.length == 0 ? MessageType.values() : forTypes)
.forEach(type -> handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor)));
return this;
}
@Override
public Builder replaceMessageRoutingInterceptor(@NonNull DispatchInterceptor messageRoutingInterceptor) {
this.messageRoutingInterceptor = messageRoutingInterceptor;
return this;
}
@Override
public FluxCapacitorBuilder replaceCache(@NonNull Cache cache) {
this.cache = cache;
return this;
}
@Override
public FluxCapacitorBuilder withAggregateCache(Class<?> aggregateType, Cache cache) {
this.cache = new SelectiveCache(cache, SelectiveCache.aggregateSelector(aggregateType), this.cache);
return this;
}
@Override
public Builder addParameterResolver(@NonNull ParameterResolver<DeserializingMessage> parameterResolver) {
parameterResolvers.add(parameterResolver);
return this;
}
@Override
public FluxCapacitorBuilder disableErrorReporting() {
disableErrorReporting = true;
return this;
}
@Override
public FluxCapacitorBuilder disableShutdownHook() {
disableShutdownHook = true;
return this;
}
@Override
public Builder disableMessageCorrelation() {
disableMessageCorrelation = true;
return this;
}
@Override
public Builder disablePayloadValidation() {
disablePayloadValidation = true;
return this;
}
@Override
public FluxCapacitorBuilder disableDataProtection() {
disableDataProtection = true;
return this;
}
@Override
public FluxCapacitorBuilder disableAutomaticAggregateCaching() {
disableAutomaticAggregateCaching = true;
return this;
}
@Override
public FluxCapacitorBuilder enableTrackingMetrics() {
collectTrackingMetrics = true;
return this;
}
@Override
public FluxCapacitorBuilder makeApplicationInstance(boolean makeApplicationInstance) {
this.makeApplicationInstance = makeApplicationInstance;
return this;
}
@Override
public FluxCapacitor build(@NonNull Client client) {
Map<MessageType, DispatchInterceptor> dispatchInterceptors = new HashMap<>(this.dispatchInterceptors);
Map<MessageType, HandlerInterceptor> handlerInterceptors = new HashMap<>(this.handlerInterceptors);
Map<MessageType, List<BatchInterceptor>> batchInterceptors = new HashMap<>(this.batchInterceptors);
Map<MessageType, List<ConsumerConfiguration>> consumerConfigurations =
new HashMap<>(this.consumerConfigurations);
KeyValueStore keyValueStore = new DefaultKeyValueStore(client.getKeyValueClient(), serializer);
//enable message routing
Arrays.stream(MessageType.values()).forEach(
type -> dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(messageRoutingInterceptor)));
//enable authentication
if (userProvider != null) {
AuthenticatingInterceptor interceptor = new AuthenticatingInterceptor(userProvider);
Stream.of(COMMAND, QUERY, EVENT, SCHEDULE).forEach(type -> {
dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
});
}
//enable data protection
if (!disableDataProtection) {
DataProtectionInterceptor interceptor = new DataProtectionInterceptor(keyValueStore, serializer);
Stream.of(COMMAND, EVENT, QUERY, RESULT, SCHEDULE).forEach(type -> {
dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
});
}
//enable message correlation
if (!disableMessageCorrelation) {
CorrelatingInterceptor correlatingInterceptor = new CorrelatingInterceptor();
Arrays.stream(MessageType.values()).forEach(
type -> dispatchInterceptors.compute(type, (t, i) -> correlatingInterceptor.merge(i)));
}
//enable command and query validation
if (!disablePayloadValidation) {
Stream.of(COMMAND, QUERY).forEach(type -> handlerInterceptors
.computeIfPresent(type, (t, i) -> i.merge(new ValidatingInterceptor())));
}
//enable scheduling interceptor
dispatchInterceptors.computeIfPresent(SCHEDULE, (t, i) -> i.merge(schedulingInterceptor));
handlerInterceptors.computeIfPresent(SCHEDULE, (t, i) -> i.merge(schedulingInterceptor));
//collect metrics about consumers and handlers
if (collectTrackingMetrics) {
BatchInterceptor batchInterceptor = new TrackerMonitor();
HandlerMonitor handlerMonitor = new HandlerMonitor();
Arrays.stream(MessageType.values()).forEach(type -> {
consumerConfigurations.computeIfPresent(type, (t, list) ->
t == METRICS ? list :
list.stream().map(c -> c.toBuilder().batchInterceptor(batchInterceptor).build())
.collect(toList()));
handlerInterceptors.compute(type, (t, i) -> t == METRICS ? i : handlerMonitor.merge(i));
});
}
//event sourcing
EventSourcingHandlerFactory eventSourcingHandlerFactory =
new DefaultEventSourcingHandlerFactory(parameterResolvers);
EventStoreSerializer eventStoreSerializer = new EventStoreSerializer(this.serializer,
dispatchInterceptors.get(EVENT));
EventStore eventStore = new DefaultEventStore(client.getEventStoreClient(),
eventStoreSerializer,
localHandlerRegistry(EVENT, handlerInterceptors));
DefaultSnapshotRepository snapshotRepository =
new DefaultSnapshotRepository(client.getKeyValueClient(), snapshotSerializer);
AggregateRepository aggregateRepository = new CompositeAggregateRepository(
new EventSourcingRepository(eventStore, snapshotRepository, cache, eventStoreSerializer,
eventSourcingHandlerFactory));
if (!disableAutomaticAggregateCaching) {
aggregateRepository =
new CachingAggregateRepository(aggregateRepository, eventSourcingHandlerFactory, cache,
client, this.serializer);
}
//enable error reporter as the outermost handler interceptor
ErrorGateway errorGateway =
new DefaultErrorGateway(client.getGatewayClient(ERROR),
messageSerializer(ERROR, dispatchInterceptors),
localHandlerRegistry(ERROR, handlerInterceptors));
if (!disableErrorReporting) {
ErrorReportingInterceptor interceptor = new ErrorReportingInterceptor(errorGateway);
Arrays.stream(MessageType.values())
.forEach(type -> handlerInterceptors.compute(type, (t, i) -> interceptor.merge(i)));
}
//create gateways
ResultGateway resultGateway =
new DefaultResultGateway(client.getGatewayClient(RESULT),
messageSerializer(RESULT, dispatchInterceptors));
RequestHandler requestHandler = new DefaultRequestHandler(this.serializer, client);
CommandGateway commandGateway =
new DefaultCommandGateway(createRequestGateway(client, COMMAND, requestHandler,
dispatchInterceptors, handlerInterceptors));
QueryGateway queryGateway =
new DefaultQueryGateway(createRequestGateway(client, QUERY, requestHandler,
dispatchInterceptors, handlerInterceptors));
EventGateway eventGateway =
new DefaultEventGateway(client.getGatewayClient(EVENT),
messageSerializer(EVENT, dispatchInterceptors),
localHandlerRegistry(EVENT, handlerInterceptors));
MetricsGateway metricsGateway =
new DefaultMetricsGateway(client.getGatewayClient(METRICS),
messageSerializer(METRICS, dispatchInterceptors));
//tracking
batchInterceptors.forEach((type, interceptors) -> consumerConfigurations.computeIfPresent(
type, (t, configs) -> configs.stream().map(
c -> c.toBuilder().batchInterceptors(interceptors).build()).collect(toList())));
Map<MessageType, Tracking> trackingMap = stream(MessageType.values())
.collect(toMap(identity(), m -> new DefaultTracking(m, client, resultGateway,
consumerConfigurations.get(m), this.serializer,
new DefaultHandlerFactory(m, handlerInterceptors
.get(m == NOTIFICATION ? EVENT : m),
parameterResolvers))));
//misc
Scheduler scheduler = new DefaultScheduler(client.getSchedulingClient(),
messageSerializer(SCHEDULE, dispatchInterceptors),
localHandlerRegistry(SCHEDULE, handlerInterceptors));
Runnable shutdownHandler = () -> {
ForkJoinPool.commonPool().invokeAll(trackingMap.values().stream().map(t -> (Callable<?>) () -> {
t.close();
return null;
}).collect(toList()));
requestHandler.close();
client.shutDown();
};
//and finally...
FluxCapacitor fluxCapacitor = doBuild(trackingMap, commandGateway, queryGateway, eventGateway,
resultGateway, errorGateway, metricsGateway, aggregateRepository,
eventStore, keyValueStore, scheduler, userProvider,
cache, serializer, client, shutdownHandler);
if (makeApplicationInstance) {
FluxCapacitor.applicationInstance.set(fluxCapacitor);
}
//perform a controlled shutdown when the vm exits
if (!disableShutdownHook) {
getRuntime().addShutdownHook(new Thread(fluxCapacitor::close));
}
return fluxCapacitor;
}
protected FluxCapacitor doBuild(Map<MessageType, ? extends Tracking> trackingSupplier,
CommandGateway commandGateway, QueryGateway queryGateway,
EventGateway eventGateway, ResultGateway resultGateway,
ErrorGateway errorGateway, MetricsGateway metricsGateway,
AggregateRepository aggregateRepository,
EventStore eventStore, KeyValueStore keyValueStore, Scheduler scheduler,
UserProvider userProvider, Cache cache, Serializer serializer, Client client,
Runnable shutdownHandler) {
return new DefaultFluxCapacitor(trackingSupplier, commandGateway, queryGateway, eventGateway, resultGateway,
errorGateway, metricsGateway, aggregateRepository, eventStore,
keyValueStore, scheduler, userProvider, cache, serializer, client, shutdownHandler);
}
protected GenericGateway createRequestGateway(Client client, MessageType messageType,
RequestHandler requestHandler,
Map<MessageType, DispatchInterceptor> dispatchInterceptors,
Map<MessageType, HandlerInterceptor> handlerInterceptors) {
return new DefaultGenericGateway(client.getGatewayClient(messageType), requestHandler,
messageSerializer(messageType, dispatchInterceptors),
localHandlerRegistry(messageType, handlerInterceptors));
}
protected MessageSerializer messageSerializer(MessageType messageType,
Map<MessageType, DispatchInterceptor> dispatchInterceptors) {
return new MessageSerializer(this.serializer, dispatchInterceptors.get(messageType), messageType);
}
protected HandlerRegistry localHandlerRegistry(MessageType messageType,
Map<MessageType, HandlerInterceptor> handlerInterceptors) {
return new LocalHandlerRegistry(messageType,
new DefaultHandlerFactory(messageType, handlerInterceptors.get(messageType),
parameterResolvers));
}
}
}
| Don't check authorisations of user when handling events
| java-client/src/main/java/io/fluxcapacitor/javaclient/configuration/DefaultFluxCapacitor.java | Don't check authorisations of user when handling events | <ide><path>ava-client/src/main/java/io/fluxcapacitor/javaclient/configuration/DefaultFluxCapacitor.java
<ide> //enable authentication
<ide> if (userProvider != null) {
<ide> AuthenticatingInterceptor interceptor = new AuthenticatingInterceptor(userProvider);
<del> Stream.of(COMMAND, QUERY, EVENT, SCHEDULE).forEach(type -> {
<add> Stream.of(COMMAND, QUERY, SCHEDULE).forEach(type -> {
<ide> dispatchInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
<ide> handlerInterceptors.computeIfPresent(type, (t, i) -> i.merge(interceptor));
<ide> }); |
|
Java | apache-2.0 | 6959671094ed77389ff898aafac17e89045529a9 | 0 | osgi/osgi,osgi/osgi,osgi/osgi,osgi/osgi,osgi/osgi,osgi/osgi,osgi/osgi,osgi/osgi | /*
* Copyright (c) OSGi Alliance (2011). All Rights Reserved.
*
* 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 org.osgi.service.tr069todmt;
import org.osgi.service.dmt.*;
/**
* This exception is defined in terms of applicable TR-069 fault codes. The
* TR-069 specification defines the fault codes that can occur in different
* situations.
*
*/
public class TR069Exception extends RuntimeException {
private static final long serialVersionUID = 1L;
final int faultCode;
final DmtException dmtException;
/**
* 9000 Method not supported
*/
final public static int METHOD_NOT_SUPPORTED = 9000;
/**
* 9001 Request denied (no reason specified
*/
final public static int REQUEST_DENIED = 9001;
/**
* 9002 Internal error
*/
final public static int INTERNAL_ERROR = 9002;
/**
* 9003 Invalid Arguments
*/
final public static int INVALID_ARGUMENTS = 9003;
/**
* 9004 Resources exceeded (when used in association with
* SetParameterValues, this MUST NOT be used to indicate parameters in
* error)
*/
final public static int RESOURCES_EXCEEDED = 9004;
/**
* 9005 Invalid parameter name (associated with Set/GetParameterValues,
* GetParameterNames, Set/GetParameterAttributes, AddObject, and
* DeleteObject)
*/
final public static int INVALID_PARAMETER_NAME = 9005;
/**
* 9006 Invalid parameter type (associated with SetParameterValues)
*/
final public static int INVALID_PARAMETER_TYPE = 9006;
/**
* 9007 Invalid parameter value (associated with SetParameterValues)
*/
final public static int INVALID_PARAMETER_VALUE = 9007;
/**
* 9008 Attempt to set a non-writable parameter (associated with
* SetParameterValues)
*/
final public static int NON_WRITABLE_PARAMETER = 9008;
/**
* 9009 Notification request rejected (associated with
* SetParameterAttributes method).
*/
final public static int NOTIFICATION_REJECTED = 9009;
/**
* A default constructor when only a message is known. This will generate a
* {@link #INTERNAL_ERROR} fault.
*
* @param message The message
*/
public TR069Exception(String message) {
this(message, 9002, null);
}
/**
* A Constructor with a message and a fault code.
*
* @param message The message
* @param faultCode The TR-069 defined fault code
* @param e
*/
public TR069Exception(String message, int faultCode, DmtException e) {
super(message, e);
this.faultCode = faultCode;
this.dmtException = e;
}
/**
* A Constructor with a message and a fault code.
*
* @param message The message
* @param faultCode The TR-069 defined fault code
*/
public TR069Exception(String message, int faultCode) {
this(message,faultCode,null);
}
/**
* Create a TR069Exception from a Dmt Exception.
*
* @param e The Dmt Exception
*/
public TR069Exception(DmtException e) {
super(e);
this.faultCode = getFaultCode(e);
this.dmtException = e;
}
private int getFaultCode(DmtException e) {
switch(e.getCode()) {
case DmtException.FEATURE_NOT_SUPPORTED:
case DmtException.COMMAND_NOT_ALLOWED:
case DmtException.SESSION_CREATION_TIMEOUT:
case DmtException.TRANSACTION_ERROR:
case DmtException.UNAUTHORIZED:
return REQUEST_DENIED;
case DmtException.INVALID_URI:
case DmtException.NODE_NOT_FOUND:
case DmtException.URI_TOO_LONG:
return INVALID_PARAMETER_NAME;
case DmtException.LIMIT_EXCEEDED:
return RESOURCES_EXCEEDED;
case DmtException.METADATA_MISMATCH:
return INVALID_PARAMETER_TYPE;
case DmtException.PERMISSION_DENIED:
return NON_WRITABLE_PARAMETER;
default:
return INTERNAL_ERROR;
}
}
/**
* Answer the associated TR-069 fault code.
*
* @return Answer the associated TR-069 fault code.
*/
public int getFaultCode() {
return faultCode;
}
/**
* @return the corresponding Dmt Exception
*/
public DmtException getDmtException() {
return dmtException;
}
}
| org.osgi.service.tr069todmt/src/org/osgi/service/tr069todmt/TR069Exception.java | /*
* Copyright (c) OSGi Alliance (2011). All Rights Reserved.
*
* 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 org.osgi.service.tr069todmt;
import org.osgi.service.dmt.*;
/**
* This exception is defined in terms of applicable TR-069 fault codes. The
* TR-069 specification defines the fault codes that can occur in different
* situations.
*
*/
public class TR069Exception extends RuntimeException {
private static final long serialVersionUID = 1L;
final int faultCode;
final DmtException dmtException;
/**
* 9000 Method not supported
*/
final public static int METHOD_NOT_SUPPORTED = 9000;
/**
* 9001 Request denied (no reason specified
*/
final public static int REQUEST_DENIED = 9001;
/**
* 9002 Internal error
*/
final public static int INTERNAL_ERROR = 9002;
/**
* 9003 Invalid Arguments
*/
final public static int INVALID_ARGUMENTS = 9003;
/**
* 9004 Resources exceeded (when used in association with
* SetParameterValues, this MUST NOT be used to indicate parameters in
* error)
*/
final public static int RESOURCES_EXCEEDED = 9004;
/**
* 9005 Invalid parameter name (associated with Set/GetParameterValues,
* GetParameterNames, Set/GetParameterAttributes, AddObject, and
* DeleteObject)
*/
final public static int INVALID_PARAMETER_NAME = 9005;
/**
* 9006 Invalid parameter type (associated with SetParameterValues)
*/
final public static int INVALID_PARAMETER_TYPE = 9006;
/**
* 9007 Invalid parameter value (associated with SetParameterValues)
*/
final public static int INVALID_PARAMETER_VALUE = 9007;
/**
* 9008 Attempt to set a non-writable parameter (associated with
* SetParameterValues)
*/
final public static int NON_WRITABLE_PARAMETER = 9008;
/**
* 9009 Notification request rejected (associated with
* SetParameterAttributes method).
*/
final public static int NOTIFICATION_REJECTED = 9009;
/**
* A default constructor when only a message is known. This will generate a
* {@link #INTERNAL_ERROR} fault.
*
* @param message The message
*/
public TR069Exception(String message) {
this(message, 9002, null);
}
/**
* A Constructor with a message and a fault code.
*
* @param message The message
* @param faultCode The TR-069 defined fault code
* @param e
*/
public TR069Exception(String message, int faultCode, DmtException e) {
super(message, e);
this.faultCode = faultCode;
this.dmtException = e;
}
/**
* A Constructor with a message and a fault code.
*
* @param message The message
* @param faultCode The TR-069 defined fault code
*/
public TR069Exception(String message, int faultCode) {
this(message,faultCode,null);
}
/**
* Create a TR069Exception from a Dmt Exception.
*
* @param e The Dmt Exception
*/
public TR069Exception(DmtException e) {
super(e);
this.faultCode = getFaultCode(e);
this.dmtException = e;
}
private int getFaultCode(DmtException e) {
switch(e.getCode()) {
case DmtException.FEATURE_NOT_SUPPORTED:
case DmtException.COMMAND_NOT_ALLOWED:
return REQUEST_DENIED;
case DmtException.INVALID_URI:
default:
return INTERNAL_ERROR; // Internal error
}
}
/**
* Answer the associated TR-069 fault code.
*
* @return Answer the associated TR-069 fault code.
*/
public int getFaultCode() {
return faultCode;
}
/**
* @return the corresponding Dmt Exception
*/
public DmtException getDmtException() {
return dmtException;
}
}
| Fix for Bug #2215: TR069Exception mapping issue
| org.osgi.service.tr069todmt/src/org/osgi/service/tr069todmt/TR069Exception.java | Fix for Bug #2215: TR069Exception mapping issue | <ide><path>rg.osgi.service.tr069todmt/src/org/osgi/service/tr069todmt/TR069Exception.java
<ide> switch(e.getCode()) {
<ide> case DmtException.FEATURE_NOT_SUPPORTED:
<ide> case DmtException.COMMAND_NOT_ALLOWED:
<add> case DmtException.SESSION_CREATION_TIMEOUT:
<add> case DmtException.TRANSACTION_ERROR:
<add> case DmtException.UNAUTHORIZED:
<ide> return REQUEST_DENIED;
<ide>
<ide> case DmtException.INVALID_URI:
<del>
<add> case DmtException.NODE_NOT_FOUND:
<add> case DmtException.URI_TOO_LONG:
<add> return INVALID_PARAMETER_NAME;
<add>
<add> case DmtException.LIMIT_EXCEEDED:
<add> return RESOURCES_EXCEEDED;
<add>
<add> case DmtException.METADATA_MISMATCH:
<add> return INVALID_PARAMETER_TYPE;
<add>
<add> case DmtException.PERMISSION_DENIED:
<add> return NON_WRITABLE_PARAMETER;
<add>
<ide> default:
<del> return INTERNAL_ERROR; // Internal error
<add> return INTERNAL_ERROR;
<ide> }
<ide> }
<ide> |
|
Java | mit | f5d2fccb0edee37538d579501cdaafca339a0649 | 0 | tedliang/osworkflow,tedliang/osworkflow,tedliang/osworkflow,tedliang/osworkflow | /*
* Copyright (c) 2002-2003 by OpenSymphony
* All rights reserved.
*/
package com.opensymphony.workflow;
import com.opensymphony.module.propertyset.PropertySet;
import com.opensymphony.module.propertyset.PropertySetManager;
import com.opensymphony.util.ClassLoaderUtil;
import com.opensymphony.util.TextUtils;
import com.opensymphony.workflow.config.Configuration;
import com.opensymphony.workflow.config.DefaultConfiguration;
import com.opensymphony.workflow.loader.*;
import com.opensymphony.workflow.query.WorkflowExpressionQuery;
import com.opensymphony.workflow.query.WorkflowQuery;
import com.opensymphony.workflow.spi.*;
import com.opensymphony.workflow.util.ScriptVariableParser;
import com.opensymphony.workflow.util.beanshell.BeanShellCondition;
import com.opensymphony.workflow.util.beanshell.BeanShellFunctionProvider;
import com.opensymphony.workflow.util.beanshell.BeanShellRegister;
import com.opensymphony.workflow.util.beanshell.BeanShellValidator;
import com.opensymphony.workflow.util.bsf.BSFCondition;
import com.opensymphony.workflow.util.bsf.BSFFunctionProvider;
import com.opensymphony.workflow.util.bsf.BSFRegister;
import com.opensymphony.workflow.util.bsf.BSFValidator;
import com.opensymphony.workflow.util.ejb.local.LocalEJBCondition;
import com.opensymphony.workflow.util.ejb.local.LocalEJBFunctionProvider;
import com.opensymphony.workflow.util.ejb.local.LocalEJBRegister;
import com.opensymphony.workflow.util.ejb.local.LocalEJBValidator;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBCondition;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBFunctionProvider;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBRegister;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBValidator;
import com.opensymphony.workflow.util.jndi.JNDICondition;
import com.opensymphony.workflow.util.jndi.JNDIFunctionProvider;
import com.opensymphony.workflow.util.jndi.JNDIRegister;
import com.opensymphony.workflow.util.jndi.JNDIValidator;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.util.*;
/**
* Abstract workflow instance that serves as the base for specific implementations, such as EJB or SOAP.
*
* @author <a href="mailto:[email protected]">Pat Lightbody</a>
* @author Hani Suleiman
*/
public class AbstractWorkflow implements Workflow {
//~ Static fields/initializers /////////////////////////////////////////////
private static final Log log = LogFactory.getLog(AbstractWorkflow.class);
//~ Instance fields ////////////////////////////////////////////////////////
protected WorkflowContext context;
private Configuration configuration;
//~ Methods ////////////////////////////////////////////////////////////////
/**
* @ejb.interface-method
* @deprecated use {@link #getAvailableActions(long, Map)} with an empty Map instead.
*/
public int[] getAvailableActions(long id) {
return getAvailableActions(id, new HashMap());
}
/**
* Get the available actions for the specified workflow instance.
* @ejb.interface-method
* @param id The workflow instance id.
* @param inputs The inputs map to pass on to conditions
* @return An array of action id's that can be performed on the specified entry.
* @throws IllegalArgumentException if the specified id does not exist, or if its workflow
* descriptor is no longer available or has become invalid.
*/
public int[] getAvailableActions(long id, Map inputs) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
throw new IllegalArgumentException("No such workflow id " + id);
}
if (entry.getState() != WorkflowEntry.ACTIVATED) {
return new int[0];
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
if (wf == null) {
throw new IllegalArgumentException("No such workflow " + entry.getWorkflowName());
}
List l = new ArrayList();
PropertySet ps = store.getPropertySet(id);
Map transientVars = (inputs == null) ? new HashMap() : new HashMap(inputs);
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(0), currentSteps);
// get global actions
List globalActions = wf.getGlobalActions();
for (Iterator iterator = globalActions.iterator();
iterator.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator.next();
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
//todo verify that 0 is the right currentStepId
if (passesConditions(null, conditions, transientVars, ps, 0)) {
l.add(new Integer(action.getId()));
}
}
// get normal actions
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step step = (Step) iterator.next();
l.addAll(getAvailableActionsForStep(wf, step, transientVars, ps));
}
int[] actions = new int[l.size()];
for (int i = 0; i < actions.length; i++) {
actions[i] = ((Integer) l.get(i)).intValue();
}
return actions;
} catch (Exception e) {
log.error("Error checking available actions", e);
return new int[0];
}
}
/**
* @ejb.interface-method
*/
public void setConfiguration(Configuration configuration) {
this.configuration = configuration;
}
/**
* Get the configuration for this workflow.
* This method also checks if the configuration has been initialized, and if not, initializes it.
* @return The configuration that was set.
* If no configuration was set, then the default (static) configuration is returned.
*
*/
public Configuration getConfiguration() {
Configuration config = (configuration != null) ? configuration : DefaultConfiguration.INSTANCE;
if (!config.isInitialized()) {
try {
config.load(null);
} catch (FactoryException e) {
log.fatal("Error initialising configuration", e);
//fail fast, better to blow up with an NPE that hide the error
return null;
}
}
return config;
}
/**
* @ejb.interface-method
*/
public List getCurrentSteps(long id) {
try {
WorkflowStore store = getPersistence();
return store.findCurrentSteps(id);
} catch (StoreException e) {
log.error("Error checking current steps for instance #" + id, e);
return Collections.EMPTY_LIST;
}
}
/**
* @ejb.interface-method
*/
public int getEntryState(long id) {
try {
WorkflowStore store = getPersistence();
return store.findEntry(id).getState();
} catch (StoreException e) {
log.error("Error checking instance state for instance #" + id, e);
}
return WorkflowEntry.UNKNOWN;
}
/**
* @ejb.interface-method
*/
public List getHistorySteps(long id) {
try {
WorkflowStore store = getPersistence();
return store.findHistorySteps(id);
} catch (StoreException e) {
log.error("Error getting history steps for instance #" + id, e);
}
return Collections.EMPTY_LIST;
}
/**
* @ejb.interface-method
*/
public Properties getPersistenceProperties() {
Properties p = new Properties();
Iterator iter = getConfiguration().getPersistenceArgs().entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = (Map.Entry) iter.next();
p.setProperty((String) entry.getKey(), (String) entry.getValue());
}
return p;
}
/**
* Get the PropertySet for the specified workflow ID
* @ejb.interface-method
* @param id The workflow ID
*/
public PropertySet getPropertySet(long id) {
PropertySet ps = null;
try {
ps = getPersistence().getPropertySet(id);
} catch (StoreException e) {
log.error("Error getting propertyset for instance #" + id, e);
}
return ps;
}
/**
* @ejb.interface-method
*/
public List getSecurityPermissions(long id) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), null, currentSteps);
List s = new ArrayList();
for (Iterator interator = currentSteps.iterator();
interator.hasNext();) {
Step step = (Step) interator.next();
int stepId = step.getStepId();
StepDescriptor xmlStep = wf.getStep(stepId);
List securities = xmlStep.getPermissions();
for (Iterator iterator2 = securities.iterator();
iterator2.hasNext();) {
PermissionDescriptor security = (PermissionDescriptor) iterator2.next();
// to have the permission, the condition must be met or not specified
// securities can't have restrictions based on inputs, so it's null
if (passesConditions(null, security.getRestriction().getConditions(), transientVars, ps, xmlStep.getId())) {
s.add(security.getName());
}
}
}
return s;
} catch (Exception e) {
log.error("Error getting security permissions for instance #" + id, e);
}
return Collections.EMPTY_LIST;
}
/**
* Returns a workflow definition object associated with the given name.
*
* @param workflowName the name of the workflow
* @return the object graph that represents a workflow definition
* @ejb.interface-method
*/
public WorkflowDescriptor getWorkflowDescriptor(String workflowName) {
try {
return getConfiguration().getWorkflow(workflowName);
} catch (FactoryException e) {
log.error("Error loading workflow " + workflowName, e);
}
return null;
}
/**
* @ejb.interface-method
*/
public String getWorkflowName(long id) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry != null) {
return entry.getWorkflowName();
}
} catch (StoreException e) {
log.error("Error getting instance name for instance #" + id, e);
}
return null;
}
/**
* Get a list of workflow names available
* @return String[] an array of workflow names.
* @ejb.interface-method
*/
public String[] getWorkflowNames() {
try {
return getConfiguration().getWorkflowNames();
} catch (FactoryException e) {
log.error("Error getting workflow names", e);
}
return new String[0];
}
/**
* @ejb.interface-method
*/
public boolean canInitialize(String workflowName, int initialAction) {
return canInitialize(workflowName, initialAction, null);
}
/**
* @ejb.interface-method
* @param workflowName the name of the workflow to check
* @param initialAction The initial action to check
* @param inputs the inputs map
* @return true if the workflow can be initialized
*/
public boolean canInitialize(String workflowName, int initialAction, Map inputs) {
final String mockWorkflowName = workflowName;
WorkflowEntry mockEntry = new WorkflowEntry() {
public long getId() {
return 0;
}
public String getWorkflowName() {
return mockWorkflowName;
}
public boolean isInitialized() {
return false;
}
public int getState() {
return WorkflowEntry.CREATED;
}
};
// since no state change happens here, a memory instance is just fine
PropertySet ps = PropertySetManager.getInstance("memory", null);
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
try {
populateTransientMap(mockEntry, transientVars, Collections.EMPTY_LIST, new Integer(initialAction), Collections.EMPTY_LIST);
return canInitialize(workflowName, initialAction, transientVars, ps);
} catch (InvalidActionException e) {
log.error(e.getMessage());
return false;
} catch (WorkflowException e) {
log.error("Error checking canInitialize", e);
return false;
}
}
/**
* @ejb.interface-method
*/
public boolean canModifyEntryState(long id, int newState) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
int currentState = entry.getState();
boolean result = false;
switch (newState) {
case WorkflowEntry.CREATED:
result = false;
case WorkflowEntry.ACTIVATED:
if ((currentState == WorkflowEntry.CREATED) || (currentState == WorkflowEntry.SUSPENDED)) {
result = true;
}
break;
case WorkflowEntry.SUSPENDED:
if (currentState == WorkflowEntry.ACTIVATED) {
result = true;
}
break;
case WorkflowEntry.KILLED:
if ((currentState == WorkflowEntry.CREATED) || (currentState == WorkflowEntry.ACTIVATED) || (currentState == WorkflowEntry.SUSPENDED)) {
result = true;
}
break;
default:
result = false;
break;
}
return result;
} catch (StoreException e) {
log.error("Error checking state modifiable for instance #" + id, e);
}
return false;
}
public void changeEntryState(long id, int newState) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry.getState() == newState) {
return;
}
if (canModifyEntryState(id, newState)) {
if ((newState == WorkflowEntry.KILLED) || (newState == WorkflowEntry.COMPLETED)) {
Collection currentSteps = getCurrentSteps(id);
if (currentSteps.size() > 0) {
completeEntry(id, currentSteps);
}
}
store.setEntryState(id, newState);
} else {
throw new InvalidEntryStateException("Can't transition workflow instance #" + id + ". Current state is " + entry.getState() + ", requested state is " + newState);
}
if (log.isDebugEnabled()) {
log.debug(entry.getId() + " : State is now : " + entry.getState());
}
}
public void doAction(long id, int actionId, Map inputs) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry.getState() != WorkflowEntry.ACTIVATED) {
return;
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
List currentSteps = store.findCurrentSteps(id);
ActionDescriptor action = null;
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(actionId), currentSteps);
boolean validAction = false;
//check global actions
for (Iterator gIter = wf.getGlobalActions().iterator();
!validAction && gIter.hasNext();) {
ActionDescriptor actionDesc = (ActionDescriptor) gIter.next();
if (actionDesc.getId() == actionId) {
action = actionDesc;
if (isActionAvailable(action, transientVars, ps, 0)) {
validAction = true;
}
}
}
for (Iterator iter = currentSteps.iterator();
!validAction && iter.hasNext();) {
Step step = (Step) iter.next();
StepDescriptor s = wf.getStep(step.getStepId());
for (Iterator iterator = s.getActions().iterator();
!validAction && iterator.hasNext();) {
ActionDescriptor actionDesc = (ActionDescriptor) iterator.next();
if (actionDesc.getId() == actionId) {
action = actionDesc;
if (isActionAvailable(action, transientVars, ps, s.getId())) {
validAction = true;
}
}
}
}
if (!validAction) {
throw new InvalidActionException("Action " + actionId + " is invalid");
}
try {
//transition the workflow, if it wasn't explicitly finished, check for an implicit finish
if (!transitionWorkflow(entry, currentSteps, store, wf, action, transientVars, inputs, ps)) {
checkImplicitFinish(id);
}
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
public void executeTriggerFunction(long id, int triggerId) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
log.warn("Cannot execute trigger #" + triggerId + " on non-existent workflow id#" + id);
return;
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
populateTransientMap(entry, transientVars, wf.getRegisters(), null, store.findCurrentSteps(id));
executeFunction(wf.getTriggerFunction(triggerId), transientVars, ps);
}
public long initialize(String workflowName, int initialAction, Map inputs) throws InvalidRoleException, InvalidInputException, WorkflowException {
WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.createEntry(workflowName);
// start with a memory property set, but clone it after we have an ID
PropertySet ps = store.getPropertySet(entry.getId());
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(initialAction), Collections.EMPTY_LIST);
if (!canInitialize(workflowName, initialAction, transientVars, ps)) {
context.setRollbackOnly();
throw new InvalidRoleException("You are restricted from initializing this workflow");
}
ActionDescriptor action = wf.getInitialAction(initialAction);
try {
transitionWorkflow(entry, Collections.EMPTY_LIST, store, wf, action, transientVars, inputs, ps);
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
long entryId = entry.getId();
// now clone the memory PS to the real PS
//PropertySetManager.clone(ps, store.getPropertySet(entryId));
return entryId;
}
/**
* @ejb.interface-method
*/
public List query(WorkflowQuery query) throws StoreException {
return getPersistence().query(query);
}
/**
* @ejb.interface-method
*/
public List query(WorkflowExpressionQuery query) throws WorkflowException {
return getPersistence().query(query);
}
/**
* @ejb.interface-method
*/
public boolean removeWorkflowDescriptor(String workflowName) throws FactoryException {
return getConfiguration().removeWorkflow(workflowName);
}
/**
* @ejb.interface-method
*/
public boolean saveWorkflowDescriptor(String workflowName, WorkflowDescriptor descriptor, boolean replace) throws FactoryException {
boolean success = getConfiguration().saveWorkflow(workflowName, descriptor, replace);
return success;
}
protected List getAvailableActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException {
List l = new ArrayList();
StepDescriptor s = wf.getStep(step.getStepId());
if (s == null) {
log.warn("getAvailableActionsForStep called for non-existent step Id #" + step.getStepId());
return l;
}
List actions = s.getActions();
if ((actions == null) || (actions.size() == 0)) {
return l;
}
for (Iterator iterator2 = actions.iterator(); iterator2.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator2.next();
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
if (passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, s.getId())) {
l.add(new Integer(action.getId()));
}
}
return l;
}
protected int[] getAvailableAutoActions(long id, Map inputs) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
throw new IllegalArgumentException("No such workflow id " + id);
}
if (entry.getState() != WorkflowEntry.ACTIVATED) {
log.debug("--> state is " + entry.getState());
return new int[0];
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
if (wf == null) {
throw new IllegalArgumentException("No such workflow " + entry.getWorkflowName());
}
List l = new ArrayList();
PropertySet ps = store.getPropertySet(id);
Map transientVars = (inputs == null) ? new HashMap() : new HashMap(inputs);
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(0), currentSteps);
// get global actions
List globalActions = wf.getGlobalActions();
for (Iterator iterator = globalActions.iterator();
iterator.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator.next();
if (action.getAutoExecute()) {
if (isActionAvailable(action, transientVars, ps, 0)) {
l.add(new Integer(action.getId()));
}
}
}
// get normal actions
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step step = (Step) iterator.next();
l.addAll(getAvailableAutoActionsForStep(wf, step, transientVars, ps));
}
int[] actions = new int[l.size()];
for (int i = 0; i < actions.length; i++) {
actions[i] = ((Integer) l.get(i)).intValue();
}
return actions;
} catch (Exception e) {
log.error("Error checking available actions", e);
return new int[0];
}
}
/**
* Get just auto action availables for a step
*/
protected List getAvailableAutoActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException {
List l = new ArrayList();
StepDescriptor s = wf.getStep(step.getStepId());
if (s == null) {
log.warn("getAvailableAutoActionsForStep called for non-existent step Id #" + step.getStepId());
return l;
}
List actions = s.getActions();
if ((actions == null) || (actions.size() == 0)) {
return l;
}
for (Iterator iterator2 = actions.iterator(); iterator2.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator2.next();
//check auto
if (action.getAutoExecute()) {
if (isActionAvailable(action, transientVars, ps, s.getId())) {
l.add(new Integer(action.getId()));
}
}
}
return l;
}
protected WorkflowStore getPersistence() throws StoreException {
return getConfiguration().getWorkflowStore();
}
protected void checkImplicitFinish(long id) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
Collection currentSteps = store.findCurrentSteps(id);
boolean isCompleted = true;
for (Iterator iterator = currentSteps.iterator(); iterator.hasNext();) {
Step step = (Step) iterator.next();
StepDescriptor stepDes = wf.getStep(step.getStepId());
// if at least on current step have an available action
if (stepDes.getActions().size() > 0) {
isCompleted = false;
}
}
if (isCompleted == true) {
completeEntry(id, currentSteps);
}
}
/**
* Mark the specified entry as completed, and move all current steps to history.
*/
protected void completeEntry(long id, Collection currentSteps) throws StoreException {
getPersistence().setEntryState(id, WorkflowEntry.COMPLETED);
Iterator i = new ArrayList(currentSteps).iterator();
while (i.hasNext()) {
Step step = (Step) i.next();
getPersistence().moveToHistory(step);
}
}
protected Object loadObject(String clazz) {
try {
return ClassLoaderUtil.loadClass(clazz.trim(), getClass()).newInstance();
} catch (Exception e) {
log.error("Could not load object '" + clazz + "'", e);
return null;
}
}
protected boolean passesCondition(ConditionDescriptor conditionDesc, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException {
String type = conditionDesc.getType();
Map args = new HashMap(conditionDesc.getArgs());
for (Iterator iterator = args.entrySet().iterator();
iterator.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
if (currentStepId != -1) {
Object stepId = args.get("stepId");
if ((stepId != null) && stepId.equals("-1")) {
args.put("stepId", String.valueOf(currentStepId));
}
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBCondition.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBCondition.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDICondition.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFCondition.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellCondition.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Condition condition = (Condition) loadObject(clazz);
if (condition == null) {
String message = "Could not load Condition: " + clazz;
throw new WorkflowException(message);
}
try {
boolean passed = condition.passesCondition(transientVars, args, ps);
if (conditionDesc.isNegate()) {
passed = !passed;
}
return passed;
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
throw new WorkflowException("Unknown exception encountered when trying condition: " + clazz, e);
}
}
protected boolean passesConditions(String conditionType, List conditions, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException {
if ((conditions == null) || (conditions.size() == 0)) {
return true;
}
boolean and = "AND".equals(conditionType);
boolean or = !and;
for (Iterator iterator = conditions.iterator(); iterator.hasNext();) {
AbstractDescriptor descriptor = (AbstractDescriptor) iterator.next();
boolean result;
if (descriptor instanceof ConditionsDescriptor) {
ConditionsDescriptor conditionsDescriptor = (ConditionsDescriptor) descriptor;
result = passesConditions(conditionsDescriptor.getType(), conditionsDescriptor.getConditions(), transientVars, ps, currentStepId);
} else {
result = passesCondition((ConditionDescriptor) descriptor, transientVars, ps, currentStepId);
}
if (and && !result) {
return false;
} else if (or && result) {
return true;
}
}
if (and) {
return true;
} else if (or) {
return false;
} else {
return false;
}
}
protected void populateTransientMap(WorkflowEntry entry, Map transientVars, List registers, Integer actionId, Collection currentSteps) throws WorkflowException {
transientVars.put("context", context);
transientVars.put("entry", entry);
transientVars.put("store", getPersistence());
transientVars.put("descriptor", getConfiguration().getWorkflow(entry.getWorkflowName()));
if (actionId != null) {
transientVars.put("actionId", actionId);
}
transientVars.put("currentSteps", Collections.unmodifiableCollection(currentSteps));
// now talk to the registers for any extra objects needed in scope
for (Iterator iterator = registers.iterator(); iterator.hasNext();) {
RegisterDescriptor register = (RegisterDescriptor) iterator.next();
Map args = register.getArgs();
String type = register.getType();
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBRegister.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBRegister.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIRegister.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFRegister.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellRegister.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Register r = (Register) loadObject(clazz);
if (r == null) {
String message = "Could not load register class: " + clazz;
throw new WorkflowException(message);
}
try {
transientVars.put(register.getVariableName(), r.registerVariable(context, entry, args));
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
throw new WorkflowException("An unknown exception occured while registering variable using class: " + clazz, e);
}
}
}
/**
* Validates input against a list of ValidatorDescriptor objects.
*
* @param entry the workflow instance
* @param validators the list of ValidatorDescriptors
* @param transientVars the transientVars
* @param ps the persistence variables
* @throws InvalidInputException if the input is deemed invalid by any validator
*/
protected void verifyInputs(WorkflowEntry entry, List validators, Map transientVars, PropertySet ps) throws WorkflowException {
for (Iterator iterator = validators.iterator(); iterator.hasNext();) {
ValidatorDescriptor input = (ValidatorDescriptor) iterator.next();
if (input != null) {
String type = input.getType();
HashMap args = new HashMap(input.getArgs());
for (Iterator iterator2 = args.entrySet().iterator();
iterator2.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator2.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBValidator.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBValidator.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIValidator.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFValidator.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellValidator.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Validator validator = (Validator) loadObject(clazz);
if (validator == null) {
String message = "Could not load validator class: " + clazz;
throw new WorkflowException(message);
}
try {
validator.validate(transientVars, args, ps);
} catch (InvalidInputException e) {
throw e;
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
String message = "An unknown exception occured executing Validator: " + clazz;
throw new WorkflowException(message, e);
}
}
}
}
/**
* check if an action is available or not
* @param action The action descriptor
* @return true if the action is available
*/
private boolean isActionAvailable(ActionDescriptor action, Map transientVars, PropertySet ps, int stepId) throws WorkflowException {
if (action == null) {
return false;
}
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
return passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, stepId);
}
private Step getCurrentStep(WorkflowDescriptor wfDesc, int actionId, List currentSteps, Map transientVars, PropertySet ps) throws WorkflowException {
if (currentSteps.size() == 1) {
return (Step) currentSteps.get(0);
}
for (Iterator iterator = currentSteps.iterator(); iterator.hasNext();) {
Step step = (Step) iterator.next();
ActionDescriptor action = wfDesc.getStep(step.getStepId()).getAction(actionId);
//$AR init
if (isActionAvailable(action, transientVars, ps, step.getStepId())) {
return step;
}
//$AR end
}
return null;
}
private boolean canInitialize(String workflowName, int initialAction, Map transientVars, PropertySet ps) throws WorkflowException {
WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);
ActionDescriptor actionDescriptor = wf.getInitialAction(initialAction);
if (actionDescriptor == null) {
throw new InvalidActionException("Invalid Initial Action #" + initialAction);
}
RestrictionDescriptor restriction = actionDescriptor.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
return passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, 0);
}
private Step createNewCurrentStep(ResultDescriptor theResult, WorkflowEntry entry, WorkflowStore store, int actionId, Step currentStep, long[] previousIds, Map transientVars, PropertySet ps) throws WorkflowException {
try {
int nextStep = theResult.getStep();
if (nextStep == -1) {
if (currentStep != null) {
nextStep = currentStep.getStepId();
} else {
throw new StoreException("Illegal argument: requested new current step same as current step, but current step not specified");
}
}
if (log.isDebugEnabled()) {
log.debug("Outcome: stepId=" + nextStep + ", status=" + theResult.getStatus() + ", owner=" + theResult.getOwner() + ", actionId=" + actionId + ", currentStep=" + ((currentStep != null) ? currentStep.getStepId() : 0));
}
if (previousIds == null) {
previousIds = new long[0];
}
String owner = TextUtils.noNull(theResult.getOwner());
if (owner.equals("")) {
owner = null;
} else {
Object o = ScriptVariableParser.translateVariables(owner, transientVars, ps);
owner = (o != null) ? o.toString() : null;
}
String oldStatus = theResult.getOldStatus();
oldStatus = ScriptVariableParser.translateVariables(oldStatus, transientVars, ps).toString();
String status = theResult.getStatus();
status = ScriptVariableParser.translateVariables(status, transientVars, ps).toString();
if (currentStep != null) {
store.markFinished(currentStep, actionId, new Date(), oldStatus, context.getCaller());
store.moveToHistory(currentStep);
//store.moveToHistory(actionId, new Date(), currentStep, oldStatus, context.getCaller());
}
// construct the start date and optional due date
Date startDate = new Date();
Date dueDate = null;
if ((theResult.getDueDate() != null) && (theResult.getDueDate().length() > 0)) {
Object dueDateObject = ScriptVariableParser.translateVariables(theResult.getDueDate(), transientVars, ps);
if (dueDateObject instanceof Date) {
dueDate = (Date) dueDateObject;
} else if (dueDateObject instanceof String) {
long offset = TextUtils.parseLong((String) dueDateObject);
if (offset > 0) {
dueDate = new Date(startDate.getTime() + offset);
}
} else if (dueDateObject instanceof Number) {
Number num = (Number) dueDateObject;
long offset = num.longValue();
if (offset > 0) {
dueDate = new Date(startDate.getTime() + offset);
}
}
}
Step newStep = store.createCurrentStep(entry.getId(), nextStep, owner, startDate, dueDate, status, previousIds);
WorkflowDescriptor descriptor = (WorkflowDescriptor) transientVars.get("descriptor");
List preFunctions = descriptor.getStep(nextStep).getPreFunctions();
for (Iterator iterator = preFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
return newStep;
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
/**
* Executes a function.
*
* @param function the function to execute
* @param transientVars the transientVars given by the end-user
* @param ps the persistence variables
*/
private void executeFunction(FunctionDescriptor function, Map transientVars, PropertySet ps) throws WorkflowException {
if (function != null) {
String type = function.getType();
HashMap args = new HashMap(function.getArgs());
for (Iterator iterator = args.entrySet().iterator();
iterator.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBFunctionProvider.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBFunctionProvider.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIFunctionProvider.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFFunctionProvider.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellFunctionProvider.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
FunctionProvider provider = (FunctionProvider) loadObject(clazz);
if (provider == null) {
String message = "Could not load FunctionProvider class: " + clazz;
context.setRollbackOnly();
throw new WorkflowException(message);
}
try {
provider.execute(transientVars, args, ps);
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
}
/**
* @return true if the instance has been explicitly completed is this transition, false otherwise
* @throws WorkflowException
*/
private boolean transitionWorkflow(WorkflowEntry entry, List currentSteps, WorkflowStore store, WorkflowDescriptor wf, ActionDescriptor action, Map transientVars, Map inputs, PropertySet ps) throws WorkflowException {
Step step = getCurrentStep(wf, action.getId(), currentSteps, transientVars, ps);
// validate transientVars (optional)
Map unmodifiableTransients = Collections.unmodifiableMap(transientVars);
if (action.getValidators().size() > 0) {
verifyInputs(entry, action.getValidators(), unmodifiableTransients, ps);
}
//we're leaving the current step, so let's execute its post-functions
//check if we actually have a current step
if (step != null) {
List stepPostFunctions = wf.getStep(step.getStepId()).getPostFunctions();
for (Iterator iterator = stepPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
// preFunctions
List preFunctions = action.getPreFunctions();
for (Iterator iterator = preFunctions.iterator(); iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
// check each conditional result
List conditionalResults = action.getConditionalResults();
List extraPreFunctions = null;
List extraPostFunctions = null;
ResultDescriptor[] theResults = new ResultDescriptor[1];
for (Iterator iterator = conditionalResults.iterator();
iterator.hasNext();) {
ConditionalResultDescriptor conditionalResult = (ConditionalResultDescriptor) iterator.next();
if (passesConditions(null, conditionalResult.getConditions(), unmodifiableTransients, ps, step.getStepId())) {
//if (evaluateExpression(conditionalResult.getCondition(), entry, wf.getRegisters(), null, transientVars)) {
theResults[0] = conditionalResult;
if (conditionalResult.getValidators().size() > 0) {
verifyInputs(entry, conditionalResult.getValidators(), unmodifiableTransients, ps);
}
extraPreFunctions = conditionalResult.getPreFunctions();
extraPostFunctions = conditionalResult.getPostFunctions();
break;
}
}
// use unconditional-result if a condition hasn't been met
if (theResults[0] == null) {
theResults[0] = action.getUnconditionalResult();
verifyInputs(entry, theResults[0].getValidators(), unmodifiableTransients, ps);
extraPreFunctions = theResults[0].getPreFunctions();
extraPostFunctions = theResults[0].getPostFunctions();
}
if (log.isDebugEnabled()) {
log.debug("theResult=" + theResults[0].getStep() + " " + theResults[0].getStatus());
}
if ((extraPreFunctions != null) && (extraPreFunctions.size() > 0)) {
// run any extra pre-functions that haven't been run already
for (Iterator iterator = extraPreFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
// go to next step
if (theResults[0].getSplit() != 0) {
// the result is a split request, handle it correctly
SplitDescriptor splitDesc = wf.getSplit(theResults[0].getSplit());
Collection results = splitDesc.getResults();
List splitPreFunctions = new ArrayList();
List splitPostFunctions = new ArrayList();
//check all results in the split and verify the input against any validators specified
//also build up all the pre and post functions that should be called.
for (Iterator iterator = results.iterator(); iterator.hasNext();) {
ResultDescriptor resultDescriptor = (ResultDescriptor) iterator.next();
if (resultDescriptor.getValidators().size() > 0) {
verifyInputs(entry, resultDescriptor.getValidators(), unmodifiableTransients, ps);
}
splitPreFunctions.addAll(resultDescriptor.getPreFunctions());
splitPostFunctions.addAll(resultDescriptor.getPostFunctions());
}
// now execute the pre-functions
for (Iterator iterator = splitPreFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
// now make these steps...
boolean moveFirst = true;
theResults = new ResultDescriptor[results.size()];
results.toArray(theResults);
for (Iterator iterator = results.iterator(); iterator.hasNext();) {
ResultDescriptor resultDescriptor = (ResultDescriptor) iterator.next();
Step moveToHistoryStep = null;
if (moveFirst) {
moveToHistoryStep = step;
}
long[] previousIds = null;
if (step != null) {
previousIds = new long[] {step.getId()};
}
createNewCurrentStep(resultDescriptor, entry, store, action.getId(), moveToHistoryStep, previousIds, transientVars, ps);
moveFirst = false;
}
// now execute the post-functions
for (Iterator iterator = splitPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
} else if (theResults[0].getJoin() != 0) {
// this is a join, finish this step...
JoinDescriptor joinDesc = wf.getJoin(theResults[0].getJoin());
step = store.markFinished(step, action.getId(), new Date(), theResults[0].getOldStatus(), context.getCaller());
store.moveToHistory(step);
// ... now check to see if the expression evaluates
// (get only current steps that have a result to this join)
Collection joinSteps = new ArrayList();
joinSteps.add(step);
//currentSteps = store.findCurrentSteps(id); // shouldn't need to refresh the list
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step currentStep = (Step) iterator.next();
if (currentStep.getId() != step.getId()) {
StepDescriptor stepDesc = wf.getStep(currentStep.getStepId());
if (stepDesc.resultsInJoin(theResults[0].getJoin())) {
joinSteps.add(currentStep);
}
}
}
//we also need to check history steps that were finished before this one
//that might be part of the join
List historySteps = store.findHistorySteps(entry.getId());
for (Iterator i = historySteps.iterator(); i.hasNext();) {
Step historyStep = (Step) i.next();
if (historyStep.getId() != step.getId()) {
StepDescriptor stepDesc = wf.getStep(historyStep.getStepId());
if (stepDesc.resultsInJoin(theResults[0].getJoin())) {
joinSteps.add(historyStep);
}
}
}
JoinNodes jn = new JoinNodes(joinSteps);
transientVars.put("jn", jn);
//todo verify that 0 is the right value for currentstep here
if (passesConditions(null, joinDesc.getConditions(), unmodifiableTransients, ps, 0)) {
// move the rest without creating a new step ...
ResultDescriptor joinresult = joinDesc.getResult();
if (joinresult.getValidators().size() > 0) {
verifyInputs(entry, joinresult.getValidators(), unmodifiableTransients, ps);
}
// now execute the pre-functions
for (Iterator iterator = joinresult.getPreFunctions().iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
long[] previousIds = new long[joinSteps.size()];
int i = 1;
for (Iterator iterator = joinSteps.iterator();
iterator.hasNext();) {
Step currentStep = (Step) iterator.next();
if (currentStep.getId() != step.getId()) {
//if this is already a history step (eg, for all join steps completed prior to this one),
//we don't move it, since it's already history.
if (!historySteps.contains(currentStep)) {
store.moveToHistory(currentStep);
}
previousIds[i] = currentStep.getId();
i++;
}
}
// ... now finish this step normally
previousIds[0] = step.getId();
theResults[0] = joinDesc.getResult();
//we pass in null for the current step since we've already moved it to history above
createNewCurrentStep(joinDesc.getResult(), entry, store, action.getId(), null, previousIds, transientVars, ps);
// now execute the post-functions
for (Iterator iterator = joinresult.getPostFunctions().iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
} else {
// normal finish, no splits or joins
long[] previousIds = null;
if (step != null) {
previousIds = new long[] {step.getId()};
}
createNewCurrentStep(theResults[0], entry, store, action.getId(), step, previousIds, transientVars, ps);
}
// postFunctions (BOTH)
if (extraPostFunctions != null) {
for (Iterator iterator = extraPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
List postFunctions = action.getPostFunctions();
for (Iterator iterator = postFunctions.iterator(); iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
//if executed action was an initial action then workflow is activated
if ((wf.getInitialAction(action.getId()) != null) && (entry.getState() != WorkflowEntry.ACTIVATED)) {
changeEntryState(entry.getId(), WorkflowEntry.ACTIVATED);
}
//if it's a finish action, then we halt
if (action.isFinish()) {
completeEntry(entry.getId(), getCurrentSteps(entry.getId()));
return true;
}
//get available autoexec actions
int[] availableAutoActions = getAvailableAutoActions(entry.getId(), inputs);
for (int j = 0; j < availableAutoActions.length; j++) {
int actionId = availableAutoActions[j];
doAction(entry.getId(), actionId, inputs);
break;
}
return false;
}
}
| src/java/com/opensymphony/workflow/AbstractWorkflow.java | /*
* Copyright (c) 2002-2003 by OpenSymphony
* All rights reserved.
*/
package com.opensymphony.workflow;
import com.opensymphony.module.propertyset.PropertySet;
import com.opensymphony.module.propertyset.PropertySetManager;
import com.opensymphony.util.ClassLoaderUtil;
import com.opensymphony.util.TextUtils;
import com.opensymphony.workflow.config.Configuration;
import com.opensymphony.workflow.config.DefaultConfiguration;
import com.opensymphony.workflow.loader.*;
import com.opensymphony.workflow.query.WorkflowExpressionQuery;
import com.opensymphony.workflow.query.WorkflowQuery;
import com.opensymphony.workflow.spi.*;
import com.opensymphony.workflow.util.ScriptVariableParser;
import com.opensymphony.workflow.util.beanshell.BeanShellCondition;
import com.opensymphony.workflow.util.beanshell.BeanShellFunctionProvider;
import com.opensymphony.workflow.util.beanshell.BeanShellRegister;
import com.opensymphony.workflow.util.beanshell.BeanShellValidator;
import com.opensymphony.workflow.util.bsf.BSFCondition;
import com.opensymphony.workflow.util.bsf.BSFFunctionProvider;
import com.opensymphony.workflow.util.bsf.BSFRegister;
import com.opensymphony.workflow.util.bsf.BSFValidator;
import com.opensymphony.workflow.util.ejb.local.LocalEJBCondition;
import com.opensymphony.workflow.util.ejb.local.LocalEJBFunctionProvider;
import com.opensymphony.workflow.util.ejb.local.LocalEJBRegister;
import com.opensymphony.workflow.util.ejb.local.LocalEJBValidator;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBCondition;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBFunctionProvider;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBRegister;
import com.opensymphony.workflow.util.ejb.remote.RemoteEJBValidator;
import com.opensymphony.workflow.util.jndi.JNDICondition;
import com.opensymphony.workflow.util.jndi.JNDIFunctionProvider;
import com.opensymphony.workflow.util.jndi.JNDIRegister;
import com.opensymphony.workflow.util.jndi.JNDIValidator;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.util.*;
/**
* Abstract workflow instance that serves as the base for specific implementations, such as EJB or SOAP.
*
* @author <a href="mailto:[email protected]">Pat Lightbody</a>
* @author Hani Suleiman
*/
public class AbstractWorkflow implements Workflow {
//~ Static fields/initializers /////////////////////////////////////////////
private static final Log log = LogFactory.getLog(AbstractWorkflow.class);
//~ Instance fields ////////////////////////////////////////////////////////
protected WorkflowContext context;
private Configuration configuration;
//~ Methods ////////////////////////////////////////////////////////////////
/**
* @ejb.interface-method
* @deprecated use {@link #getAvailableActions(long, Map)} with an empty Map instead.
*/
public int[] getAvailableActions(long id) {
return getAvailableActions(id, new HashMap());
}
/**
* Get the available actions for the specified workflow instance.
* @ejb.interface-method
* @param id The workflow instance id.
* @param inputs The inputs map to pass on to conditions
* @return An array of action id's that can be performed on the specified entry.
* @throws IllegalArgumentException if the specified id does not exist, or if its workflow
* descriptor is no longer available or has become invalid.
*/
public int[] getAvailableActions(long id, Map inputs) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
throw new IllegalArgumentException("No such workflow id " + id);
}
if (entry.getState() != WorkflowEntry.ACTIVATED) {
return new int[0];
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
if (wf == null) {
throw new IllegalArgumentException("No such workflow " + entry.getWorkflowName());
}
List l = new ArrayList();
PropertySet ps = store.getPropertySet(id);
Map transientVars = (inputs == null) ? new HashMap() : new HashMap(inputs);
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(0), currentSteps);
// get global actions
List globalActions = wf.getGlobalActions();
for (Iterator iterator = globalActions.iterator();
iterator.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator.next();
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
//todo verify that 0 is the right currentStepId
if (passesConditions(null, conditions, transientVars, ps, 0)) {
l.add(new Integer(action.getId()));
}
}
// get normal actions
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step step = (Step) iterator.next();
l.addAll(getAvailableActionsForStep(wf, step, transientVars, ps));
}
int[] actions = new int[l.size()];
for (int i = 0; i < actions.length; i++) {
actions[i] = ((Integer) l.get(i)).intValue();
}
return actions;
} catch (Exception e) {
log.error("Error checking available actions", e);
return new int[0];
}
}
/**
* @ejb.interface-method
*/
public void setConfiguration(Configuration configuration) {
this.configuration = configuration;
}
/**
* Get the configuration for this workflow.
* This method also checks if the configuration has been initialized, and if not, initializes it.
* @return The configuration that was set.
* If no configuration was set, then the default (static) configuration is returned.
*
*/
public Configuration getConfiguration() {
Configuration config = (configuration != null) ? configuration : DefaultConfiguration.INSTANCE;
if (!config.isInitialized()) {
try {
config.load(null);
} catch (FactoryException e) {
log.fatal("Error initialising configuration", e);
//fail fast, better to blow up with an NPE that hide the error
return null;
}
}
return config;
}
/**
* @ejb.interface-method
*/
public List getCurrentSteps(long id) {
try {
WorkflowStore store = getPersistence();
return store.findCurrentSteps(id);
} catch (StoreException e) {
log.error("Error checking current steps for instance #" + id, e);
return Collections.EMPTY_LIST;
}
}
/**
* @ejb.interface-method
*/
public int getEntryState(long id) {
try {
WorkflowStore store = getPersistence();
return store.findEntry(id).getState();
} catch (StoreException e) {
log.error("Error checking instance state for instance #" + id, e);
}
return WorkflowEntry.UNKNOWN;
}
/**
* @ejb.interface-method
*/
public List getHistorySteps(long id) {
try {
WorkflowStore store = getPersistence();
return store.findHistorySteps(id);
} catch (StoreException e) {
log.error("Error getting history steps for instance #" + id, e);
}
return Collections.EMPTY_LIST;
}
/**
* @ejb.interface-method
*/
public Properties getPersistenceProperties() {
Properties p = new Properties();
Iterator iter = getConfiguration().getPersistenceArgs().entrySet().iterator();
while (iter.hasNext()) {
Map.Entry entry = (Map.Entry) iter.next();
p.setProperty((String) entry.getKey(), (String) entry.getValue());
}
return p;
}
/**
* Get the PropertySet for the specified workflow ID
* @ejb.interface-method
* @param id The workflow ID
*/
public PropertySet getPropertySet(long id) {
PropertySet ps = null;
try {
ps = getPersistence().getPropertySet(id);
} catch (StoreException e) {
log.error("Error getting propertyset for instance #" + id, e);
}
return ps;
}
/**
* @ejb.interface-method
*/
public List getSecurityPermissions(long id) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), null, currentSteps);
List s = new ArrayList();
for (Iterator interator = currentSteps.iterator();
interator.hasNext();) {
Step step = (Step) interator.next();
int stepId = step.getStepId();
StepDescriptor xmlStep = wf.getStep(stepId);
List securities = xmlStep.getPermissions();
for (Iterator iterator2 = securities.iterator();
iterator2.hasNext();) {
PermissionDescriptor security = (PermissionDescriptor) iterator2.next();
// to have the permission, the condition must be met or not specified
// securities can't have restrictions based on inputs, so it's null
if (passesConditions(null, security.getRestriction().getConditions(), transientVars, ps, xmlStep.getId())) {
s.add(security.getName());
}
}
}
return s;
} catch (Exception e) {
log.error("Error getting security permissions for instance #" + id, e);
}
return Collections.EMPTY_LIST;
}
/**
* Returns a workflow definition object associated with the given name.
*
* @param workflowName the name of the workflow
* @return the object graph that represents a workflow definition
* @ejb.interface-method
*/
public WorkflowDescriptor getWorkflowDescriptor(String workflowName) {
try {
return getConfiguration().getWorkflow(workflowName);
} catch (FactoryException e) {
log.error("Error loading workflow " + workflowName, e);
}
return null;
}
/**
* @ejb.interface-method
*/
public String getWorkflowName(long id) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry != null) {
return entry.getWorkflowName();
}
} catch (StoreException e) {
log.error("Error getting instance name for instance #" + id, e);
}
return null;
}
/**
* Get a list of workflow names available
* @return String[] an array of workflow names.
* @ejb.interface-method
*/
public String[] getWorkflowNames() {
try {
return getConfiguration().getWorkflowNames();
} catch (FactoryException e) {
log.error("Error getting workflow names", e);
}
return new String[0];
}
/**
* @ejb.interface-method
*/
public boolean canInitialize(String workflowName, int initialAction) {
return canInitialize(workflowName, initialAction, null);
}
/**
* @ejb.interface-method
* @param workflowName the name of the workflow to check
* @param initialAction The initial action to check
* @param inputs the inputs map
* @return true if the workflow can be initialized
*/
public boolean canInitialize(String workflowName, int initialAction, Map inputs) {
final String mockWorkflowName = workflowName;
WorkflowEntry mockEntry = new WorkflowEntry() {
public long getId() {
return 0;
}
public String getWorkflowName() {
return mockWorkflowName;
}
public boolean isInitialized() {
return false;
}
public int getState() {
return WorkflowEntry.CREATED;
}
};
// since no state change happens here, a memory instance is just fine
PropertySet ps = PropertySetManager.getInstance("memory", null);
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
try {
populateTransientMap(mockEntry, transientVars, Collections.EMPTY_LIST, new Integer(initialAction), Collections.EMPTY_LIST);
return canInitialize(workflowName, initialAction, transientVars, ps);
} catch (InvalidActionException e) {
log.error(e.getMessage());
return false;
} catch (WorkflowException e) {
log.error("Error checking canInitialize", e);
return false;
}
}
/**
* @ejb.interface-method
*/
public boolean canModifyEntryState(long id, int newState) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
int currentState = entry.getState();
boolean result = false;
switch (newState) {
case WorkflowEntry.CREATED:
result = false;
case WorkflowEntry.ACTIVATED:
if ((currentState == WorkflowEntry.CREATED) || (currentState == WorkflowEntry.SUSPENDED)) {
result = true;
}
break;
case WorkflowEntry.SUSPENDED:
if (currentState == WorkflowEntry.ACTIVATED) {
result = true;
}
break;
case WorkflowEntry.KILLED:
if ((currentState == WorkflowEntry.CREATED) || (currentState == WorkflowEntry.ACTIVATED) || (currentState == WorkflowEntry.SUSPENDED)) {
result = true;
}
break;
default:
result = false;
break;
}
return result;
} catch (StoreException e) {
log.error("Error checking state modifiable for instance #" + id, e);
}
return false;
}
public void changeEntryState(long id, int newState) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry.getState() == newState) {
return;
}
if (canModifyEntryState(id, newState)) {
if ((newState == WorkflowEntry.KILLED) || (newState == WorkflowEntry.COMPLETED)) {
Collection currentSteps = getCurrentSteps(id);
if (currentSteps.size() > 0) {
completeEntry(id, currentSteps);
}
}
store.setEntryState(id, newState);
} else {
throw new InvalidEntryStateException("Can't transition workflow instance #" + id + ". Current state is " + entry.getState() + ", requested state is " + newState);
}
if (log.isDebugEnabled()) {
log.debug(entry.getId() + " : State is now : " + entry.getState());
}
}
public void doAction(long id, int actionId, Map inputs) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry.getState() != WorkflowEntry.ACTIVATED) {
return;
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
List currentSteps = store.findCurrentSteps(id);
ActionDescriptor action = null;
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(actionId), currentSteps);
boolean validAction = false;
//check global actions
for (Iterator gIter = wf.getGlobalActions().iterator();
!validAction && gIter.hasNext();) {
ActionDescriptor actionDesc = (ActionDescriptor) gIter.next();
if (actionDesc.getId() == actionId) {
action = actionDesc;
if (isActionAvailable(action, transientVars, ps, 0)) {
validAction = true;
}
}
}
for (Iterator iter = currentSteps.iterator();
!validAction && iter.hasNext();) {
Step step = (Step) iter.next();
StepDescriptor s = wf.getStep(step.getStepId());
for (Iterator iterator = s.getActions().iterator();
!validAction && iterator.hasNext();) {
ActionDescriptor actionDesc = (ActionDescriptor) iterator.next();
if (actionDesc.getId() == actionId) {
action = actionDesc;
if (isActionAvailable(action, transientVars, ps, s.getId())) {
validAction = true;
}
}
}
}
if (!validAction) {
throw new InvalidActionException("Action " + actionId + " is invalid");
}
try {
//transition the workflow, if it wasn't explicitly finished, check for an implicit finish
if (!transitionWorkflow(entry, currentSteps, store, wf, action, transientVars, inputs, ps)) {
checkImplicitFinish(id);
}
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
public void executeTriggerFunction(long id, int triggerId) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
log.warn("Cannot execute trigger #" + triggerId + " on non-existent workflow id#" + id);
return;
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
PropertySet ps = store.getPropertySet(id);
Map transientVars = new HashMap();
populateTransientMap(entry, transientVars, wf.getRegisters(), null, store.findCurrentSteps(id));
executeFunction(wf.getTriggerFunction(triggerId), transientVars, ps);
}
public long initialize(String workflowName, int initialAction, Map inputs) throws InvalidRoleException, InvalidInputException, WorkflowException {
WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.createEntry(workflowName);
// start with a memory property set, but clone it after we have an ID
PropertySet ps = store.getPropertySet(entry.getId());
Map transientVars = new HashMap();
if (inputs != null) {
transientVars.putAll(inputs);
}
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(initialAction), Collections.EMPTY_LIST);
if (!canInitialize(workflowName, initialAction, transientVars, ps)) {
context.setRollbackOnly();
throw new InvalidRoleException("You are restricted from initializing this workflow");
}
ActionDescriptor action = wf.getInitialAction(initialAction);
try {
transitionWorkflow(entry, Collections.EMPTY_LIST, store, wf, action, transientVars, inputs, ps);
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
long entryId = entry.getId();
// now clone the memory PS to the real PS
//PropertySetManager.clone(ps, store.getPropertySet(entryId));
return entryId;
}
/**
* @ejb.interface-method
*/
public List query(WorkflowQuery query) throws StoreException {
return getPersistence().query(query);
}
/**
* @ejb.interface-method
*/
public List query(WorkflowExpressionQuery query) throws WorkflowException {
return getPersistence().query(query);
}
/**
* @ejb.interface-method
*/
public boolean removeWorkflowDescriptor(String workflowName) throws FactoryException {
return getConfiguration().removeWorkflow(workflowName);
}
/**
* @ejb.interface-method
*/
public boolean saveWorkflowDescriptor(String workflowName, WorkflowDescriptor descriptor, boolean replace) throws FactoryException {
boolean success = getConfiguration().saveWorkflow(workflowName, descriptor, replace);
return success;
}
protected List getAvailableActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException {
List l = new ArrayList();
StepDescriptor s = wf.getStep(step.getStepId());
if (s == null) {
log.warn("getAvailableActionsForStep called for non-existent step Id #" + step.getStepId());
return l;
}
List actions = s.getActions();
if ((actions == null) || (actions.size() == 0)) {
return l;
}
for (Iterator iterator2 = actions.iterator(); iterator2.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator2.next();
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
if (passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, s.getId())) {
l.add(new Integer(action.getId()));
}
}
return l;
}
protected int[] getAvailableAutoActions(long id, Map inputs) {
try {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
if (entry == null) {
throw new IllegalArgumentException("No such workflow id " + id);
}
if (entry.getState() != WorkflowEntry.ACTIVATED) {
log.debug("--> state is " + entry.getState());
return new int[0];
}
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
if (wf == null) {
throw new IllegalArgumentException("No such workflow " + entry.getWorkflowName());
}
List l = new ArrayList();
PropertySet ps = store.getPropertySet(id);
Map transientVars = (inputs == null) ? new HashMap() : new HashMap(inputs);
Collection currentSteps = store.findCurrentSteps(id);
populateTransientMap(entry, transientVars, wf.getRegisters(), new Integer(0), currentSteps);
// get global actions
List globalActions = wf.getGlobalActions();
for (Iterator iterator = globalActions.iterator();
iterator.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator.next();
if (action.getAutoExecute()) {
if (isActionAvailable(action, transientVars, ps, 0)) {
l.add(new Integer(action.getId()));
}
}
}
// get normal actions
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step step = (Step) iterator.next();
l.addAll(getAvailableAutoActionsForStep(wf, step, transientVars, ps));
}
int[] actions = new int[l.size()];
for (int i = 0; i < actions.length; i++) {
actions[i] = ((Integer) l.get(i)).intValue();
}
return actions;
} catch (Exception e) {
log.error("Error checking available actions", e);
return new int[0];
}
}
/**
* Get just auto action availables for a step
*/
protected List getAvailableAutoActionsForStep(WorkflowDescriptor wf, Step step, Map transientVars, PropertySet ps) throws WorkflowException {
List l = new ArrayList();
StepDescriptor s = wf.getStep(step.getStepId());
if (s == null) {
log.warn("getAvailableAutoActionsForStep called for non-existent step Id #" + step.getStepId());
return l;
}
List actions = s.getActions();
if ((actions == null) || (actions.size() == 0)) {
return l;
}
for (Iterator iterator2 = actions.iterator(); iterator2.hasNext();) {
ActionDescriptor action = (ActionDescriptor) iterator2.next();
//check auto
if (action.getAutoExecute()) {
if (isActionAvailable(action, transientVars, ps, s.getId())) {
l.add(new Integer(action.getId()));
}
}
}
return l;
}
protected WorkflowStore getPersistence() throws StoreException {
return getConfiguration().getWorkflowStore();
}
protected void checkImplicitFinish(long id) throws WorkflowException {
WorkflowStore store = getPersistence();
WorkflowEntry entry = store.findEntry(id);
WorkflowDescriptor wf = getConfiguration().getWorkflow(entry.getWorkflowName());
Collection currentSteps = store.findCurrentSteps(id);
boolean isCompleted = true;
for (Iterator iterator = currentSteps.iterator(); iterator.hasNext();) {
Step step = (Step) iterator.next();
StepDescriptor stepDes = wf.getStep(step.getStepId());
// if at least on current step have an available action
if (stepDes.getActions().size() > 0) {
isCompleted = false;
}
}
if (isCompleted == true) {
completeEntry(id, currentSteps);
}
}
/**
* Mark the specified entry as completed, and move all current steps to history.
*/
protected void completeEntry(long id, Collection currentSteps) throws StoreException {
getPersistence().setEntryState(id, WorkflowEntry.COMPLETED);
Iterator i = new ArrayList(currentSteps).iterator();
while (i.hasNext()) {
Step step = (Step) i.next();
getPersistence().moveToHistory(step);
}
}
protected Object loadObject(String clazz) {
try {
return ClassLoaderUtil.loadClass(clazz, getClass()).newInstance();
} catch (Exception e) {
log.error("Could not load object '" + clazz + "'", e);
return null;
}
}
protected boolean passesCondition(ConditionDescriptor conditionDesc, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException {
String type = conditionDesc.getType();
Map args = new HashMap(conditionDesc.getArgs());
for (Iterator iterator = args.entrySet().iterator();
iterator.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
if (currentStepId != -1) {
Object stepId = args.get("stepId");
if ((stepId != null) && stepId.equals("-1")) {
args.put("stepId", String.valueOf(currentStepId));
}
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBCondition.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBCondition.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDICondition.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFCondition.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellCondition.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Condition condition = (Condition) loadObject(clazz);
if (condition == null) {
String message = "Could not load Condition: " + clazz;
throw new WorkflowException(message);
}
try {
boolean passed = condition.passesCondition(transientVars, args, ps);
if (conditionDesc.isNegate()) {
passed = !passed;
}
return passed;
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
throw new WorkflowException("Unknown exception encountered when trying condition: " + clazz, e);
}
}
protected boolean passesConditions(String conditionType, List conditions, Map transientVars, PropertySet ps, int currentStepId) throws WorkflowException {
if ((conditions == null) || (conditions.size() == 0)) {
return true;
}
boolean and = "AND".equals(conditionType);
boolean or = !and;
for (Iterator iterator = conditions.iterator(); iterator.hasNext();) {
AbstractDescriptor descriptor = (AbstractDescriptor) iterator.next();
boolean result;
if (descriptor instanceof ConditionsDescriptor) {
ConditionsDescriptor conditionsDescriptor = (ConditionsDescriptor) descriptor;
result = passesConditions(conditionsDescriptor.getType(), conditionsDescriptor.getConditions(), transientVars, ps, currentStepId);
} else {
result = passesCondition((ConditionDescriptor) descriptor, transientVars, ps, currentStepId);
}
if (and && !result) {
return false;
} else if (or && result) {
return true;
}
}
if (and) {
return true;
} else if (or) {
return false;
} else {
return false;
}
}
protected void populateTransientMap(WorkflowEntry entry, Map transientVars, List registers, Integer actionId, Collection currentSteps) throws WorkflowException {
transientVars.put("context", context);
transientVars.put("entry", entry);
transientVars.put("store", getPersistence());
transientVars.put("descriptor", getConfiguration().getWorkflow(entry.getWorkflowName()));
if (actionId != null) {
transientVars.put("actionId", actionId);
}
transientVars.put("currentSteps", Collections.unmodifiableCollection(currentSteps));
// now talk to the registers for any extra objects needed in scope
for (Iterator iterator = registers.iterator(); iterator.hasNext();) {
RegisterDescriptor register = (RegisterDescriptor) iterator.next();
Map args = register.getArgs();
String type = register.getType();
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBRegister.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBRegister.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIRegister.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFRegister.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellRegister.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Register r = (Register) loadObject(clazz);
if (r == null) {
String message = "Could not load register class: " + clazz;
throw new WorkflowException(message);
}
try {
transientVars.put(register.getVariableName(), r.registerVariable(context, entry, args));
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
throw new WorkflowException("An unknown exception occured while registering variable using class: " + clazz, e);
}
}
}
/**
* Validates input against a list of ValidatorDescriptor objects.
*
* @param entry the workflow instance
* @param validators the list of ValidatorDescriptors
* @param transientVars the transientVars
* @param ps the persistence variables
* @throws InvalidInputException if the input is deemed invalid by any validator
*/
protected void verifyInputs(WorkflowEntry entry, List validators, Map transientVars, PropertySet ps) throws WorkflowException {
for (Iterator iterator = validators.iterator(); iterator.hasNext();) {
ValidatorDescriptor input = (ValidatorDescriptor) iterator.next();
if (input != null) {
String type = input.getType();
HashMap args = new HashMap(input.getArgs());
for (Iterator iterator2 = args.entrySet().iterator();
iterator2.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator2.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBValidator.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBValidator.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIValidator.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFValidator.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellValidator.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
Validator validator = (Validator) loadObject(clazz);
if (validator == null) {
String message = "Could not load validator class: " + clazz;
throw new WorkflowException(message);
}
try {
validator.validate(transientVars, args, ps);
} catch (InvalidInputException e) {
throw e;
} catch (Exception e) {
context.setRollbackOnly();
if (e instanceof WorkflowException) {
throw (WorkflowException) e;
}
String message = "An unknown exception occured executing Validator: " + clazz;
throw new WorkflowException(message, e);
}
}
}
}
/**
* check if an action is available or not
* @param action The action descriptor
* @return true if the action is available
*/
private boolean isActionAvailable(ActionDescriptor action, Map transientVars, PropertySet ps, int stepId) throws WorkflowException {
if (action == null) {
return false;
}
RestrictionDescriptor restriction = action.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
return passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, stepId);
}
private Step getCurrentStep(WorkflowDescriptor wfDesc, int actionId, List currentSteps, Map transientVars, PropertySet ps) throws WorkflowException {
if (currentSteps.size() == 1) {
return (Step) currentSteps.get(0);
}
for (Iterator iterator = currentSteps.iterator(); iterator.hasNext();) {
Step step = (Step) iterator.next();
ActionDescriptor action = wfDesc.getStep(step.getStepId()).getAction(actionId);
//$AR init
if (isActionAvailable(action, transientVars, ps, step.getStepId())) {
return step;
}
//$AR end
}
return null;
}
private boolean canInitialize(String workflowName, int initialAction, Map transientVars, PropertySet ps) throws WorkflowException {
WorkflowDescriptor wf = getConfiguration().getWorkflow(workflowName);
ActionDescriptor actionDescriptor = wf.getInitialAction(initialAction);
if (actionDescriptor == null) {
throw new InvalidActionException("Invalid Initial Action #" + initialAction);
}
RestrictionDescriptor restriction = actionDescriptor.getRestriction();
List conditions = null;
if (restriction != null) {
conditions = restriction.getConditions();
}
return passesConditions(null, conditions, Collections.unmodifiableMap(transientVars), ps, 0);
}
private Step createNewCurrentStep(ResultDescriptor theResult, WorkflowEntry entry, WorkflowStore store, int actionId, Step currentStep, long[] previousIds, Map transientVars, PropertySet ps) throws WorkflowException {
try {
int nextStep = theResult.getStep();
if (nextStep == -1) {
if (currentStep != null) {
nextStep = currentStep.getStepId();
} else {
throw new StoreException("Illegal argument: requested new current step same as current step, but current step not specified");
}
}
if (log.isDebugEnabled()) {
log.debug("Outcome: stepId=" + nextStep + ", status=" + theResult.getStatus() + ", owner=" + theResult.getOwner() + ", actionId=" + actionId + ", currentStep=" + ((currentStep != null) ? currentStep.getStepId() : 0));
}
if (previousIds == null) {
previousIds = new long[0];
}
String owner = TextUtils.noNull(theResult.getOwner());
if (owner.equals("")) {
owner = null;
} else {
Object o = ScriptVariableParser.translateVariables(owner, transientVars, ps);
owner = (o != null) ? o.toString() : null;
}
String oldStatus = theResult.getOldStatus();
oldStatus = ScriptVariableParser.translateVariables(oldStatus, transientVars, ps).toString();
String status = theResult.getStatus();
status = ScriptVariableParser.translateVariables(status, transientVars, ps).toString();
if (currentStep != null) {
store.markFinished(currentStep, actionId, new Date(), oldStatus, context.getCaller());
store.moveToHistory(currentStep);
//store.moveToHistory(actionId, new Date(), currentStep, oldStatus, context.getCaller());
}
// construct the start date and optional due date
Date startDate = new Date();
Date dueDate = null;
if ((theResult.getDueDate() != null) && (theResult.getDueDate().length() > 0)) {
Object dueDateObject = ScriptVariableParser.translateVariables(theResult.getDueDate(), transientVars, ps);
if (dueDateObject instanceof Date) {
dueDate = (Date) dueDateObject;
} else if (dueDateObject instanceof String) {
long offset = TextUtils.parseLong((String) dueDateObject);
if (offset > 0) {
dueDate = new Date(startDate.getTime() + offset);
}
} else if (dueDateObject instanceof Number) {
Number num = (Number) dueDateObject;
long offset = num.longValue();
if (offset > 0) {
dueDate = new Date(startDate.getTime() + offset);
}
}
}
Step newStep = store.createCurrentStep(entry.getId(), nextStep, owner, startDate, dueDate, status, previousIds);
WorkflowDescriptor descriptor = (WorkflowDescriptor) transientVars.get("descriptor");
List preFunctions = descriptor.getStep(nextStep).getPreFunctions();
for (Iterator iterator = preFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
return newStep;
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
/**
* Executes a function.
*
* @param function the function to execute
* @param transientVars the transientVars given by the end-user
* @param ps the persistence variables
*/
private void executeFunction(FunctionDescriptor function, Map transientVars, PropertySet ps) throws WorkflowException {
if (function != null) {
String type = function.getType();
HashMap args = new HashMap(function.getArgs());
for (Iterator iterator = args.entrySet().iterator();
iterator.hasNext();) {
Map.Entry mapEntry = (Map.Entry) iterator.next();
mapEntry.setValue(ScriptVariableParser.translateVariables((String) mapEntry.getValue(), transientVars, ps));
}
String clazz;
if ("remote-ejb".equals(type)) {
clazz = RemoteEJBFunctionProvider.class.getName();
} else if ("local-ejb".equals(type)) {
clazz = LocalEJBFunctionProvider.class.getName();
} else if ("jndi".equals(type)) {
clazz = JNDIFunctionProvider.class.getName();
} else if ("bsf".equals(type)) {
clazz = BSFFunctionProvider.class.getName();
} else if ("beanshell".equals(type)) {
clazz = BeanShellFunctionProvider.class.getName();
} else {
clazz = (String) args.get(CLASS_NAME);
}
FunctionProvider provider = (FunctionProvider) loadObject(clazz);
if (provider == null) {
String message = "Could not load FunctionProvider class: " + clazz;
context.setRollbackOnly();
throw new WorkflowException(message);
}
try {
provider.execute(transientVars, args, ps);
} catch (WorkflowException e) {
context.setRollbackOnly();
throw e;
}
}
}
/**
* @return true if the instance has been explicitly completed is this transition, false otherwise
* @throws WorkflowException
*/
private boolean transitionWorkflow(WorkflowEntry entry, List currentSteps, WorkflowStore store, WorkflowDescriptor wf, ActionDescriptor action, Map transientVars, Map inputs, PropertySet ps) throws WorkflowException {
Step step = getCurrentStep(wf, action.getId(), currentSteps, transientVars, ps);
// validate transientVars (optional)
Map unmodifiableTransients = Collections.unmodifiableMap(transientVars);
if (action.getValidators().size() > 0) {
verifyInputs(entry, action.getValidators(), unmodifiableTransients, ps);
}
//we're leaving the current step, so let's execute its post-functions
//check if we actually have a current step
if (step != null) {
List stepPostFunctions = wf.getStep(step.getStepId()).getPostFunctions();
for (Iterator iterator = stepPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
// preFunctions
List preFunctions = action.getPreFunctions();
for (Iterator iterator = preFunctions.iterator(); iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
// check each conditional result
List conditionalResults = action.getConditionalResults();
List extraPreFunctions = null;
List extraPostFunctions = null;
ResultDescriptor[] theResults = new ResultDescriptor[1];
for (Iterator iterator = conditionalResults.iterator();
iterator.hasNext();) {
ConditionalResultDescriptor conditionalResult = (ConditionalResultDescriptor) iterator.next();
if (passesConditions(null, conditionalResult.getConditions(), unmodifiableTransients, ps, step.getStepId())) {
//if (evaluateExpression(conditionalResult.getCondition(), entry, wf.getRegisters(), null, transientVars)) {
theResults[0] = conditionalResult;
if (conditionalResult.getValidators().size() > 0) {
verifyInputs(entry, conditionalResult.getValidators(), unmodifiableTransients, ps);
}
extraPreFunctions = conditionalResult.getPreFunctions();
extraPostFunctions = conditionalResult.getPostFunctions();
break;
}
}
// use unconditional-result if a condition hasn't been met
if (theResults[0] == null) {
theResults[0] = action.getUnconditionalResult();
verifyInputs(entry, theResults[0].getValidators(), unmodifiableTransients, ps);
extraPreFunctions = theResults[0].getPreFunctions();
extraPostFunctions = theResults[0].getPostFunctions();
}
if (log.isDebugEnabled()) {
log.debug("theResult=" + theResults[0].getStep() + " " + theResults[0].getStatus());
}
if ((extraPreFunctions != null) && (extraPreFunctions.size() > 0)) {
// run any extra pre-functions that haven't been run already
for (Iterator iterator = extraPreFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
// go to next step
if (theResults[0].getSplit() != 0) {
// the result is a split request, handle it correctly
SplitDescriptor splitDesc = wf.getSplit(theResults[0].getSplit());
Collection results = splitDesc.getResults();
List splitPreFunctions = new ArrayList();
List splitPostFunctions = new ArrayList();
//check all results in the split and verify the input against any validators specified
//also build up all the pre and post functions that should be called.
for (Iterator iterator = results.iterator(); iterator.hasNext();) {
ResultDescriptor resultDescriptor = (ResultDescriptor) iterator.next();
if (resultDescriptor.getValidators().size() > 0) {
verifyInputs(entry, resultDescriptor.getValidators(), unmodifiableTransients, ps);
}
splitPreFunctions.addAll(resultDescriptor.getPreFunctions());
splitPostFunctions.addAll(resultDescriptor.getPostFunctions());
}
// now execute the pre-functions
for (Iterator iterator = splitPreFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
// now make these steps...
boolean moveFirst = true;
theResults = new ResultDescriptor[results.size()];
results.toArray(theResults);
for (Iterator iterator = results.iterator(); iterator.hasNext();) {
ResultDescriptor resultDescriptor = (ResultDescriptor) iterator.next();
Step moveToHistoryStep = null;
if (moveFirst) {
moveToHistoryStep = step;
}
long[] previousIds = null;
if (step != null) {
previousIds = new long[] {step.getId()};
}
createNewCurrentStep(resultDescriptor, entry, store, action.getId(), moveToHistoryStep, previousIds, transientVars, ps);
moveFirst = false;
}
// now execute the post-functions
for (Iterator iterator = splitPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
} else if (theResults[0].getJoin() != 0) {
// this is a join, finish this step...
JoinDescriptor joinDesc = wf.getJoin(theResults[0].getJoin());
step = store.markFinished(step, action.getId(), new Date(), theResults[0].getOldStatus(), context.getCaller());
store.moveToHistory(step);
// ... now check to see if the expression evaluates
// (get only current steps that have a result to this join)
Collection joinSteps = new ArrayList();
joinSteps.add(step);
//currentSteps = store.findCurrentSteps(id); // shouldn't need to refresh the list
for (Iterator iterator = currentSteps.iterator();
iterator.hasNext();) {
Step currentStep = (Step) iterator.next();
if (currentStep.getId() != step.getId()) {
StepDescriptor stepDesc = wf.getStep(currentStep.getStepId());
if (stepDesc.resultsInJoin(theResults[0].getJoin())) {
joinSteps.add(currentStep);
}
}
}
//we also need to check history steps that were finished before this one
//that might be part of the join
List historySteps = store.findHistorySteps(entry.getId());
for (Iterator i = historySteps.iterator(); i.hasNext();) {
Step historyStep = (Step) i.next();
if (historyStep.getId() != step.getId()) {
StepDescriptor stepDesc = wf.getStep(historyStep.getStepId());
if (stepDesc.resultsInJoin(theResults[0].getJoin())) {
joinSteps.add(historyStep);
}
}
}
JoinNodes jn = new JoinNodes(joinSteps);
transientVars.put("jn", jn);
//todo verify that 0 is the right value for currentstep here
if (passesConditions(null, joinDesc.getConditions(), unmodifiableTransients, ps, 0)) {
// move the rest without creating a new step ...
ResultDescriptor joinresult = joinDesc.getResult();
if (joinresult.getValidators().size() > 0) {
verifyInputs(entry, joinresult.getValidators(), unmodifiableTransients, ps);
}
// now execute the pre-functions
for (Iterator iterator = joinresult.getPreFunctions().iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
long[] previousIds = new long[joinSteps.size()];
int i = 1;
for (Iterator iterator = joinSteps.iterator();
iterator.hasNext();) {
Step currentStep = (Step) iterator.next();
if (currentStep.getId() != step.getId()) {
//if this is already a history step (eg, for all join steps completed prior to this one),
//we don't move it, since it's already history.
if (!historySteps.contains(currentStep)) {
store.moveToHistory(currentStep);
}
previousIds[i] = currentStep.getId();
i++;
}
}
// ... now finish this step normally
previousIds[0] = step.getId();
theResults[0] = joinDesc.getResult();
//we pass in null for the current step since we've already moved it to history above
createNewCurrentStep(joinDesc.getResult(), entry, store, action.getId(), null, previousIds, transientVars, ps);
// now execute the post-functions
for (Iterator iterator = joinresult.getPostFunctions().iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
} else {
// normal finish, no splits or joins
long[] previousIds = null;
if (step != null) {
previousIds = new long[] {step.getId()};
}
createNewCurrentStep(theResults[0], entry, store, action.getId(), step, previousIds, transientVars, ps);
}
// postFunctions (BOTH)
if (extraPostFunctions != null) {
for (Iterator iterator = extraPostFunctions.iterator();
iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
}
List postFunctions = action.getPostFunctions();
for (Iterator iterator = postFunctions.iterator(); iterator.hasNext();) {
FunctionDescriptor function = (FunctionDescriptor) iterator.next();
executeFunction(function, transientVars, ps);
}
//if executed action was an initial action then workflow is activated
if ((wf.getInitialAction(action.getId()) != null) && (entry.getState() != WorkflowEntry.ACTIVATED)) {
changeEntryState(entry.getId(), WorkflowEntry.ACTIVATED);
}
//if it's a finish action, then we halt
if (action.isFinish()) {
completeEntry(entry.getId(), getCurrentSteps(entry.getId()));
return true;
}
//get available autoexec actions
int[] availableAutoActions = getAvailableAutoActions(entry.getId(), inputs);
for (int j = 0; j < availableAutoActions.length; j++) {
int actionId = availableAutoActions[j];
doAction(entry.getId(), actionId, inputs);
break;
}
return false;
}
}
| trim class names
| src/java/com/opensymphony/workflow/AbstractWorkflow.java | trim class names | <ide><path>rc/java/com/opensymphony/workflow/AbstractWorkflow.java
<ide>
<ide> protected Object loadObject(String clazz) {
<ide> try {
<del> return ClassLoaderUtil.loadClass(clazz, getClass()).newInstance();
<add> return ClassLoaderUtil.loadClass(clazz.trim(), getClass()).newInstance();
<ide> } catch (Exception e) {
<ide> log.error("Could not load object '" + clazz + "'", e);
<ide> |
|
Java | apache-2.0 | 7cf4e943dbdc7b6828cdcdd7fbe4f2d311a9ad3a | 0 | jansorg/BashSupport,jansorg/BashSupport,jansorg/BashSupport,jansorg/BashSupport | /*
* Copyright 2010 Joachim Ansorg, [email protected]
* File: ShellCommandParsingTest.java, Class: ShellCommandParsingTest
* Last modified: 2010-10-05
*
* 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.ansorgit.plugins.bash.lang.parser;
import com.ansorgit.plugins.bash.lang.parser.misc.ShellCommandParsing;
import junit.framework.Assert;
import org.junit.Test;
import static com.ansorgit.plugins.bash.lang.BashVersion.Bash_v3;
/**
* Date: 25.03.2009
* Time: 14:07:10
*
* @author Joachim Ansorg
*/
public class ShellCommandParsingTest extends MockPsiTest {
private final MockFunction arithmeticParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return ShellCommandParsing.arithmeticParser.parse(builder);
}
};
private final MockFunction subshellParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.subshellParser.parse(builder);
}
};
private final MockFunction ifCommandParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.ifParser.parse(builder);
}
};
private final MockFunction backquoteCommandParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.backtickParser.parse(builder);
}
};
private final MockFunction commandGroupParsingTest = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.groupCommandParser.parse(builder);
}
};
@Test
public void testIfCommand1() {
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI, FI_KEYWORD); //if a; then b c; fi
}
@Test
public void testIfCommand2() {
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI, ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD); //if a; then b c; else d; fi
}
@Test
public void testIfCommand3() {
//if a; then b c; elif d; then e &; elif a; then b; else f; fi
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testIfCommand4() {
//if a
// then b c
// elif d
// then e &
// elif a
// then b
// else f
// fi
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, LINE_FEED,
THEN_KEYWORD, WORD, WORD, LINE_FEED,
ELIF_KEYWORD, WORD, LINE_FEED, THEN_KEYWORD, WORD, LINE_FEED,
ELIF_KEYWORD, WORD, LINE_FEED, THEN_KEYWORD, WORD, LINE_FEED,
ELSE_KEYWORD, WORD, LINE_FEED, FI_KEYWORD);
}
@Test
public void testIfCommandError1() {
//code with errors
//if a; then b c; elif d; then e &;else c; elif a; then b; else f; fi
mockTestError(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testIfCommandError2() {
//if a then b; fi
mockTestError(ifCommandParsingTester,
IF_KEYWORD, WORD, THEN_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testSubshellCommand1() {
//(echo a &)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, AMP, RIGHT_PAREN);
}
@Test
public void testSubshellCommand2() {
//(echo a)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, RIGHT_PAREN
);
}
@Test
public void testSubshellCommand3() {
//(echo a)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, RIGHT_PAREN
);
}
@Test
public void testSubshellCommandEmpty() {
//()
mockTest(subshellParsingTester, LEFT_PAREN, RIGHT_PAREN);
}
@Test
public void testIsBackquoteCommand() {
//`a`
final MockPsiBuilder mockBuilder = new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE);
BashPsiBuilder b = new BashPsiBuilder(null, mockBuilder, Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//`echo` echo a ``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE, WORD, WORD, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//invalid: ``echo a`
//b = new BashPsiBuilder(new MockPsiBuilder(BACKQUOTE, BACKQUOTE, WORD, BACKQUOTE));
//Assert.assertFalse(Parsing.shellCommand.isBackquoteCommand(b));
//`echo` `echo a`
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE, BACKQUOTE, WORD, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``echo a``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, WORD, WORD, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//````
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``````
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//`
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
}
@Test
public void testBackquoteCommand() {
//`echo`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, BACKQUOTE);
//`echo a`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, WORD, BACKQUOTE);
//`echo`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, BACKQUOTE);
//``
mockTest(backquoteCommandParsingTester, BACKQUOTE, BACKQUOTE);
//`echo $((1))`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, DOLLAR, EXPR_ARITH, ARITH_NUMBER, _EXPR_ARITH, BACKQUOTE);
}
@Test
public void testBackquoteCommandErrors() {
//`echo
mockTestError(backquoteCommandParsingTester,
BACKQUOTE, WORD);
//`
mockTestError(backquoteCommandParsingTester, BACKQUOTE);
}
@Test
public void testParseGroupCommand() {
//{ echo a;}
mockTest(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, SEMI, RIGHT_CURLY);
//{ echo a; }
mockTest(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, SEMI, WHITESPACE, RIGHT_CURLY);
}
@Test
public void testParseGroupCommandError() {
//{echo a}
mockTestError(commandGroupParsingTest, LEFT_CURLY, WORD, RIGHT_CURLY);
//{ echo a}
mockTestFail(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, RIGHT_CURLY);
}
@Test
public void testParseArithmeticCommand1() {
//$((1 + 2))
mockTest(arithmeticParsingTester,
EXPR_ARITH, ARITH_NUMBER, ARITH_PLUS, ARITH_NUMBER, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand2() {
//$((1))
mockTest(arithmeticParsingTester,
EXPR_ARITH, ARITH_NUMBER, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand3() {
//$(($a && $a))
mockTest(arithmeticParsingTester,
EXPR_ARITH, VARIABLE, AND_AND, VARIABLE, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand5() {
//$(((1)))
mockTest(arithmeticParsingTester, EXPR_ARITH, LEFT_PAREN, ARITH_NUMBER, RIGHT_PAREN, _EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand6() {
//$(($(a) + 1))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
DOLLAR, LEFT_PAREN, WORD, RIGHT_PAREN, ARITH_PLUS, ARITH_NUMBER,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand7() {
//((i=$(echo 1)))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
ASSIGNMENT_WORD, EQ, DOLLAR, LEFT_PAREN, WORD, INTEGER_LITERAL, RIGHT_PAREN,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand8() {
//((i=$((1 + 9))))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
ASSIGNMENT_WORD, EQ,
DOLLAR, EXPR_ARITH, ARITH_NUMBER, ARITH_PLUS, ARITH_NUMBER, _EXPR_ARITH,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommandError1() {
//$(())
mockTestError(arithmeticParsingTester,
EXPR_ARITH, _EXPR_ARITH
);
}
}
| test/com/ansorgit/plugins/bash/lang/parser/ShellCommandParsingTest.java | /*
* Copyright 2010 Joachim Ansorg, [email protected]
* File: ShellCommandParsingTest.java, Class: ShellCommandParsingTest
* Last modified: 2010-10-05
*
* 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.ansorgit.plugins.bash.lang.parser;
import junit.framework.Assert;
import org.junit.Test;
import static com.ansorgit.plugins.bash.lang.BashVersion.Bash_v3;
/**
* Date: 25.03.2009
* Time: 14:07:10
*
* @author Joachim Ansorg
*/
public class ShellCommandParsingTest extends MockPsiTest {
private final MockFunction arithmeticParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.arithmeticParser.parse(builder);
}
};
private final MockFunction subshellParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.subshellParser.parse(builder);
}
};
private final MockFunction ifCommandParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.ifParser.parse(builder);
}
};
private final MockFunction backquoteCommandParsingTester = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.backtickParser.parse(builder);
}
};
private final MockFunction commandGroupParsingTest = new MockFunction() {
@Override
public boolean apply(BashPsiBuilder builder) {
return Parsing.shellCommand.groupCommandParser.parse(builder);
}
};
@Test
public void testIfCommand1() {
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI, FI_KEYWORD); //if a; then b c; fi
}
@Test
public void testIfCommand2() {
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI, ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD); //if a; then b c; else d; fi
}
@Test
public void testIfCommand3() {
//if a; then b c; elif d; then e &; elif a; then b; else f; fi
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testIfCommand4() {
//if a
// then b c
// elif d
// then e &
// elif a
// then b
// else f
// fi
mockTest(ifCommandParsingTester, IF_KEYWORD, WORD, LINE_FEED,
THEN_KEYWORD, WORD, WORD, LINE_FEED,
ELIF_KEYWORD, WORD, LINE_FEED, THEN_KEYWORD, WORD, LINE_FEED,
ELIF_KEYWORD, WORD, LINE_FEED, THEN_KEYWORD, WORD, LINE_FEED,
ELSE_KEYWORD, WORD, LINE_FEED, FI_KEYWORD);
}
@Test
public void testIfCommandError1() {
//code with errors
//if a; then b c; elif d; then e &;else c; elif a; then b; else f; fi
mockTestError(ifCommandParsingTester, IF_KEYWORD, WORD, SEMI,
THEN_KEYWORD, WORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELIF_KEYWORD, WORD, SEMI, THEN_KEYWORD, WORD, SEMI,
ELSE_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testIfCommandError2() {
//if a then b; fi
mockTestError(ifCommandParsingTester,
IF_KEYWORD, WORD, THEN_KEYWORD, WORD, SEMI, FI_KEYWORD);
}
@Test
public void testSubshellCommand1() {
//(echo a &)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, AMP, RIGHT_PAREN);
}
@Test
public void testSubshellCommand2() {
//(echo a)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, RIGHT_PAREN
);
}
@Test
public void testSubshellCommand3() {
//(echo a)
mockTest(subshellParsingTester,
LEFT_PAREN, WORD, WORD, RIGHT_PAREN
);
}
@Test
public void testSubshellCommandError1() {
//()
mockTestError(subshellParsingTester, LEFT_PAREN, RIGHT_PAREN);
}
@Test
public void testIsBackquoteCommand() {
//`a`
final MockPsiBuilder mockBuilder = new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE);
BashPsiBuilder b = new BashPsiBuilder(null, mockBuilder, Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//`echo` echo a ``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE, WORD, WORD, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//invalid: ``echo a`
//b = new BashPsiBuilder(new MockPsiBuilder(BACKQUOTE, BACKQUOTE, WORD, BACKQUOTE));
//Assert.assertFalse(Parsing.shellCommand.isBackquoteCommand(b));
//`echo` `echo a`
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, WORD, BACKQUOTE, BACKQUOTE, WORD, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``echo a``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, WORD, WORD, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//````
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//``````
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE, BACKQUOTE, BACKQUOTE, BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
//`
b = new BashPsiBuilder(null, new MockPsiBuilder(BACKQUOTE), Bash_v3);
Assert.assertTrue(Parsing.shellCommand.backtickParser.isValid(b));
}
@Test
public void testBackquoteCommand() {
//`echo`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, BACKQUOTE);
//`echo a`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, WORD, BACKQUOTE);
//`echo`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, BACKQUOTE);
//``
mockTest(backquoteCommandParsingTester, BACKQUOTE, BACKQUOTE);
//`echo $((1))`
mockTest(backquoteCommandParsingTester,
BACKQUOTE, WORD, DOLLAR, EXPR_ARITH, ARITH_NUMBER, _EXPR_ARITH, BACKQUOTE);
}
@Test
public void testBackquoteCommandErrors() {
//`echo
mockTestError(backquoteCommandParsingTester,
BACKQUOTE, WORD);
//`
mockTestError(backquoteCommandParsingTester, BACKQUOTE);
}
@Test
public void testParseGroupCommand() {
//{ echo a;}
mockTest(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, SEMI, RIGHT_CURLY);
//{ echo a; }
mockTest(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, SEMI, WHITESPACE, RIGHT_CURLY);
}
@Test
public void testParseGroupCommandError() {
//{echo a}
mockTestError(commandGroupParsingTest, LEFT_CURLY, WORD, RIGHT_CURLY);
//{ echo a}
mockTestFail(commandGroupParsingTest,
LEFT_CURLY, WHITESPACE, WORD, WORD, RIGHT_CURLY);
}
@Test
public void testParseArithmeticCommand1() {
//$((1 + 2))
mockTest(arithmeticParsingTester,
EXPR_ARITH, ARITH_NUMBER, ARITH_PLUS, ARITH_NUMBER, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand2() {
//$((1))
mockTest(arithmeticParsingTester,
EXPR_ARITH, ARITH_NUMBER, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand3() {
//$(($a && $a))
mockTest(arithmeticParsingTester,
EXPR_ARITH, VARIABLE, AND_AND, VARIABLE, _EXPR_ARITH
);
}
@Test
public void testParseArithmeticCommand5() {
//$(((1)))
mockTest(arithmeticParsingTester, EXPR_ARITH, LEFT_PAREN, ARITH_NUMBER, RIGHT_PAREN, _EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand6() {
//$(($(a) + 1))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
DOLLAR, LEFT_PAREN, WORD, RIGHT_PAREN, ARITH_PLUS, ARITH_NUMBER,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand7() {
//((i=$(echo 1)))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
ASSIGNMENT_WORD, EQ, DOLLAR, LEFT_PAREN, WORD, INTEGER_LITERAL, RIGHT_PAREN,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommand8() {
//((i=$((1 + 9))))
mockTest(arithmeticParsingTester,
EXPR_ARITH,
ASSIGNMENT_WORD, EQ,
DOLLAR, EXPR_ARITH, ARITH_NUMBER, ARITH_PLUS, ARITH_NUMBER, _EXPR_ARITH,
_EXPR_ARITH);
}
@Test
public void testParseArithmeticCommandError1() {
//$(())
mockTestError(arithmeticParsingTester,
EXPR_ARITH, _EXPR_ARITH
);
}
}
| Fixed error test case for empty shell command
| test/com/ansorgit/plugins/bash/lang/parser/ShellCommandParsingTest.java | Fixed error test case for empty shell command | <ide><path>est/com/ansorgit/plugins/bash/lang/parser/ShellCommandParsingTest.java
<ide>
<ide> package com.ansorgit.plugins.bash.lang.parser;
<ide>
<add>import com.ansorgit.plugins.bash.lang.parser.misc.ShellCommandParsing;
<ide> import junit.framework.Assert;
<ide> import org.junit.Test;
<ide>
<ide> private final MockFunction arithmeticParsingTester = new MockFunction() {
<ide> @Override
<ide> public boolean apply(BashPsiBuilder builder) {
<del> return Parsing.shellCommand.arithmeticParser.parse(builder);
<add> return ShellCommandParsing.arithmeticParser.parse(builder);
<ide> }
<ide> };
<ide>
<ide> }
<ide>
<ide> @Test
<del> public void testSubshellCommandError1() {
<add> public void testSubshellCommandEmpty() {
<ide> //()
<del> mockTestError(subshellParsingTester, LEFT_PAREN, RIGHT_PAREN);
<add> mockTest(subshellParsingTester, LEFT_PAREN, RIGHT_PAREN);
<ide> }
<ide>
<ide> @Test |
|
Java | apache-2.0 | 6698bea2781bdfb3fe6431e63431fb8f9034830f | 0 | phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida,phac-nml/irida | package ca.corefacility.bioinformatics.irida.ria.web;
import java.security.Principal;
import java.util.Base64;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import ca.corefacility.bioinformatics.irida.exceptions.PasswordReusedException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.mail.MailSendException;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.authentication.AnonymousAuthenticationToken;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import ca.corefacility.bioinformatics.irida.exceptions.EntityNotFoundException;
import ca.corefacility.bioinformatics.irida.model.user.PasswordReset;
import ca.corefacility.bioinformatics.irida.model.user.Role;
import ca.corefacility.bioinformatics.irida.model.user.User;
import ca.corefacility.bioinformatics.irida.service.EmailController;
import ca.corefacility.bioinformatics.irida.service.user.PasswordResetService;
import ca.corefacility.bioinformatics.irida.service.user.UserService;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
/**
* Controller for handling password reset flow
*
*/
@Controller
@RequestMapping(value = "/password_reset")
public class PasswordResetController {
private static final Logger logger = LoggerFactory.getLogger(PasswordResetController.class);
public static final String PASSWORD_RESET_PAGE = "password/password_reset";
public static final String PASSWORD_RESET_SUCCESS = "password/password_reset_success";
public static final String CREATE_RESET_PAGE = "password/create_password_reset";
public static final String RESET_CREATED_PAGE = "password/reset_created";
public static final String ACTIVATION_PAGE = "password/activate";
public static final String SUCCESS_REDIRECT = "redirect:/password_reset/success/";
public static final String CREATED_REDIRECT = "redirect:/password_reset/created/";
private final UserService userService;
private final PasswordResetService passwordResetService;
private final EmailController emailController;
private final MessageSource messageSource;
@Autowired
public PasswordResetController(UserService userService, PasswordResetService passwordResetService,
EmailController emailController, MessageSource messageSource) {
this.userService = userService;
this.passwordResetService = passwordResetService;
this.emailController = emailController;
this.messageSource = messageSource;
}
/**
* Get the password reset page
*
* @param resetId
* The ID of the {@link PasswordReset}
* @param expired
* indicates whether we're showing the reset page because of an
* expired password or a reset request.
* @param model
* A model for the page
*
* @return The string name of the page
*/
@RequestMapping(value = "/{resetId}", method = RequestMethod.GET)
public String getResetPage(@PathVariable String resetId,
@RequestParam(required = false, defaultValue = "false") boolean expired, Model model) {
setAuthentication();
PasswordReset passwordReset = passwordResetService.read(resetId);
User user = passwordReset.getUser();
model.addAttribute("user", user);
model.addAttribute("passwordReset", passwordReset);
if (expired) {
model.addAttribute("expired", true);
}
if (!model.containsAttribute("errors")) {
model.addAttribute("errors", new HashMap<>());
}
return PASSWORD_RESET_PAGE;
}
/**
* Send the new password for a given password reset
*
* @param resetId
* The ID of the {@link PasswordReset}
* @param password
* The new password to set
* @param confirmPassword
* Confirm the new password
* @param model
* A model for the given page
* @param locale
* The locale of the request
*
* @return The string name of the success view, or on failure the
* getResetPage view
*/
@RequestMapping(value = "/{resetId}", method = RequestMethod.POST)
public String sendNewPassword(@PathVariable String resetId, @RequestParam String password,
@RequestParam String confirmPassword, Model model, Locale locale) {
setAuthentication();
Map<String, String> errors = new HashMap<>();
// read the reset to verify it exists first
PasswordReset passwordReset = passwordResetService.read(resetId);
User user = passwordReset.getUser();
if (!password.equals(confirmPassword)) {
errors.put("password", messageSource.getMessage("user.edit.password.match", null, locale));
}
if (errors.isEmpty()) {
// Set the user's authentication to update the password and log them
// in
Authentication token = new UsernamePasswordAuthenticationToken(user, password, ImmutableList.of(user
.getSystemRole()));
SecurityContextHolder.getContext().setAuthentication(token);
try {
userService.changePassword(user.getId(), password);
} catch (ConstraintViolationException ex) {
Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
for (ConstraintViolation<?> violation : constraintViolations) {
logger.debug(violation.getMessage());
String errorKey = violation.getPropertyPath().toString();
errors.put(errorKey, violation.getMessage());
}
} catch (PasswordReusedException ex) {
errors.put("password", messageSource.getMessage("user.edit.passwordReused", null, locale));
}
}
if (!errors.isEmpty()) {
model.addAttribute("errors", errors);
return getResetPage(resetId, false, model);
} else {
passwordResetService.delete(resetId);
String email = Base64.getEncoder().encodeToString(user.getEmail().getBytes());
return SUCCESS_REDIRECT + email;
}
}
/**
* Success page for a password reset
*
* @param encodedEmail
* A base64 encoded email address
* @param model
* Model for the view
*
* @return The password reset success view name
*/
@RequestMapping("/success/{encodedEmail}")
public String resetSuccess(@PathVariable String encodedEmail, Model model) {
byte[] decode = Base64.getDecoder().decode(encodedEmail);
String email = new String(decode);
logger.debug("Password reset submitted for " + email);
// Authentication should not need to be set at this point, as the user
// will be logged in
User user = userService.loadUserByEmail(email);
model.addAttribute("user", user);
return PASSWORD_RESET_SUCCESS;
}
/**
* Get the reset password page
*
* @param model
* Model for this view
*
* @return The view name for the email entry page
*/
@RequestMapping(method = RequestMethod.GET)
public String noLoginResetPassword(Model model) {
return CREATE_RESET_PAGE;
}
/**
* Create a password reset for the given email address
*
* @param email
* The email address to create a password reset for
* @param model
* Model for the view
*
* @return Reset created page if the email exists in the system
*/
@RequestMapping(method = RequestMethod.POST)
public String submitEmail(@RequestParam String email, Model model) {
setAuthentication();
String page;
model.addAttribute("email", email);
try {
User user = userService.loadUserByEmail(email);
try {
createNewPasswordReset(user);
page = CREATED_REDIRECT + Base64.getEncoder().encodeToString(email.getBytes());
} catch (final MailSendException e) {
model.addAttribute("mailSendError", true);
SecurityContextHolder.clearContext();
page = noLoginResetPassword(model);
}
} catch (EntityNotFoundException ex) {
model.addAttribute("emailError", true);
SecurityContextHolder.clearContext();
page = noLoginResetPassword(model);
}
return page;
}
/**
* Success page for creating a password reset
*
* @param encodedEmail
* Base64 encoded email of the user
* @param model
* Model for the request
*
* @return View name for the reset created page
*/
@RequestMapping("/created/{encodedEmail}")
public String resetCreatedSuccess(@PathVariable String encodedEmail, Model model) {
// decode the email
byte[] decode = Base64.getDecoder().decode(encodedEmail);
String email = new String(decode);
model.addAttribute("email", email);
return RESET_CREATED_PAGE;
}
/**
* Return the activation view
*
* @param model
* Model for the view
*
* @return Name of the activation view
*/
@RequestMapping(value = "/activate", method = RequestMethod.GET)
public String activate(Model model) {
return ACTIVATION_PAGE;
}
@RequestMapping(value = "/activate", method = RequestMethod.POST)
public String getPasswordReset(@RequestParam String activationId, Model model) {
return "redirect:/password_reset/" + activationId;
}
/**
* Create a new {@link PasswordReset} for the given {@link User}
*
* @param userId
* The ID of the {@link User}
* @param principal
* a reference to the logged in user.
* @param locale
* a reference to the locale specified by the browser.
* @return a model indicating success or failure of the reset request.
*/
@RequestMapping("/ajax/create/{userId}")
@ResponseBody
@PreAuthorize("hasAnyRole('ROLE_ADMIN', 'ROLE_MANAGER')")
public Map<String, Object> adminNewPasswordReset(@PathVariable Long userId, Principal principal, Locale locale) {
User user = userService.read(userId);
User principalUser = userService.getUserByUsername(principal.getName());
Map<String, Object> response;
if (canCreatePasswordReset(principalUser, user)) {
try {
createNewPasswordReset(user);
response = ImmutableMap.of("success", true, "message", messageSource.getMessage(
"password.reset.success-message", new Object[] { user.getFirstName() }, locale), "title",
messageSource.getMessage("password.reset.success-title", null, locale));
} catch (final MailSendException e) {
logger.error("Failed to send password reset e-mail.");
response = ImmutableMap.of("success", false, "message",
messageSource.getMessage("password.reset.error-message", null, locale), "title",
messageSource.getMessage("password.reset.error-title", null, locale));
}
} else {
response = ImmutableMap.of("success", false, "message",
messageSource.getMessage("password.reset.error-message", null, locale), "title",
messageSource.getMessage("password.reset.error-title", null, locale));
}
return response;
}
/**
* Create a new password reset for a given {@link User} and send a reset
* email
*
* @param user
* The user to create the reset for
*/
private void createNewPasswordReset(User user) {
PasswordReset passwordReset = new PasswordReset(user);
passwordResetService.create(passwordReset);
// email the user their info
emailController.sendPasswordResetLinkEmail(user, passwordReset);
}
/**
* Set an anonymous authentication token
*/
private void setAuthentication() {
AnonymousAuthenticationToken anonymousToken = new AnonymousAuthenticationToken("nobody", "nobody",
ImmutableList.of(Role.ROLE_ANONYMOUS));
SecurityContextHolder.getContext().setAuthentication(anonymousToken);
}
/**
* Test if a user should be able to click the password reset button
*
* @param principalUser
* The currently logged in principal
* @param user
* The user being edited
* @return true if the principal can create a password reset for the user
*/
public static boolean canCreatePasswordReset(User principalUser, User user) {
Role userRole = user.getSystemRole();
Role principalRole = principalUser.getSystemRole();
if (principalRole.equals(Role.ROLE_ADMIN)) {
return true;
} else if (principalRole.equals(Role.ROLE_MANAGER)) {
if (userRole.equals(Role.ROLE_ADMIN)) {
return false;
} else {
return true;
}
}
return false;
}
}
| src/main/java/ca/corefacility/bioinformatics/irida/ria/web/PasswordResetController.java | package ca.corefacility.bioinformatics.irida.ria.web;
import java.security.Principal;
import java.util.Base64;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.MessageSource;
import org.springframework.mail.MailSendException;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.security.authentication.AnonymousAuthenticationToken;
import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import ca.corefacility.bioinformatics.irida.exceptions.EntityNotFoundException;
import ca.corefacility.bioinformatics.irida.model.user.PasswordReset;
import ca.corefacility.bioinformatics.irida.model.user.Role;
import ca.corefacility.bioinformatics.irida.model.user.User;
import ca.corefacility.bioinformatics.irida.service.EmailController;
import ca.corefacility.bioinformatics.irida.service.user.PasswordResetService;
import ca.corefacility.bioinformatics.irida.service.user.UserService;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
/**
* Controller for handling password reset flow
*
*/
@Controller
@RequestMapping(value = "/password_reset")
public class PasswordResetController {
private static final Logger logger = LoggerFactory.getLogger(PasswordResetController.class);
public static final String PASSWORD_RESET_PAGE = "password/password_reset";
public static final String PASSWORD_RESET_SUCCESS = "password/password_reset_success";
public static final String CREATE_RESET_PAGE = "password/create_password_reset";
public static final String RESET_CREATED_PAGE = "password/reset_created";
public static final String ACTIVATION_PAGE = "password/activate";
public static final String SUCCESS_REDIRECT = "redirect:/password_reset/success/";
public static final String CREATED_REDIRECT = "redirect:/password_reset/created/";
private final UserService userService;
private final PasswordResetService passwordResetService;
private final EmailController emailController;
private final MessageSource messageSource;
@Autowired
public PasswordResetController(UserService userService, PasswordResetService passwordResetService,
EmailController emailController, MessageSource messageSource) {
this.userService = userService;
this.passwordResetService = passwordResetService;
this.emailController = emailController;
this.messageSource = messageSource;
}
/**
* Get the password reset page
*
* @param resetId
* The ID of the {@link PasswordReset}
* @param expired
* indicates whether we're showing the reset page because of an
* expired password or a reset request.
* @param model
* A model for the page
*
* @return The string name of the page
*/
@RequestMapping(value = "/{resetId}", method = RequestMethod.GET)
public String getResetPage(@PathVariable String resetId,
@RequestParam(required = false, defaultValue = "false") boolean expired, Model model) {
setAuthentication();
PasswordReset passwordReset = passwordResetService.read(resetId);
User user = passwordReset.getUser();
model.addAttribute("user", user);
model.addAttribute("passwordReset", passwordReset);
if (expired) {
model.addAttribute("expired", true);
}
if (!model.containsAttribute("errors")) {
model.addAttribute("errors", new HashMap<>());
}
return PASSWORD_RESET_PAGE;
}
/**
* Send the new password for a given password reset
*
* @param resetId
* The ID of the {@link PasswordReset}
* @param password
* The new password to set
* @param confirmPassword
* Confirm the new password
* @param model
* A model for the given page
* @param locale
* The locale of the request
*
* @return The string name of the success view, or on failure the
* getResetPage view
*/
@RequestMapping(value = "/{resetId}", method = RequestMethod.POST)
public String sendNewPassword(@PathVariable String resetId, @RequestParam String password,
@RequestParam String confirmPassword, Model model, Locale locale) {
setAuthentication();
Map<String, String> errors = new HashMap<>();
// read the reset to verify it exists first
PasswordReset passwordReset = passwordResetService.read(resetId);
User user = passwordReset.getUser();
if (!password.equals(confirmPassword)) {
errors.put("password", messageSource.getMessage("user.edit.password.match", null, locale));
}
if (errors.isEmpty()) {
// Set the user's authentication to update the password and log them
// in
Authentication token = new UsernamePasswordAuthenticationToken(user, password, ImmutableList.of(user
.getSystemRole()));
SecurityContextHolder.getContext().setAuthentication(token);
try {
userService.changePassword(user.getId(), password);
} catch (ConstraintViolationException ex) {
Set<ConstraintViolation<?>> constraintViolations = ex.getConstraintViolations();
for (ConstraintViolation<?> violation : constraintViolations) {
logger.debug(violation.getMessage());
String errorKey = violation.getPropertyPath().toString();
errors.put(errorKey, violation.getMessage());
}
}
}
if (!errors.isEmpty()) {
model.addAttribute("errors", errors);
return getResetPage(resetId, false, model);
} else {
passwordResetService.delete(resetId);
String email = Base64.getEncoder().encodeToString(user.getEmail().getBytes());
return SUCCESS_REDIRECT + email;
}
}
/**
* Success page for a password reset
*
* @param encodedEmail
* A base64 encoded email address
* @param model
* Model for the view
*
* @return The password reset success view name
*/
@RequestMapping("/success/{encodedEmail}")
public String resetSuccess(@PathVariable String encodedEmail, Model model) {
byte[] decode = Base64.getDecoder().decode(encodedEmail);
String email = new String(decode);
logger.debug("Password reset submitted for " + email);
// Authentication should not need to be set at this point, as the user
// will be logged in
User user = userService.loadUserByEmail(email);
model.addAttribute("user", user);
return PASSWORD_RESET_SUCCESS;
}
/**
* Get the reset password page
*
* @param model
* Model for this view
*
* @return The view name for the email entry page
*/
@RequestMapping(method = RequestMethod.GET)
public String noLoginResetPassword(Model model) {
return CREATE_RESET_PAGE;
}
/**
* Create a password reset for the given email address
*
* @param email
* The email address to create a password reset for
* @param model
* Model for the view
*
* @return Reset created page if the email exists in the system
*/
@RequestMapping(method = RequestMethod.POST)
public String submitEmail(@RequestParam String email, Model model) {
setAuthentication();
String page;
model.addAttribute("email", email);
try {
User user = userService.loadUserByEmail(email);
try {
createNewPasswordReset(user);
page = CREATED_REDIRECT + Base64.getEncoder().encodeToString(email.getBytes());
} catch (final MailSendException e) {
model.addAttribute("mailSendError", true);
SecurityContextHolder.clearContext();
page = noLoginResetPassword(model);
}
} catch (EntityNotFoundException ex) {
model.addAttribute("emailError", true);
SecurityContextHolder.clearContext();
page = noLoginResetPassword(model);
}
return page;
}
/**
* Success page for creating a password reset
*
* @param encodedEmail
* Base64 encoded email of the user
* @param model
* Model for the request
*
* @return View name for the reset created page
*/
@RequestMapping("/created/{encodedEmail}")
public String resetCreatedSuccess(@PathVariable String encodedEmail, Model model) {
// decode the email
byte[] decode = Base64.getDecoder().decode(encodedEmail);
String email = new String(decode);
model.addAttribute("email", email);
return RESET_CREATED_PAGE;
}
/**
* Return the activation view
*
* @param model
* Model for the view
*
* @return Name of the activation view
*/
@RequestMapping(value = "/activate", method = RequestMethod.GET)
public String activate(Model model) {
return ACTIVATION_PAGE;
}
@RequestMapping(value = "/activate", method = RequestMethod.POST)
public String getPasswordReset(@RequestParam String activationId, Model model) {
return "redirect:/password_reset/" + activationId;
}
/**
* Create a new {@link PasswordReset} for the given {@link User}
*
* @param userId
* The ID of the {@link User}
* @param principal
* a reference to the logged in user.
* @param locale
* a reference to the locale specified by the browser.
* @return a model indicating success or failure of the reset request.
*/
@RequestMapping("/ajax/create/{userId}")
@ResponseBody
@PreAuthorize("hasAnyRole('ROLE_ADMIN', 'ROLE_MANAGER')")
public Map<String, Object> adminNewPasswordReset(@PathVariable Long userId, Principal principal, Locale locale) {
User user = userService.read(userId);
User principalUser = userService.getUserByUsername(principal.getName());
Map<String, Object> response;
if (canCreatePasswordReset(principalUser, user)) {
try {
createNewPasswordReset(user);
response = ImmutableMap.of("success", true, "message", messageSource.getMessage(
"password.reset.success-message", new Object[] { user.getFirstName() }, locale), "title",
messageSource.getMessage("password.reset.success-title", null, locale));
} catch (final MailSendException e) {
logger.error("Failed to send password reset e-mail.");
response = ImmutableMap.of("success", false, "message",
messageSource.getMessage("password.reset.error-message", null, locale), "title",
messageSource.getMessage("password.reset.error-title", null, locale));
}
} else {
response = ImmutableMap.of("success", false, "message",
messageSource.getMessage("password.reset.error-message", null, locale), "title",
messageSource.getMessage("password.reset.error-title", null, locale));
}
return response;
}
/**
* Create a new password reset for a given {@link User} and send a reset
* email
*
* @param user
* The user to create the reset for
*/
private void createNewPasswordReset(User user) {
PasswordReset passwordReset = new PasswordReset(user);
passwordResetService.create(passwordReset);
// email the user their info
emailController.sendPasswordResetLinkEmail(user, passwordReset);
}
/**
* Set an anonymous authentication token
*/
private void setAuthentication() {
AnonymousAuthenticationToken anonymousToken = new AnonymousAuthenticationToken("nobody", "nobody",
ImmutableList.of(Role.ROLE_ANONYMOUS));
SecurityContextHolder.getContext().setAuthentication(anonymousToken);
}
/**
* Test if a user should be able to click the password reset button
*
* @param principalUser
* The currently logged in principal
* @param user
* The user being edited
* @return true if the principal can create a password reset for the user
*/
public static boolean canCreatePasswordReset(User principalUser, User user) {
Role userRole = user.getSystemRole();
Role principalRole = principalUser.getSystemRole();
if (principalRole.equals(Role.ROLE_ADMIN)) {
return true;
} else if (principalRole.equals(Role.ROLE_MANAGER)) {
if (userRole.equals(Role.ROLE_ADMIN)) {
return false;
} else {
return true;
}
}
return false;
}
}
| added catch for reused password in reset controller
| src/main/java/ca/corefacility/bioinformatics/irida/ria/web/PasswordResetController.java | added catch for reused password in reset controller | <ide><path>rc/main/java/ca/corefacility/bioinformatics/irida/ria/web/PasswordResetController.java
<ide> import javax.validation.ConstraintViolation;
<ide> import javax.validation.ConstraintViolationException;
<ide>
<add>import ca.corefacility.bioinformatics.irida.exceptions.PasswordReusedException;
<ide> import org.slf4j.Logger;
<ide> import org.slf4j.LoggerFactory;
<ide> import org.springframework.beans.factory.annotation.Autowired;
<ide> String errorKey = violation.getPropertyPath().toString();
<ide> errors.put(errorKey, violation.getMessage());
<ide> }
<add> } catch (PasswordReusedException ex) {
<add> errors.put("password", messageSource.getMessage("user.edit.passwordReused", null, locale));
<ide> }
<ide> }
<ide> |
|
Java | bsd-2-clause | 55ef2c81a63dc9af829ca55b9c5c9d41aba8295c | 0 | athy/fape,athy/fape,athy/fape,athy/fape | package fape.core.planning.preprocessing;
import fape.core.planning.states.State;
import fape.core.planning.timelines.Timeline;
import lombok.Value;
import planstack.anml.model.*;
import planstack.anml.model.Function;
import planstack.anml.model.abs.AbstractAction;
import planstack.anml.model.abs.AbstractTask;
import planstack.anml.model.abs.statements.AbstractLogStatement;
import planstack.anml.model.concrete.InstanceRef;
import planstack.anml.model.concrete.Task;
import planstack.anml.model.concrete.VarRef;
import planstack.constraints.bindings.Domain;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;
public class HierarchicalEffects {
@Value private class StatementPointer {
final AbstractAction act;
final LStatementRef ref;
final boolean isTransition;
}
@Value private class Effect {
@Value class Fluent {
final Function func;
final List<VarPlaceHolder> args;
final VarPlaceHolder value;
}
final int delayFromStart;
final int delayToEnd;
final Fluent f;
final List<StatementPointer> origin;
Effect(int delayFromStart, int delayToEnd,
Function func, List<VarPlaceHolder> args, VarPlaceHolder value,
List<StatementPointer> origin) {
this.delayFromStart = delayFromStart;
this.delayToEnd = delayToEnd;
this.f = new Fluent(func, args, value);
this.origin = origin;
}
@Override public String toString() { return "Eff(~>"+delayFromStart+" "+delayToEnd+"<~ "+f.func.name()+f.args+"="+f.value; }
Effect asEffectOfTask(String t) {
List<LVarRef> vars = pb.actionsByTask().get(t).get(0).args();
// function that only keep a variable if it appears in the arguments of the task
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(!v.isVar() || vars.contains(v.asVar()))
return v;
else
return new TypePlaceHolder(v.asType());
};
return new Effect(
delayFromStart,
delayToEnd,
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
Effect asEffectBySubtask(AbstractAction a, AbstractTask t) {
Map<LVarRef,VarPlaceHolder> mapping = new HashMap<>();
List<LVarRef> taskVars = pb.actionsByTask().get(t.name()).get(0).args();
for(int i=0 ; i<taskVars.size() ; i++) {
LVarRef right = t.jArgs().get(i);
if(a.context().hasGlobalVar(right) && a.context().getGlobalVar(right) instanceof InstanceRef)
mapping.put(taskVars.get(i), new InstanceArg((InstanceRef) a.context().getGlobalVar(right)));
else
mapping.put(taskVars.get(i), new LVarArg(t.jArgs().get(i)));
}
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(v.isVar())
return mapping.get(v.asVar());
else
return v;
};
return new Effect(
delayFromStart + a.minDelay(a.start(), t.start()).lb(),
delayToEnd + a.minDelay(t.end(), a.end()).lb(),
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
Effect asEffectOfSubtask(AbstractAction a, Subtask t) {
assert a.taskName().equals(t.taskName);
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(v.isVar() && a.args().contains(v.asVar()))
return t.args.get(a.args().indexOf(v.asVar()));
else if(v.isVar())
return new TypePlaceHolder(v.asType());
else
return v;
};
return new Effect(
delayFromStart + t.delayFromStart,
delayToEnd + t.delayToEnd,
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
}
@Value private class Subtask {
final int delayFromStart;
final int delayToEnd;
final String taskName;
final List<VarPlaceHolder> args;
}
private interface VarPlaceHolder {
boolean isVar();
default boolean isInstance() { return false; };
default LVarRef asVar() { throw new UnsupportedOperationException("Not supported yet."); }
Type asType();
default InstanceRef asInstance() { throw new UnsupportedOperationException(); }
}
@Value private class LVarArg implements VarPlaceHolder {
final LVarRef var;
@Override public boolean isVar() { return true; }
@Override public LVarRef asVar() { return var; }
@Override public Type asType() { return var.getType(); }
@Override public String toString() { return var.toString(); }
}
@Value private class InstanceArg implements VarPlaceHolder {
final InstanceRef var;
@Override public boolean isVar() { return false; }
@Override public boolean isInstance() { return true; }
@Override public InstanceRef asInstance() { return var; }
@Override public Type asType() { return var.getType(); }
@Override public String toString() { return var.toString(); }
}
@Value private class TypePlaceHolder implements VarPlaceHolder {
final Type type;
@Override public boolean isVar() { return false; }
@Override public Type asType() { return type; }
@Override public String toString() { return type.toString(); }
}
private final AnmlProblem pb;
private Map<String, List<Effect>> tasksEffects = new HashMap<>();
private Map<AbstractAction, List<Effect>> actionEffects = new HashMap<>();
private Map<AbstractAction, List<Effect>> directActionEffects = new HashMap<>();
private Map<String, List<Subtask>> subtasks = new HashMap<>();
HierarchicalEffects(AnmlProblem pb) {
this.pb = pb;
}
private List<Effect> regrouped(List<Effect> effects) {
Map<Effect.Fluent, List<Effect>> grouped = effects.stream().collect(Collectors.groupingBy(Effect::getF));
List<Effect> reduced = grouped.keySet().stream().map(f -> {
int minFromStart = grouped.get(f).stream().map(e -> e.delayFromStart).min(Integer::compare).get();
int minToEnd = grouped.get(f).stream().map(e -> e.delayToEnd).min(Integer::compare).get();
List<StatementPointer> origins = grouped.get(f).stream().flatMap(e -> e.getOrigin().stream()).collect(Collectors.toList());
return new Effect(minFromStart, minToEnd, f.func, f.args, f.value, origins);
}).collect(Collectors.toList());
return reduced;
}
private List<LVarRef> argsOfTask(String t) { return pb.actionsByTask().get(t).get(0).args(); }
private List<AbstractAction> methodsOfTask(String t) { return pb.actionsByTask().get(t); }
/** Returns the effects that appear in the body of this action (regardless of its subtasks. */
private List<Effect> directEffectsOf(AbstractAction a) {
java.util.function.Function<LVarRef,VarPlaceHolder> asPlaceHolder = (v) -> {
if(a.context().hasGlobalVar(v) && a.context().getGlobalVar(v) instanceof InstanceRef)
return new InstanceArg((InstanceRef) a.context().getGlobalVar(v));
else
return new LVarArg(v);
};
if (!directActionEffects.containsKey(a)) {
List<Effect> directEffects = a.jLogStatements().stream()
.filter(AbstractLogStatement::hasEffectAtEnd)
.map(s -> new Effect(
a.minDelay(a.start(), s.end()).lb(),
a.minDelay(s.end(), a.end()).lb(),
s.sv().func(),
s.sv().jArgs().stream().map(asPlaceHolder).collect(Collectors.toList()),
asPlaceHolder.apply(s.effectValue()),
Collections.singletonList(new StatementPointer(a, s.id(), s.hasConditionAtStart()))))
.collect(Collectors.toList());
directActionEffects.put(a, regrouped(directEffects));
}
return directActionEffects.get(a);
}
/** Union of the direct effects of all methods for this task */
private List<Effect> directEffectsOf(Subtask t) {
return methodsOfTask(t.taskName).stream()
.flatMap(a -> directEffectsOf(a).stream().map(e -> e.asEffectOfSubtask(a, t)))
.collect(Collectors.toList());
}
/** all effects that can be introduced in the plan by completly decomposing this task */
private List<Effect> effectsOf(String task) {
if(!tasksEffects.containsKey(task)) {
tasksEffects.put(task,
subtasksOf(task).stream()
.flatMap(sub -> directEffectsOf(sub).stream())
.collect(Collectors.toList()));
}
return tasksEffects.get(task);
}
/** All subtasks of t, including t */
private Collection<Subtask> subtasksOf(String task) {
if(!this.subtasks.containsKey(task)) {
HashSet<Subtask> subtasks = new HashSet<>();
Subtask t = new Subtask(0, 0, task, argsOfTask(task).stream().map(LVarArg::new).collect(Collectors.toList()));
populateSubtasksOf(t, subtasks);
this.subtasks.put(task, subtasks.stream().collect(Collectors.toList()));
}
return this.subtasks.get(task);
}
/** This method recursively populates the set of subtasks with all subtasks of t (including t). */
private void populateSubtasksOf(Subtask t, Set<Subtask> allsubtasks) {
for(Subtask prev : allsubtasks) {
if(t.taskName.equals(prev.taskName)
&& t.args.equals(prev.args)
&& prev.delayFromStart >= t.delayFromStart) {
allsubtasks.remove(prev);
Subtask merged = new Subtask(
Math.min(t.delayFromStart, prev.delayFromStart),
Math.min(t.delayToEnd, prev.delayToEnd),
t.taskName,
t.args);
allsubtasks.add(merged);
return;
}
}
allsubtasks.add(t);
for(AbstractAction a : methodsOfTask(t.taskName)) {
java.util.function.Function<LVarRef,VarPlaceHolder> trans = v -> {
if(a.args().contains(v))
return t.args.get(a.args().indexOf(v));
else if(a.context().hasGlobalVar(v) && a.context().getGlobalVar(v) instanceof InstanceRef)
return new InstanceArg((InstanceRef) a.context().getGlobalVar(v));
else
return new TypePlaceHolder(v.getType());
};
for(AbstractTask at : a.jSubTasks()) {
Subtask sub = new Subtask(
a.minDelay(a.start(), at.start()).lb(),
a.minDelay(at.end(), a.end()).lb(),
at.name(),
at.jArgs().stream().map(trans).collect(Collectors.toList())
);
populateSubtasksOf(sub, allsubtasks);
}
}
}
private List<Effect> effectsOf(AbstractAction a) {
if(!actionEffects.containsKey(a)) {
List<Effect> undirEffects = a.jSubTasks().stream()
.flatMap(t -> effectsOf(t.name()).stream().map(e -> e.asEffectBySubtask(a, t)))
.collect(Collectors.toList());
List<Effect> effects = new ArrayList<>(directEffectsOf(a));
effects.addAll(undirEffects);
actionEffects.put(a, regrouped(effects));
}
return actionEffects.get(a);
}
@Value private static class DomainList {
List<Domain> l;
/** True if the two lists are compatible: all pairs of domains have a non empty intersection */
boolean compatible(DomainList dl) {
assert l.size() == dl.l.size();
for(int i=0 ; i<l.size() ; i++) {
if(l.get(i).intersect(dl.l.get(i)).isEmpty())
return false;
}
return true;
}
private static Domain asDomain(VarRef v, State st) { return st.csp.bindings().rawDomain(v); }
private static Domain asDomain(Type t, State st) { return st.csp.bindings().defaultDomain(t); }
private static Domain asDomain(VarPlaceHolder v, Map<LVarRef,VarRef> bindings, State st) {
if(v.isVar()) {
assert bindings.containsKey(v.asVar());
return asDomain(bindings.get(v.asVar()), st);
} else if(v.isInstance()) {
return asDomain(v.asInstance(), st);
} else {
return asDomain(v.asType(), st);
}
}
private static Domain asDomainFromLocalVars(VarPlaceHolder v, State st) {
if(v.isInstance()) {
return asDomain(v.asInstance(), st);
} else {
return asDomain(v.asType(), st);
}
}
private static DomainList from(ParameterizedStateVariable sv, VarRef value, State st) {
return new DomainList(Stream.concat(
Stream.of(sv.args()).map(v -> asDomain(v, st)),
Stream.of(asDomain(value, st)))
.collect(Collectors.toList()));
}
private static DomainList from(Effect.Fluent f, Map<LVarRef,VarRef> bindings, State st) {
return new DomainList(
Stream.concat(
f.getArgs().stream().map(v -> asDomain(v, bindings, st)),
Stream.of(asDomain(f.getValue(), bindings, st)))
.collect(Collectors.toList()));
}
private static DomainList from(Effect.Fluent f, State st) {
return new DomainList(
Stream.concat(
f.getArgs().stream().map(v -> asDomainFromLocalVars(v, st)),
Stream.of(asDomainFromLocalVars(f.getValue(), st)))
.collect(Collectors.toList()));
}
}
/**
* A task can indirectly support an open goal if it can be decomposed in an action
* producing a statement (i) that can support the open goal (ii) that can be early enough to support it
*/
public boolean canIndirectlySupport(Timeline og, Task t, State st) {
DomainList dl = DomainList.from(og.stateVariable, og.getGlobalConsumeValue(), st);
Map<LVarRef, VarRef> bindings = new HashMap<>();
for(int i=0 ; i<t.args().size() ; i++) {
LVarRef localVar = st.pb.actionsByTask().get(t.name()).get(0).args().get(i);
bindings.put(localVar, t.args().get(i));
}
return effectsOf(t.name()).stream()
.filter(effect -> effect.f.func == og.stateVariable.func())
.filter(effect -> st.csp.stn().isDelayPossible(t.start(), og.getConsumeTimePoint(), effect.delayFromStart))
.map(effect -> DomainList.from(effect.f, bindings, st))
.anyMatch(domainList -> domainList.compatible(dl));
}
/**
* A task can indirectly support an open goal if it can be decomposed in an action
* producing a statement (i) that can support the open goal (ii) that can be early enough to support it
*/
public boolean canSupport(Timeline og, AbstractAction aa, State st) {
DomainList dl = DomainList.from(og.stateVariable, og.getGlobalConsumeValue(), st);
return effectsOf(aa).stream()
.filter(effect -> effect.f.func == og.stateVariable.func())
.map(effect -> DomainList.from(effect.f, st))
.anyMatch(domainList -> domainList.compatible(dl));
}
private HashMap<Function,Boolean> _hasAssignmentInAction = new HashMap<>();
public boolean hasAssignmentsInAction(Function func) {
return _hasAssignmentInAction.computeIfAbsent(func, f ->
pb.abstractActions().stream().flatMap(a -> effectsOf(a).stream())
.filter(effect -> effect.f.func == f)
.flatMap(effect -> effect.origin.stream())
.anyMatch(statementPointer -> !statementPointer.isTransition));
}
}
| planning/src/main/java/fape/core/planning/preprocessing/HierarchicalEffects.java | package fape.core.planning.preprocessing;
import fape.core.planning.states.State;
import fape.core.planning.timelines.Timeline;
import lombok.Value;
import planstack.anml.model.*;
import planstack.anml.model.Function;
import planstack.anml.model.abs.AbstractAction;
import planstack.anml.model.abs.AbstractTask;
import planstack.anml.model.abs.statements.AbstractLogStatement;
import planstack.anml.model.concrete.InstanceRef;
import planstack.anml.model.concrete.Task;
import planstack.anml.model.concrete.VarRef;
import planstack.constraints.bindings.Domain;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;
public class HierarchicalEffects {
@Value private class StatementPointer {
final AbstractAction act;
final LStatementRef ref;
final boolean isTransition;
}
@Value private class Effect {
@Value class Fluent {
final Function func;
final List<VarPlaceHolder> args;
final VarPlaceHolder value;
}
final int delayFromStart;
final int delayToEnd;
final Fluent f;
final List<StatementPointer> origin;
Effect(int delayFromStart, int delayToEnd,
Function func, List<VarPlaceHolder> args, VarPlaceHolder value,
List<StatementPointer> origin) {
this.delayFromStart = delayFromStart;
this.delayToEnd = delayToEnd;
this.f = new Fluent(func, args, value);
this.origin = origin;
}
@Override public String toString() { return "Eff(~>"+delayFromStart+" "+delayToEnd+"<~ "+f.func.name()+f.args+"="+f.value; }
Effect asEffectOfTask(String t) {
List<LVarRef> vars = pb.actionsByTask().get(t).get(0).args();
// function that only keep a variable if it appears in the arguments of the task
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(!v.isVar() || vars.contains(v.asVar()))
return v;
else
return new TypePlaceHolder(v.asType());
};
return new Effect(
delayFromStart,
delayToEnd,
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
Effect asEffectBySubtask(AbstractAction a, AbstractTask t) {
Map<LVarRef,VarPlaceHolder> mapping = new HashMap<>();
List<LVarRef> taskVars = pb.actionsByTask().get(t.name()).get(0).args();
for(int i=0 ; i<taskVars.size() ; i++) {
LVarRef right = t.jArgs().get(i);
if(a.context().hasGlobalVar(right) && a.context().getGlobalVar(right) instanceof InstanceRef)
mapping.put(taskVars.get(i), new InstanceArg((InstanceRef) a.context().getGlobalVar(right)));
else
mapping.put(taskVars.get(i), new LVarArg(t.jArgs().get(i)));
}
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(v.isVar())
return mapping.get(v.asVar());
else
return v;
};
return new Effect(
delayFromStart + a.minDelay(a.start(), t.start()).lb(),
delayToEnd + a.minDelay(t.end(), a.end()).lb(),
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
Effect withoutVars() {
java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
if(v.isVar())
return new TypePlaceHolder(v.asType());
else
return v;
};
return new Effect(
delayFromStart,
delayToEnd,
f.func,
f.args.stream().map(trans).collect(Collectors.toList()),
trans.apply(f.value),
origin);
}
}
private interface VarPlaceHolder {
boolean isVar();
default boolean isInstance() { return false; };
default LVarRef asVar() { throw new UnsupportedOperationException("Not supported yet."); }
Type asType();
default InstanceRef asInstance() { throw new UnsupportedOperationException(); }
}
@Value private class LVarArg implements VarPlaceHolder {
final LVarRef var;
@Override public boolean isVar() { return true; }
@Override public LVarRef asVar() { return var; }
@Override public Type asType() { return var.getType(); }
@Override public String toString() { return var.toString(); }
}
@Value private class InstanceArg implements VarPlaceHolder {
final InstanceRef var;
@Override public boolean isVar() { return false; }
@Override public boolean isInstance() { return true; }
@Override public InstanceRef asInstance() { return var; }
@Override public Type asType() { return var.getType(); }
@Override public String toString() { return var.toString(); }
}
@Value private class TypePlaceHolder implements VarPlaceHolder {
final Type type;
@Override public boolean isVar() { return false; }
@Override public Type asType() { return type; }
@Override public String toString() { return type.toString(); }
}
private final AnmlProblem pb;
private Map<String, List<Effect>> tasksEffects = new HashMap<>();
private Map<AbstractAction, List<Effect>> actionEffects = new HashMap<>();
private Set<String> pendingTasks = new HashSet<>();
private Set<String> recTasks = new HashSet<>();
public HierarchicalEffects(AnmlProblem pb) {
this.pb = pb;
}
private List<Effect> regrouped(List<Effect> effects) {
Map<Effect.Fluent, List<Effect>> grouped = effects.stream().collect(Collectors.groupingBy(Effect::getF));
List<Effect> reduced = grouped.keySet().stream().map(f -> {
int minFromStart = grouped.get(f).stream().map(e -> e.delayFromStart).min(Integer::compare).get();
int minToEnd = grouped.get(f).stream().map(e -> e.delayToEnd).min(Integer::compare).get();
List<StatementPointer> origins = grouped.get(f).stream().flatMap(e -> e.getOrigin().stream()).collect(Collectors.toList());
return new Effect(minFromStart, minToEnd, f.func, f.args, f.value, origins);
}).collect(Collectors.toList());
return reduced;
}
private List<Effect> effectsOf(AbstractAction a) {
java.util.function.Function<LVarRef,VarPlaceHolder> asPlaceHolder = (v) -> {
if(a.context().hasGlobalVar(v) && a.context().getGlobalVar(v) instanceof InstanceRef)
return new InstanceArg((InstanceRef) a.context().getGlobalVar(v));
else
return new LVarArg(v);
};
if (!actionEffects.containsKey(a)) {
List<Effect> directEffects = a.jLogStatements().stream()
.filter(AbstractLogStatement::hasEffectAtEnd)
.map(s -> new Effect(
a.minDelay(a.start(), s.end()).lb(),
a.minDelay(s.end(), a.end()).lb(),
s.sv().func(),
s.sv().jArgs().stream().map(asPlaceHolder).collect(Collectors.toList()),
asPlaceHolder.apply(s.effectValue()),
Collections.singletonList(new StatementPointer(a, s.id(), s.hasConditionAtStart()))))
.collect(Collectors.toList());
List<Effect> undirEffects = a.jSubTasks().stream()
.flatMap(t -> effectsOf(t.name()).stream().map(e -> e.asEffectBySubtask(a, t)))
.collect(Collectors.toList());
List<Effect> effects = new ArrayList<>(directEffects);
effects.addAll(undirEffects);
actionEffects.put(a, regrouped(effects));
}
return actionEffects.get(a);
}
private List<Effect> effectsOf(String task) {
if(!tasksEffects.containsKey(task)) {
if(pendingTasks.contains(task)) {
recTasks.add(task);
return Collections.emptyList();
} else {
pendingTasks.add(task);
List<Effect> effs = pb.actionsByTask().get(task).stream()
.flatMap(a -> effectsOf(a).stream())
.map(e -> e.asEffectOfTask(task))
.collect(Collectors.toList());
if (recTasks.contains(task)) {
// this task is recursive, remove any vars to make sure to do not miss any effect
tasksEffects.put(task, regrouped(effs.stream().map(Effect::withoutVars).collect(Collectors.toList())));
} else {
tasksEffects.put(task, regrouped(effs));
}
}
}
return tasksEffects.get(task);
}
@Value private static class DomainList {
List<Domain> l;
/** True if the two lists are compatible: all pairs of domains have a non empty intersection */
boolean compatible(DomainList dl) {
assert l.size() == dl.l.size();
for(int i=0 ; i<l.size() ; i++) {
if(l.get(i).intersect(dl.l.get(i)).isEmpty())
return false;
}
return true;
}
private static Domain asDomain(VarRef v, State st) { return st.csp.bindings().rawDomain(v); }
private static Domain asDomain(Type t, State st) { return st.csp.bindings().defaultDomain(t); }
private static Domain asDomain(VarPlaceHolder v, Map<LVarRef,VarRef> bindings, State st) {
if(v.isVar()) {
assert bindings.containsKey(v.asVar());
return asDomain(bindings.get(v.asVar()), st);
} else if(v.isInstance()) {
return asDomain(v.asInstance(), st);
} else {
return asDomain(v.asType(), st);
}
}
private static Domain asDomainFromLocalVars(VarPlaceHolder v, State st) {
if(v.isInstance()) {
return asDomain(v.asInstance(), st);
} else {
return asDomain(v.asType(), st);
}
}
private static DomainList from(ParameterizedStateVariable sv, VarRef value, State st) {
return new DomainList(Stream.concat(
Stream.of(sv.args()).map(v -> asDomain(v, st)),
Stream.of(asDomain(value, st)))
.collect(Collectors.toList()));
}
private static DomainList from(Effect.Fluent f, Map<LVarRef,VarRef> bindings, State st) {
return new DomainList(
Stream.concat(
f.getArgs().stream().map(v -> asDomain(v, bindings, st)),
Stream.of(asDomain(f.getValue(), bindings, st)))
.collect(Collectors.toList()));
}
private static DomainList from(Effect.Fluent f, State st) {
return new DomainList(
Stream.concat(
f.getArgs().stream().map(v -> asDomainFromLocalVars(v, st)),
Stream.of(asDomainFromLocalVars(f.getValue(), st)))
.collect(Collectors.toList()));
}
}
/**
* A task can indirectly support an open goal if it can be decomposed in an action
* producing a statement (i) that can support the open goal (ii) that can be early enough to support it
*/
public boolean canIndirectlySupport(Timeline og, Task t, State st) {
DomainList dl = DomainList.from(og.stateVariable, og.getGlobalConsumeValue(), st);
Map<LVarRef, VarRef> bindings = new HashMap<>();
for(int i=0 ; i<t.args().size() ; i++) {
LVarRef localVar = st.pb.actionsByTask().get(t.name()).get(0).args().get(i);
bindings.put(localVar, t.args().get(i));
}
return effectsOf(t.name()).stream()
.filter(effect -> effect.f.func == og.stateVariable.func())
.filter(effect -> st.csp.stn().isDelayPossible(t.start(), og.getConsumeTimePoint(), effect.delayFromStart))
.map(effect -> DomainList.from(effect.f, bindings, st))
.anyMatch(domainList -> domainList.compatible(dl));
}
/**
* A task can indirectly support an open goal if it can be decomposed in an action
* producing a statement (i) that can support the open goal (ii) that can be early enough to support it
*/
public boolean canSupport(Timeline og, AbstractAction aa, State st) {
DomainList dl = DomainList.from(og.stateVariable, og.getGlobalConsumeValue(), st);
return effectsOf(aa).stream()
.filter(effect -> effect.f.func == og.stateVariable.func())
.map(effect -> DomainList.from(effect.f, st))
.anyMatch(domainList -> domainList.compatible(dl));
}
private HashMap<Function,Boolean> _hasAssignmentInAction = new HashMap<>();
public boolean hasAssignmentsInAction(Function func) {
return _hasAssignmentInAction.computeIfAbsent(func, f ->
pb.abstractActions().stream().flatMap(a -> effectsOf(a).stream())
.filter(effect -> effect.f.func == f)
.flatMap(effect -> effect.origin.stream())
.anyMatch(statementPointer -> !statementPointer.isTransition));
}
}
| [planning] The set of possible effects of a task is now more precise.
| planning/src/main/java/fape/core/planning/preprocessing/HierarchicalEffects.java | [planning] The set of possible effects of a task is now more precise. | <ide><path>lanning/src/main/java/fape/core/planning/preprocessing/HierarchicalEffects.java
<ide> mapping.put(taskVars.get(i), new LVarArg(t.jArgs().get(i)));
<ide> }
<ide> java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
<del> if(v.isVar())
<del> return mapping.get(v.asVar());
<del> else
<del> return v;
<add> if(v.isVar())
<add> return mapping.get(v.asVar());
<add> else
<add> return v;
<ide> };
<ide> return new Effect(
<ide> delayFromStart + a.minDelay(a.start(), t.start()).lb(),
<ide> origin);
<ide> }
<ide>
<del> Effect withoutVars() {
<add> Effect asEffectOfSubtask(AbstractAction a, Subtask t) {
<add> assert a.taskName().equals(t.taskName);
<ide> java.util.function.Function<VarPlaceHolder,VarPlaceHolder> trans = (v) -> {
<del> if(v.isVar())
<del> return new TypePlaceHolder(v.asType());
<del> else
<del> return v;
<add> if(v.isVar() && a.args().contains(v.asVar()))
<add> return t.args.get(a.args().indexOf(v.asVar()));
<add> else if(v.isVar())
<add> return new TypePlaceHolder(v.asType());
<add> else
<add> return v;
<ide> };
<ide> return new Effect(
<del> delayFromStart,
<del> delayToEnd,
<add> delayFromStart + t.delayFromStart,
<add> delayToEnd + t.delayToEnd,
<ide> f.func,
<ide> f.args.stream().map(trans).collect(Collectors.toList()),
<ide> trans.apply(f.value),
<ide> origin);
<ide> }
<add> }
<add> @Value private class Subtask {
<add> final int delayFromStart;
<add> final int delayToEnd;
<add> final String taskName;
<add> final List<VarPlaceHolder> args;
<ide> }
<ide> private interface VarPlaceHolder {
<ide> boolean isVar();
<ide> private final AnmlProblem pb;
<ide> private Map<String, List<Effect>> tasksEffects = new HashMap<>();
<ide> private Map<AbstractAction, List<Effect>> actionEffects = new HashMap<>();
<del> private Set<String> pendingTasks = new HashSet<>();
<del> private Set<String> recTasks = new HashSet<>();
<del>
<del> public HierarchicalEffects(AnmlProblem pb) {
<add> private Map<AbstractAction, List<Effect>> directActionEffects = new HashMap<>();
<add> private Map<String, List<Subtask>> subtasks = new HashMap<>();
<add>
<add> HierarchicalEffects(AnmlProblem pb) {
<ide> this.pb = pb;
<ide> }
<ide>
<ide> return reduced;
<ide> }
<ide>
<del> private List<Effect> effectsOf(AbstractAction a) {
<add> private List<LVarRef> argsOfTask(String t) { return pb.actionsByTask().get(t).get(0).args(); }
<add> private List<AbstractAction> methodsOfTask(String t) { return pb.actionsByTask().get(t); }
<add>
<add> /** Returns the effects that appear in the body of this action (regardless of its subtasks. */
<add> private List<Effect> directEffectsOf(AbstractAction a) {
<ide> java.util.function.Function<LVarRef,VarPlaceHolder> asPlaceHolder = (v) -> {
<ide> if(a.context().hasGlobalVar(v) && a.context().getGlobalVar(v) instanceof InstanceRef)
<ide> return new InstanceArg((InstanceRef) a.context().getGlobalVar(v));
<ide> else
<ide> return new LVarArg(v);
<ide> };
<del> if (!actionEffects.containsKey(a)) {
<add> if (!directActionEffects.containsKey(a)) {
<ide> List<Effect> directEffects = a.jLogStatements().stream()
<ide> .filter(AbstractLogStatement::hasEffectAtEnd)
<ide> .map(s -> new Effect(
<ide> Collections.singletonList(new StatementPointer(a, s.id(), s.hasConditionAtStart()))))
<ide> .collect(Collectors.toList());
<ide>
<add> directActionEffects.put(a, regrouped(directEffects));
<add> }
<add>
<add> return directActionEffects.get(a);
<add> }
<add>
<add> /** Union of the direct effects of all methods for this task */
<add> private List<Effect> directEffectsOf(Subtask t) {
<add> return methodsOfTask(t.taskName).stream()
<add> .flatMap(a -> directEffectsOf(a).stream().map(e -> e.asEffectOfSubtask(a, t)))
<add> .collect(Collectors.toList());
<add> }
<add>
<add> /** all effects that can be introduced in the plan by completly decomposing this task */
<add> private List<Effect> effectsOf(String task) {
<add> if(!tasksEffects.containsKey(task)) {
<add> tasksEffects.put(task,
<add> subtasksOf(task).stream()
<add> .flatMap(sub -> directEffectsOf(sub).stream())
<add> .collect(Collectors.toList()));
<add> }
<add> return tasksEffects.get(task);
<add> }
<add>
<add> /** All subtasks of t, including t */
<add> private Collection<Subtask> subtasksOf(String task) {
<add> if(!this.subtasks.containsKey(task)) {
<add> HashSet<Subtask> subtasks = new HashSet<>();
<add> Subtask t = new Subtask(0, 0, task, argsOfTask(task).stream().map(LVarArg::new).collect(Collectors.toList()));
<add> populateSubtasksOf(t, subtasks);
<add> this.subtasks.put(task, subtasks.stream().collect(Collectors.toList()));
<add> }
<add> return this.subtasks.get(task);
<add> }
<add>
<add> /** This method recursively populates the set of subtasks with all subtasks of t (including t). */
<add> private void populateSubtasksOf(Subtask t, Set<Subtask> allsubtasks) {
<add> for(Subtask prev : allsubtasks) {
<add> if(t.taskName.equals(prev.taskName)
<add> && t.args.equals(prev.args)
<add> && prev.delayFromStart >= t.delayFromStart) {
<add> allsubtasks.remove(prev);
<add> Subtask merged = new Subtask(
<add> Math.min(t.delayFromStart, prev.delayFromStart),
<add> Math.min(t.delayToEnd, prev.delayToEnd),
<add> t.taskName,
<add> t.args);
<add> allsubtasks.add(merged);
<add> return;
<add> }
<add> }
<add> allsubtasks.add(t);
<add>
<add> for(AbstractAction a : methodsOfTask(t.taskName)) {
<add> java.util.function.Function<LVarRef,VarPlaceHolder> trans = v -> {
<add> if(a.args().contains(v))
<add> return t.args.get(a.args().indexOf(v));
<add> else if(a.context().hasGlobalVar(v) && a.context().getGlobalVar(v) instanceof InstanceRef)
<add> return new InstanceArg((InstanceRef) a.context().getGlobalVar(v));
<add> else
<add> return new TypePlaceHolder(v.getType());
<add> };
<add> for(AbstractTask at : a.jSubTasks()) {
<add> Subtask sub = new Subtask(
<add> a.minDelay(a.start(), at.start()).lb(),
<add> a.minDelay(at.end(), a.end()).lb(),
<add> at.name(),
<add> at.jArgs().stream().map(trans).collect(Collectors.toList())
<add> );
<add> populateSubtasksOf(sub, allsubtasks);
<add> }
<add> }
<add> }
<add>
<add> private List<Effect> effectsOf(AbstractAction a) {
<add> if(!actionEffects.containsKey(a)) {
<ide> List<Effect> undirEffects = a.jSubTasks().stream()
<ide> .flatMap(t -> effectsOf(t.name()).stream().map(e -> e.asEffectBySubtask(a, t)))
<ide> .collect(Collectors.toList());
<ide>
<del> List<Effect> effects = new ArrayList<>(directEffects);
<add> List<Effect> effects = new ArrayList<>(directEffectsOf(a));
<ide> effects.addAll(undirEffects);
<ide>
<del>
<ide> actionEffects.put(a, regrouped(effects));
<ide> }
<ide>
<ide> return actionEffects.get(a);
<del> }
<del>
<del> private List<Effect> effectsOf(String task) {
<del> if(!tasksEffects.containsKey(task)) {
<del> if(pendingTasks.contains(task)) {
<del> recTasks.add(task);
<del> return Collections.emptyList();
<del> } else {
<del> pendingTasks.add(task);
<del> List<Effect> effs = pb.actionsByTask().get(task).stream()
<del> .flatMap(a -> effectsOf(a).stream())
<del> .map(e -> e.asEffectOfTask(task))
<del> .collect(Collectors.toList());
<del> if (recTasks.contains(task)) {
<del> // this task is recursive, remove any vars to make sure to do not miss any effect
<del> tasksEffects.put(task, regrouped(effs.stream().map(Effect::withoutVars).collect(Collectors.toList())));
<del> } else {
<del> tasksEffects.put(task, regrouped(effs));
<del> }
<del> }
<del> }
<del> return tasksEffects.get(task);
<ide> }
<ide>
<ide> @Value private static class DomainList { |
|
Java | apache-2.0 | error: pathspec 'WordCount/src/gjw/hadoop/study/WordCount.java' did not match any file(s) known to git
| 2938785bdc3c57118b1953223a213ca082185c62 | 1 | gglinux/wifi,gglinux/wifi,gglinux/wifi | package gjw.hadoop.study;
import java.io.IOException;
import java.util.StringTokenizer;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.IntWritable;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.mapreduce.Job;
import org.apache.hadoop.mapreduce.Mapper;
import org.apache.hadoop.mapreduce.Reducer;
import org.apache.hadoop.mapreduce.lib.input.FileInputFormat;
import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;
import org.apache.hadoop.util.GenericOptionsParser;
public class WordCount {
//inner class Mapper
public static class TokenizerMapper extends Mapper<Object, Text, Text, IntWritable>
{
//map job value,Text type
private Text word = new Text();
private final static IntWritable one = new IntWritable(1);
//map input type,Object and Text,output type,Text and IntWritable
public void map(Object key, Text value, Context context ) throws IOException, InterruptedException {
StringTokenizer itr = new StringTokenizer(value.toString());
while(itr.hasMoreTokens()) {
//get the word, store in Text
word.set(itr.nextToken());
context.write(word, one);
}
}
}
//inner class Reducer
public static class IntSumReducer extends Reducer<Text, IntWritable, Text, IntWritable>
{
private IntWritable result = new IntWritable();
public void reduce(Text key, Iterable<IntWritable> values, Context context ) throws IOException, InterruptedException {
int sum = 0;
for(IntWritable val : values) {
sum += val.get();
}
result.set(sum);
context.write(key, result);
}
}
public static void main(String[] args) throws Exception {
Configuration conf = new Configuration();
String[] otherArgs = new GenericOptionsParser(conf,args).getRemainingArgs();
if(otherArgs.length != 2) {
System.out.println("Usage:wordcount <in> <out>");
System.exit(2);
}
Job job = new Job(conf, "word count");
job.setJarByClass(WordCount.class);
job.setMapperClass(TokenizerMapper.class);
job.setCombinerClass(IntSumReducer.class);
job.setReducerClass(IntSumReducer.class);
job.setOutputKeyClass(Text.class);
job.setOutputValueClass(IntWritable.class);
FileInputFormat.addInputPath(job, new Path(otherArgs[0]));
FileOutputFormat.setOutputPath(job, new Path(otherArgs[1]));
System.exit(job.waitForCompletion(true) ? 0 : 1);
}
}
| WordCount/src/gjw/hadoop/study/WordCount.java | 完成wordcount
| WordCount/src/gjw/hadoop/study/WordCount.java | 完成wordcount | <ide><path>ordCount/src/gjw/hadoop/study/WordCount.java
<add>package gjw.hadoop.study;
<add>
<add>import java.io.IOException;
<add>import java.util.StringTokenizer;
<add>
<add>import org.apache.hadoop.conf.Configuration;
<add>import org.apache.hadoop.fs.Path;
<add>import org.apache.hadoop.io.IntWritable;
<add>import org.apache.hadoop.io.Text;
<add>import org.apache.hadoop.mapreduce.Job;
<add>import org.apache.hadoop.mapreduce.Mapper;
<add>import org.apache.hadoop.mapreduce.Reducer;
<add>import org.apache.hadoop.mapreduce.lib.input.FileInputFormat;
<add>import org.apache.hadoop.mapreduce.lib.output.FileOutputFormat;
<add>import org.apache.hadoop.util.GenericOptionsParser;
<add>
<add>
<add>
<add>public class WordCount {
<add> //inner class Mapper
<add> public static class TokenizerMapper extends Mapper<Object, Text, Text, IntWritable>
<add> {
<add> //map job value,Text type
<add> private Text word = new Text();
<add> private final static IntWritable one = new IntWritable(1);
<add> //map input type,Object and Text,output type,Text and IntWritable
<add> public void map(Object key, Text value, Context context ) throws IOException, InterruptedException {
<add> StringTokenizer itr = new StringTokenizer(value.toString());
<add> while(itr.hasMoreTokens()) {
<add> //get the word, store in Text
<add> word.set(itr.nextToken());
<add> context.write(word, one);
<add> }
<add> }
<add> }
<add> //inner class Reducer
<add> public static class IntSumReducer extends Reducer<Text, IntWritable, Text, IntWritable>
<add> {
<add> private IntWritable result = new IntWritable();
<add> public void reduce(Text key, Iterable<IntWritable> values, Context context ) throws IOException, InterruptedException {
<add> int sum = 0;
<add> for(IntWritable val : values) {
<add> sum += val.get();
<add> }
<add> result.set(sum);
<add> context.write(key, result);
<add> }
<add> }
<add>
<add> public static void main(String[] args) throws Exception {
<add> Configuration conf = new Configuration();
<add> String[] otherArgs = new GenericOptionsParser(conf,args).getRemainingArgs();
<add> if(otherArgs.length != 2) {
<add> System.out.println("Usage:wordcount <in> <out>");
<add> System.exit(2);
<add> }
<add> Job job = new Job(conf, "word count");
<add> job.setJarByClass(WordCount.class);
<add> job.setMapperClass(TokenizerMapper.class);
<add> job.setCombinerClass(IntSumReducer.class);
<add> job.setReducerClass(IntSumReducer.class);
<add> job.setOutputKeyClass(Text.class);
<add> job.setOutputValueClass(IntWritable.class);
<add> FileInputFormat.addInputPath(job, new Path(otherArgs[0]));
<add> FileOutputFormat.setOutputPath(job, new Path(otherArgs[1]));
<add> System.exit(job.waitForCompletion(true) ? 0 : 1);
<add>
<add> }
<add>} |
|
JavaScript | mit | 93640a7af245283180c6988bd82ae7ab24f1fa83 | 0 | ciarramarielle/labs-js-jasmine,ciarramarielle/labs-js-jasmine | Game = function(level) {
switch (level) {
case 'novice':
this.levelBound = 5
case 'intermediate':
this.levelBound = 10
case 'expert':
this.levelBound = 15
default:
this.levelBound = 5
}
this.Klingons = this.randomGenerate(0, this.levelBound)
this.Starbases = this.randomGenerate(0, this.levelBound)
this.Stardates = this.randomGenerate(0, this.levelBound)
this.location = {
x: this.randomGenerate(0, this.levelBound),
y: this.randomGenerate(0, this.levelBound)
}
}
Game.prototype = {
generator: function() {
return Math.random()
},
randomGenerate: function(low, hi) {
return Math.floor(this.generator() * hi);
}
} | source/DeepSpaceFour.js/StarTrek/Game.js | Game = function(level) {
switch (level) {
case 'novice':
this.levelBound = 5
case 'intermediate':
this.levelBound = 10
case 'expert':
this.levelBound = 15
default:
this.levelBound = 0
}
this.Klingons = this.randomGenerate(0, this.levelBound)
this.Starbases = this.randomGenerate(0, this.levelBound)
this.Stardates = this.randomGenerate(0, this.levelBound)
this.location = {
x: this.randomGenerate(0, this.levelBound),
y: this.randomGenerate(0, this.levelBound)
}
}
Game.prototype = {
generator: function() {
return Math.random()
},
randomGenerate: function(low, hi) {
return Math.floor(this.generator() * hi);
}
} | default level to 5 instead of 0
| source/DeepSpaceFour.js/StarTrek/Game.js | default level to 5 instead of 0 | <ide><path>ource/DeepSpaceFour.js/StarTrek/Game.js
<ide> case 'expert':
<ide> this.levelBound = 15
<ide> default:
<del> this.levelBound = 0
<add> this.levelBound = 5
<ide> }
<ide>
<ide> this.Klingons = this.randomGenerate(0, this.levelBound) |
|
Java | lgpl-2.1 | b4af8a03841635254d44caaaacf4b1ed833f498f | 0 | threerings/narya,threerings/narya,threerings/narya,threerings/narya,threerings/narya | //
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2011 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.tools;
import static com.google.common.base.Charsets.UTF_8;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.Reader;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Reference;
import org.apache.tools.ant.util.ClasspathUtils;
import com.google.common.base.Splitter;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.common.io.Files;
import com.samskivert.io.StreamUtil;
import com.samskivert.mustache.Mustache;
public abstract class GenTask extends Task
{
/**
* Adds a nested <fileset> element which enumerates service declaration source files.
*/
public void addFileset (FileSet set)
{
_filesets.add(set);
}
/**
* Configures us with a header file that we'll prepend to all
* generated source files.
*/
public void setHeader (File header)
{
try {
_header = StreamUtil.toString(new FileReader(header));
} catch (IOException ioe) {
System.err.println("Unabled to load header '" + header + ": " +
ioe.getMessage());
}
}
/** Configures our classpath which we'll use to load service classes. */
public void setClasspathref (Reference pathref)
{
_cloader = ClasspathUtils.getClassLoaderForPath(getProject(), pathref);
// set the parent of the classloader to be the classloader used to load this task, rather
// than the classloader used to load Ant, so that we have access to Narya classes like
// TransportHint
((AntClassLoader)_cloader).setParent(getClass().getClassLoader());
}
/**
* Fails the build if generation would change files rather than generating
* code.
*/
public void setChecking (boolean checking)
{
_checking = checking;
}
/**
* Performs the actual work of the task.
*/
@Override
public void execute ()
{
if (_checking) {
log("Only checking if generation would change files", Project.MSG_VERBOSE);
}
for (FileSet fs : _filesets) {
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
File fromDir = fs.getDir(getProject());
String[] srcFiles = ds.getIncludedFiles();
for (String srcFile : srcFiles) {
File source = new File(fromDir, srcFile);
try {
processClass(source, loadClass(source));
} catch (Exception e) {
throw new BuildException(e);
}
}
}
if (_checking && !_modifiedPaths.isEmpty()) {
throw new BuildException("Generation would produce changes!");
}
}
protected void writeTemplate (String templatePath, String outputPath, Object... data)
throws IOException
{
writeTemplate(templatePath, outputPath, createMap(data));
}
protected void writeTemplate (String templatePath, String outputPath, Map<String, Object> data)
throws IOException
{
String output = mergeTemplate(templatePath, data);
if (_header != null) {
output = _header + output;
}
writeFile(outputPath, output);
}
protected void writeFile (String outputPath, String output) throws IOException
{
File dest = new File(outputPath);
if (dest.exists()) {
if (wouldProduceSameFile(output, dest)) {
log("Skipping '" + outputPath + "' as it hasn't changed", Project.MSG_VERBOSE);
return;
}
} else if (!dest.getParentFile().exists() && !dest.getParentFile().mkdirs()) {
throw new BuildException("Unable to create directory for '" + dest.getAbsolutePath() + "'");
}
_modifiedPaths.add(outputPath);
if (_checking) {
log("Generating '" + outputPath + "' would have produced changes!", Project.MSG_ERR);
return;
}
log("Writing file " + outputPath, Project.MSG_VERBOSE);
new PrintWriter(dest, "UTF-8").append(output).close();
}
/**
* Returns true if the given string has the same content as the file, sans svn prop lines.
*/
protected boolean wouldProduceSameFile (String generated, File existing)
throws IOException
{
Iterator<String> generatedLines = Splitter.on('\n').split(generated).iterator();
for (String prev : Files.readLines(existing, UTF_8)) {
if (!generatedLines.hasNext()) {
return false;
}
String cur = generatedLines.next();
if (!prev.equals(cur) && !(prev.startsWith("// $Id") && cur.startsWith("// $Id"))) {
return false;
}
}
// If the generated output ends with a newline, it'll have one more next from the splitter
// that reading the file doesn't produce.
if (generatedLines.hasNext()) {
return generatedLines.next().equals("") && !generatedLines.hasNext();
}
return true;
}
/**
* Merges the specified template using the supplied mapping of keys to objects.
*
* @param data a series of key, value pairs where the keys must be strings and the values can
* be any object.
*/
protected String mergeTemplate (String template, Object... data)
throws IOException
{
return mergeTemplate(template, createMap(data));
}
/**
* Merges the specified template using the supplied mapping of string keys to objects.
*
* @return a string containing the merged text.
*/
protected String mergeTemplate (String template, Map<String, Object> data)
throws IOException
{
Reader reader =
new InputStreamReader(getClass().getClassLoader().getResourceAsStream(template), UTF_8);
return Mustache.compiler().escapeHTML(false).compile(reader).execute(data);
}
protected Map<String, Object> createMap (Object... data)
{
Map<String, Object> ctx = Maps.newHashMap();
for (int ii = 0; ii < data.length; ii += 2) {
ctx.put((String)data[ii], data[ii+1]);
}
return ctx;
}
/**
* Process a class found from the given source file that was on the filesets given to this
* task.
*/
protected abstract void processClass (File source, Class<?> klass)
throws Exception;
protected Class<?> loadClass (File source)
{
// load up the file and determine it's package and classname
String name;
try {
name = GenUtil.readClassName(source);
} catch (Exception e) {
throw new BuildException("Failed to parse " + source, e);
}
return loadClass(name);
}
protected Class<?> loadClass (String name)
{
if (_cloader == null) {
throw new BuildException("This task requires a 'classpathref' attribute " +
"to be set to the project's classpath.");
}
try {
return _cloader.loadClass(name);
} catch (ClassNotFoundException cnfe) {
throw new BuildException(
"Failed to load " + name + ". Be sure to set the 'classpathref' attribute to a " +
"classpath that contains your project's presents classes.", cnfe);
}
}
/** A list of filesets that contain java source to be processed. */
protected List<FileSet> _filesets = Lists.newArrayList();
/** Used to do our own classpath business. */
protected ClassLoader _cloader;
/** A header to put on all generated source files. */
protected String _header;
protected boolean _checking;
protected Set<String> _modifiedPaths = Sets.newHashSet();
}
| src/main/java/com/threerings/presents/tools/GenTask.java | //
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2011 Three Rings Design, Inc., All Rights Reserved
// http://code.google.com/p/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.tools;
import static com.google.common.base.Charsets.UTF_8;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.PrintWriter;
import java.io.Reader;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.tools.ant.AntClassLoader;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.DirectoryScanner;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.FileSet;
import org.apache.tools.ant.types.Reference;
import org.apache.tools.ant.util.ClasspathUtils;
import com.google.common.base.Splitter;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import com.google.common.io.Files;
import com.samskivert.io.StreamUtil;
import com.samskivert.mustache.Mustache;
public abstract class GenTask extends Task
{
/**
* Adds a nested <fileset> element which enumerates service declaration source files.
*/
public void addFileset (FileSet set)
{
_filesets.add(set);
}
/**
* Configures us with a header file that we'll prepend to all
* generated source files.
*/
public void setHeader (File header)
{
try {
_header = StreamUtil.toString(new FileReader(header));
} catch (IOException ioe) {
System.err.println("Unabled to load header '" + header + ": " +
ioe.getMessage());
}
}
/** Configures our classpath which we'll use to load service classes. */
public void setClasspathref (Reference pathref)
{
_cloader = ClasspathUtils.getClassLoaderForPath(getProject(), pathref);
// set the parent of the classloader to be the classloader used to load this task, rather
// than the classloader used to load Ant, so that we have access to Narya classes like
// TransportHint
((AntClassLoader)_cloader).setParent(getClass().getClassLoader());
}
/**
* Fails the build if generation would change files rather than generating
* code.
*/
public void setChecking (boolean checking)
{
_checking = checking;
}
/**
* Performs the actual work of the task.
*/
@Override
public void execute ()
{
if (_checking) {
log("Only checking if generation would change files", Project.MSG_VERBOSE);
}
for (FileSet fs : _filesets) {
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
File fromDir = fs.getDir(getProject());
String[] srcFiles = ds.getIncludedFiles();
for (String srcFile : srcFiles) {
File source = new File(fromDir, srcFile);
try {
processClass(source, loadClass(source));
} catch (Exception e) {
throw new BuildException(e);
}
}
}
if (_checking && !_modifiedPaths.isEmpty()) {
throw new BuildException("Generation would produce changes!");
}
}
protected void writeTemplate (String templatePath, String outputPath, Object... data)
throws IOException
{
writeTemplate(templatePath, outputPath, createMap(data));
}
protected void writeTemplate (String templatePath, String outputPath, Map<String, Object> data)
throws IOException
{
String output = mergeTemplate(templatePath, data);
if (_header != null) {
output = _header + output;
}
writeFile(outputPath, output);
}
protected void writeFile (String outputPath, String output) throws IOException
{
File dest = new File(outputPath);
if (dest.exists()) {
if (wouldProduceSameFile(output, dest)) {
log("Skipping '" + outputPath + "' as it hasn't changed", Project.MSG_VERBOSE);
return;
}
} else if (!dest.getParentFile().exists() && !dest.getParentFile().mkdirs()) {
throw new BuildException("Unable to create directory for '" + dest.getAbsolutePath() + "'");
}
_modifiedPaths.add(outputPath);
if (_checking) {
log("Generating '" + outputPath + "' would have produced changes!", Project.MSG_ERR);
return;
}
log("Writing file " + outputPath, Project.MSG_VERBOSE);
new PrintWriter(dest, "UTF-8").append(output).close();
}
/**
* Returns true if the given string has the same content as the file, sans svn prop lines.
*/
protected boolean wouldProduceSameFile (String generated, File existing)
throws IOException
{
Iterator<String> generatedLines = Splitter.on('\n').split(generated).iterator();
for (String prev : Files.readLines(existing, UTF_8)) {
if (!generatedLines.hasNext()) {
return false;
}
String cur = generatedLines.next();
if (!prev.equals(cur) && !(prev.startsWith("// $Id") && cur.startsWith("// $Id"))) {
return false;
}
}
// If the generated output ends with a newline, it'll have one more next from the splitter
// that reading the file doesn't produce.
if (generatedLines.hasNext()) {
return generatedLines.next().equals("") && !generatedLines.hasNext();
}
return true;
}
/**
* Merges the specified template using the supplied mapping of keys to objects.
*
* @param data a series of key, value pairs where the keys must be strings and the values can
* be any object.
*/
protected String mergeTemplate (String template, Object... data)
throws IOException
{
return mergeTemplate(template, createMap(data));
}
/**
* Merges the specified template using the supplied mapping of string keys to objects.
*
* @return a string containing the merged text.
*/
protected String mergeTemplate (String template, Map<String, Object> data)
throws IOException
{
Reader reader =
new InputStreamReader(getClass().getClassLoader().getResourceAsStream(template), UTF_8);
return Mustache.compiler().escapeHTML(false).compile(reader).execute(data);
}
protected Map<String, Object> createMap (Object... data)
{
Map<String, Object> ctx = Maps.newHashMap();
for (int ii = 0; ii < data.length; ii += 2) {
ctx.put((String)data[ii], data[ii+1]);
}
return ctx;
}
/**
* Process a class found from the given source file that was on the filesets given to this
* task.
*/
protected abstract void processClass (File source, Class<?> klass)
throws Exception;
protected Class<?> loadClass (File source)
{
// load up the file and determine it's package and classname
String name;
try {
name = GenUtil.readClassName(source);
} catch (Exception e) {
throw new BuildException("Failed to parse " + source + ": " + e.getMessage());
}
return loadClass(name);
}
protected Class<?> loadClass (String name)
{
if (_cloader == null) {
throw new BuildException("This task requires a 'classpathref' attribute " +
"to be set to the project's classpath.");
}
try {
return _cloader.loadClass(name);
} catch (ClassNotFoundException cnfe) {
throw new BuildException(
"Failed to load " + name + ". Be sure to set the 'classpathref' attribute to a " +
"classpath that contains your project's presents classes.", cnfe);
}
}
/** A list of filesets that contain java source to be processed. */
protected List<FileSet> _filesets = Lists.newArrayList();
/** Used to do our own classpath business. */
protected ClassLoader _cloader;
/** A header to put on all generated source files. */
protected String _header;
protected boolean _checking;
protected Set<String> _modifiedPaths = Sets.newHashSet();
}
| Include the traceback when we fail to extract a name from source
git-svn-id: a1a4b28b82a3276cc491891159dd9963a0a72fae@6419 542714f4-19e9-0310-aa3c-eee0fc999fb1
| src/main/java/com/threerings/presents/tools/GenTask.java | Include the traceback when we fail to extract a name from source | <ide><path>rc/main/java/com/threerings/presents/tools/GenTask.java
<ide> try {
<ide> name = GenUtil.readClassName(source);
<ide> } catch (Exception e) {
<del> throw new BuildException("Failed to parse " + source + ": " + e.getMessage());
<add> throw new BuildException("Failed to parse " + source, e);
<ide> }
<ide> return loadClass(name);
<ide> } |
|
Java | lgpl-2.1 | 137c1fa4cfe6aad93db442002e521de41f727045 | 0 | andersjkbsn/EduCode | package com.educode.visitors;
import com.educode.antlr.EduCodeBaseVisitor;
import com.educode.antlr.EduCodeParser;
import com.educode.events.EventTypeBase;
import com.educode.events.communication.ChatMessageEvent;
import com.educode.events.communication.EntityMessageReceivedEvent;
import com.educode.events.communication.StringMessageReceivedEvent;
import com.educode.events.entity.EntityDeathEvent;
import com.educode.events.entity.robot.RobotAttackedEvent;
import com.educode.events.entity.robot.RobotDeathEvent;
import com.educode.nodes.base.ListNode;
import com.educode.nodes.base.NaryNode;
import com.educode.nodes.base.Node;
import com.educode.nodes.expression.AdditionExpressionNode;
import com.educode.nodes.expression.MultiplicationExpressionNode;
import com.educode.nodes.expression.RangeNode;
import com.educode.nodes.expression.UnaryMinusNode;
import com.educode.nodes.expression.logic.*;
import com.educode.nodes.literal.*;
import com.educode.nodes.method.MethodDeclarationNode;
import com.educode.nodes.method.MethodInvocationNode;
import com.educode.nodes.method.ParameterNode;
import com.educode.nodes.referencing.ArrayReferencingNode;
import com.educode.nodes.referencing.IReference;
import com.educode.nodes.referencing.IdentifierReferencingNode;
import com.educode.nodes.referencing.StructReferencingNode;
import com.educode.nodes.statement.*;
import com.educode.nodes.statement.conditional.ConditionNode;
import com.educode.nodes.statement.conditional.IfNode;
import com.educode.nodes.statement.conditional.RepeatWhileNode;
import com.educode.nodes.ungrouped.*;
import com.educode.types.ArithmeticOperator;
import com.educode.types.AssignmentOperator;
import com.educode.types.LogicalOperator;
import com.educode.types.Type;
import org.antlr.v4.runtime.ParserRuleContext;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
/**
* Created by Thomas Buhl on 10/05/2017.
*/
public class ASTBuilder extends EduCodeBaseVisitor<Node>
{
private final List<String> JavaKeywords = Arrays.asList("abstract", "continue", "for", "new", "switch", "assert", "default", "goto", "package", "synchronized", "boolean", "do", "if", "private", "this", "break", "double", "implements", "protected", "throw", "byte", "else", "import", "public", "throws", "case", "enum", "instanceof", "return", "transient", "catch", "extends", "int", "short", "try", "char", "final", "interface", "static", "void", "class", "finally", "long", "strictfp", "volatile", "const", "float", "native", "super", "while");
private static int _currentLineNumber = 0;
private static void updateLineNumber(ParserRuleContext fromCtx)
{
ASTBuilder._currentLineNumber = fromCtx.getStart().getLine();
}
public static int getLineNumber()
{
return ASTBuilder._currentLineNumber;
}
private LogicalOperator getLogicalOperator(String operator)
{
switch (operator)
{
case "equals":
return LogicalOperator.Equals;
case "not equals":
return LogicalOperator.NotEquals;
case "less than":
return LogicalOperator.LessThan;
case "less than or equals":
return LogicalOperator.LessThanOrEquals;
case "greater than":
return LogicalOperator.GreaterThan;
case "greater than or equals":
return LogicalOperator.GreaterThanOrEquals;
default:
return LogicalOperator.Error;
}
}
private ArithmeticOperator getArithmeticOperator(String operator)
{
switch (operator)
{
case "+":
return ArithmeticOperator.Addition;
case "-":
return ArithmeticOperator.Subtraction;
case "/":
return ArithmeticOperator.Division;
case "*":
return ArithmeticOperator.Multiplication;
case "modulo":
return ArithmeticOperator.Modulo;
default:
return ArithmeticOperator.Error;
}
}
private AssignmentOperator getAssignmentOperator(String operator)
{
switch (operator)
{
case "=":
return AssignmentOperator.None;
case "+=":
return AssignmentOperator.Addition;
case "-=":
return AssignmentOperator.Subtraction;
case "/=":
return AssignmentOperator.Division;
case "*=":
return AssignmentOperator.Multiplication;
default:
return AssignmentOperator.Error;
}
}
private EventTypeBase getEventType(EduCodeParser.Event_typeContext ctx)
{
switch (ctx.getChild(0).getText())
{
case "robotDeath":
return new RobotDeathEvent();
case "robotAttacked":
return new RobotAttackedEvent();
case "entityDeath":
return new EntityDeathEvent();
case "chatMessage":
return new ChatMessageEvent();
case "stringMessageReceived":
return new StringMessageReceivedEvent((NumberLiteralNode) visit(ctx.number_literal()));
case "entityMessageReceived":
return new EntityMessageReceivedEvent((NumberLiteralNode) visit(ctx.number_literal()));
}
return null;
}
private Type getType(EduCodeParser.Data_typeContext ctx)
{
if (ctx.data_type() != null)
return new Type(getType(ctx.data_type()));
else
{
switch (ctx.getText())
{
case "string":
return Type.StringType;
case "bool":
return Type.BoolType;
case "number":
return Type.NumberType;
case "Entity":
return Type.EntityType;
case "coordinates":
return Type.CoordinatesType;
case "Item":
return Type.ItemType;
}
}
return Type.VoidType;
}
@Override
public Node visitStart(EduCodeParser.StartContext ctx)
{
updateLineNumber(ctx);
return new StartNode(ctx.ulist != null ? visit(ctx.ulist) : new UsingsNode(), visit(ctx.pr));
}
@Override
public Node visitUsings(EduCodeParser.UsingsContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> Nodes = new ArrayList<>();
for (EduCodeParser.IdentifierContext i: ctx.id)
Nodes.add(new ImportNode(visitIdentifier(i).toString()));
return new UsingsNode(Nodes);
}
@Override
public Node visitProgram(EduCodeParser.ProgramContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> nodes = new ArrayList<>();
// Add global variables
for (EduCodeParser.Variable_declarationContext v : ctx.vl)
nodes.add(visit(v));
// Add event subscriptions
for (EduCodeParser.Event_definitionContext e : ctx.el)
nodes.add(visit(e));
// Add method declarations
for (EduCodeParser.Method_declarationContext m : ctx.ml)
nodes.add(visit(m));
return new ProgramNode(nodes, (IReference) visit(ctx.id));
}
@Override
public Node visitEvent_definition(EduCodeParser.Event_definitionContext ctx)
{
return new EventDefinitionNode((IReference) visit(ctx.id), getEventType(ctx.event));
}
@Override
public Node visitMethod_declaration(EduCodeParser.Method_declarationContext ctx)
{
updateLineNumber(ctx);
Type returnType = Type.VoidType;
if (ctx.type != null)
returnType = getType(ctx.type);
if (ctx.params != null)
return new MethodDeclarationNode(visit(ctx.params), visit(ctx.body), (IReference) visit(ctx.id), returnType);
else
return new MethodDeclarationNode(null, visit(ctx.body), (IReference) visit(ctx.id), returnType);
}
@Override
public Node visitArgument_list(EduCodeParser.Argument_listContext ctx)
{
updateLineNumber(ctx);
ListNode node = new ListNode();
for (EduCodeParser.Logic_expressionContext e : ctx.exprs)
node.addChild(visit(e));
return node;
}
@Override
public Node visitParameter_list(EduCodeParser.Parameter_listContext ctx)
{
updateLineNumber(ctx);
ListNode parameterCollection = new ListNode();
for (EduCodeParser.ParameterContext p : ctx.params)
parameterCollection.addChild(visit(p));
return parameterCollection;
}
@Override
public Node visitParameter(EduCodeParser.ParameterContext ctx)
{
updateLineNumber(ctx);
return new ParameterNode((IReference) visit(ctx.id), getType(ctx.type));
}
@Override
public Node visitStatement_list(EduCodeParser.Statement_listContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> childStatements = new ArrayList<>();
for (EduCodeParser.StatementContext statement : ctx.statements)
{
Node visitResult = visit(statement);
// Some nodes (like variable declaration) will return a collection of nodes
// Instead of adding the ListNode, we will add the contained nodes
// We don't do this for NaryNode because some nodes (If-Node) can't be split up
if (visitResult instanceof ListNode)
childStatements.addAll(((NaryNode)visitResult).getChildren());
else
childStatements.add(visitResult);
}
return new BlockNode(childStatements);
}
@Override
public Node visitStatement(EduCodeParser.StatementContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitCall_statement(EduCodeParser.Call_statementContext ctx)
{
updateLineNumber(ctx);
if (ctx.method_call() != null)
return visit(ctx.method_call());
else
return new StructReferencingNode(visit(ctx.access()), visit(ctx.method_access()));
}
@Override
public Node visitIterative_statement(EduCodeParser.Iterative_statementContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitBreak_statement(EduCodeParser.Break_statementContext ctx)
{
updateLineNumber(ctx);
return new BreakNode();
}
@Override
public Node visitContinue_statement(EduCodeParser.Continue_statementContext ctx)
{
updateLineNumber(ctx);
return new ContinueNode();
}
@Override
public Node visitReturn_statement(EduCodeParser.Return_statementContext ctx)
{
updateLineNumber(ctx);
if (ctx.expr != null)
return new ReturnNode(visit(ctx.expr));
else
return new ReturnNode();
}
@Override
public Node visitRepeat_statement(EduCodeParser.Repeat_statementContext ctx)
{
updateLineNumber(ctx);
return new RepeatWhileNode(new ConditionNode(visit(ctx.predicate), visit(ctx.body)));
}
@Override
public Node visitIf_statement(EduCodeParser.If_statementContext ctx)
{
updateLineNumber(ctx);
IfNode ifNode = new IfNode();
// Add a condition node for each predicate-body pair
for (int i = 0; i < ctx.bodies.size(); i++)
ifNode.addChild(new ConditionNode(visit(ctx.predicates.get(i)), visit(ctx.bodies.get(i))));
// If there is an else block, add it finally without a ConditionNode
if (ctx.elseBody != null)
ifNode.addChild(visit(ctx.elseBody));
return ifNode;
}
@Override
public Node visitForeach_statement(EduCodeParser.Foreach_statementContext ctx)
{ return new ForEachNode((IReference) visit(ctx.id), getType(ctx.type), visit(ctx.expr), visit(ctx.body));
}
@Override
public Node visitVariable_declaration(EduCodeParser.Variable_declarationContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> nodes = new ArrayList<>();
Node current;
for (EduCodeParser.DeclaratorContext decl: ctx.decls)
{
current = visit(decl);
if (current instanceof AssignmentNode)
nodes.add( new VariableDeclarationNode((AssignmentNode)current, getType(ctx.type)));
else if (current instanceof IReference)
nodes.add( new VariableDeclarationNode((IReference)current, getType(ctx.type)));
else
System.out.println("VarDeclError at line " + ctx.getStart().getLine());
}
return new ListNode(nodes);
}
@Override
public Node visitDeclarator(EduCodeParser.DeclaratorContext ctx)
{
updateLineNumber(ctx);
if (ctx.expr != null)
return new AssignmentNode((IReference) visit(ctx.id), visit(ctx.expr));
else
return visit(ctx.id);
}
@Override
public Node visitExpression(EduCodeParser.ExpressionContext ctx)
{
updateLineNumber(ctx);
return super.visit(ctx.getChild(0));//visit(ctx.getChild(0));
}
@Override
public Node visitAssignment_expression(EduCodeParser.Assignment_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.rhs != null) // Assign to expression
{
Node left = visit(ctx.lhs);
Node right = visit(ctx.rhs);
AssignmentOperator operator = getAssignmentOperator(ctx.op.getText());
switch (operator.getKind())
{
case AssignmentOperator.NONE:
return new AssignmentNode((IReference) left, right);
case AssignmentOperator.ADDITION:
return new AssignmentNode((IReference) left, new AdditionExpressionNode(ArithmeticOperator.Addition, left, right));
case AssignmentOperator.SUBTRACTION:
return new AssignmentNode((IReference) left, new AdditionExpressionNode(ArithmeticOperator.Subtraction, left, right));
case AssignmentOperator.MULTIPLICATION:
return new AssignmentNode((IReference) left, new MultiplicationExpressionNode(ArithmeticOperator.Multiplication, left, right));
case AssignmentOperator.DIVISION:
return new AssignmentNode((IReference) left, new MultiplicationExpressionNode(ArithmeticOperator.Division, left, right));
default:
System.out.println("Unknown assignment operator at line " + ctx.getStart().getLine());
}
}
System.out.println("AssignError at line " + ctx.getStart().getLine());
System.out.println(ctx.getText());
return null;
}
@Override
public Node visitLeft_hand_side(EduCodeParser.Left_hand_sideContext ctx)
{
updateLineNumber(ctx);
if (ctx.field != null)
return new StructReferencingNode(visit(ctx.acc), visit(ctx.field_access()));
else if (ctx.element != null)
return new ArrayReferencingNode(visit(ctx.acc), visit(ctx.element_access()));
else if (ctx.id != null)
return visit(ctx.id);
else
System.out.println("LHS-Error at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitLogic_expression(EduCodeParser.Logic_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));//visit(ctx.getChild(0));
}
@Override
public Node visitOr_expression(EduCodeParser.Or_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new OrExpressionNode(visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in or-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitAnd_expression(EduCodeParser.And_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new AndExpressionNode(visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in and-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitEquality_expression(EduCodeParser.Equality_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new EqualExpressionNode(getLogicalOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in equals-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitRelative_expression(EduCodeParser.Relative_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new RelativeExpressionNode(getLogicalOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in relative-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitArithmetic_expression(EduCodeParser.Arithmetic_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitAdditive_expression(EduCodeParser.Additive_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new AdditionExpressionNode(getArithmeticOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("AddError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitMultiplicative_expression(EduCodeParser.Multiplicative_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new MultiplicationExpressionNode(getArithmeticOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("MultError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitFactor(EduCodeParser.FactorContext ctx)
{
updateLineNumber(ctx);
if (ctx.literal() != null)
return visit(ctx.literal());
else if (ctx.access() != null)
return visit(ctx.access());
else if (ctx.factor() != null)
{
if (ctx.op.getText().equals("not"))
return new NegateNode(visit(ctx.factor()));
else if (ctx.op.getText().equals("-"))
return new UnaryMinusNode(visit(ctx.factor()));
}
else if (ctx.type_cast() != null)
return visit(ctx.type_cast());
else if (ctx.object_instantiation() != null)
return visit(ctx.object_instantiation());
System.out.println("FactError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitAccess(EduCodeParser.AccessContext ctx)
{
updateLineNumber(ctx);
if (ctx.field_access() != null)
return new StructReferencingNode(visit(ctx.rec), visit(ctx.field_access()));
else if (ctx.element_access() != null)
return new ArrayReferencingNode(visit(ctx.rec), visit(ctx.element_access()));
else if (ctx.method_access() != null)
return new StructReferencingNode(visit(ctx.rec), visit(ctx.method_access()));
else if (ctx.sub != null)
return visit(ctx.sub);
System.out.println("AccessError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitField_access(EduCodeParser.Field_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.id);
}
@Override
public Node visitElement_access(EduCodeParser.Element_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.index);
}
@Override
public Node visitMethod_access(EduCodeParser.Method_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.method);
}
@Override
public Node visitSubfactor(EduCodeParser.SubfactorContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitParenthesis_expression(EduCodeParser.Parenthesis_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.content);
}
@Override
public Node visitMethod_call(EduCodeParser.Method_callContext ctx)
{
updateLineNumber(ctx);
if (ctx.args != null)
return new MethodInvocationNode((IReference) visit(ctx.id), visit(ctx.args));
else
return new MethodInvocationNode((IReference) visit(ctx.id), null);
}
@Override
public Node visitType_cast(EduCodeParser.Type_castContext ctx)
{
updateLineNumber(ctx);
return new TypeCastNode(getType(ctx.type), visit(ctx.fac));
}
@Override
public Node visitObject_instantiation(EduCodeParser.Object_instantiationContext ctx)
{
updateLineNumber(ctx);
Type classType = getType(ctx.type);
if (ctx.args != null)
return new ObjectInstantiationNode(visit(ctx.args), classType);
else
return new ObjectInstantiationNode(null, classType);
}
@Override
public Node visitEvent_type(EduCodeParser.Event_typeContext ctx)
{
return null;
}
@Override
public Node visitData_type(EduCodeParser.Data_typeContext ctx)
{
return null;
}
@Override
public Node visitLiteral(EduCodeParser.LiteralContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitRange_literal(EduCodeParser.Range_literalContext ctx)
{
updateLineNumber(ctx);
return new RangeNode(visit(ctx.left), visit(ctx.right));
}
@Override
public Node visitString_literal(EduCodeParser.String_literalContext ctx)
{
updateLineNumber(ctx);
return new StringLiteralNode(ctx.STRING_LITERAL().getText());
}
@Override
public Node visitCoordinate_literal(EduCodeParser.Coordinate_literalContext ctx)
{
updateLineNumber(ctx);
return new CoordinatesLiteralNode(visit(ctx.x), visit(ctx.y), visit(ctx.z));
}
@Override
public Node visitNumber_literal(EduCodeParser.Number_literalContext ctx)
{
updateLineNumber(ctx);
return new NumberLiteralNode(Double.parseDouble(ctx.NUMBER_LITERAL().getText()));
}
@Override
public Node visitBool_literal(EduCodeParser.Bool_literalContext ctx)
{
updateLineNumber(ctx);
return new BoolLiteralNode(ctx.BOOL_LITERAL().getText().equals("true"));
}
@Override
public Node visitNull_literal(EduCodeParser.Null_literalContext ctx)
{
updateLineNumber(ctx);
return new NullLiteralNode();
}
@Override
public Node visitIdentifier(EduCodeParser.IdentifierContext ctx)
{
updateLineNumber(ctx);
String identifier = ctx.IDENTIFIER().getText();
if (JavaKeywords.contains(identifier.toLowerCase()))
identifier = "_" + identifier;
int ﹍dd;
return new IdentifierReferencingNode(identifier);
}
@Override
public Node visitEnd_of_line(EduCodeParser.End_of_lineContext ctx)
{
return null;
}
}
| src/main/java/com/educode/visitors/ASTBuilder.java | package com.educode.visitors;
import com.educode.antlr.EduCodeBaseVisitor;
import com.educode.antlr.EduCodeParser;
import com.educode.events.EventTypeBase;
import com.educode.events.communication.ChatMessageEvent;
import com.educode.events.communication.EntityMessageReceivedEvent;
import com.educode.events.communication.StringMessageReceivedEvent;
import com.educode.events.entity.EntityDeathEvent;
import com.educode.events.entity.robot.RobotAttackedEvent;
import com.educode.events.entity.robot.RobotDeathEvent;
import com.educode.nodes.base.*;
import com.educode.nodes.expression.AdditionExpressionNode;
import com.educode.nodes.expression.MultiplicationExpressionNode;
import com.educode.nodes.expression.RangeNode;
import com.educode.nodes.expression.UnaryMinusNode;
import com.educode.nodes.expression.logic.*;
import com.educode.nodes.literal.*;
import com.educode.nodes.method.MethodDeclarationNode;
import com.educode.nodes.method.MethodInvocationNode;
import com.educode.nodes.method.ParameterNode;
import com.educode.nodes.referencing.ArrayReferencingNode;
import com.educode.nodes.referencing.IReference;
import com.educode.nodes.referencing.IdentifierReferencingNode;
import com.educode.nodes.referencing.StructReferencingNode;
import com.educode.nodes.statement.*;
import com.educode.nodes.statement.conditional.ConditionNode;
import com.educode.nodes.statement.conditional.IfNode;
import com.educode.nodes.statement.conditional.RepeatWhileNode;
import com.educode.nodes.ungrouped.*;
import com.educode.types.*;
import org.antlr.v4.runtime.ParserRuleContext;
import java.util.ArrayList;
/**
* Created by Thomas Buhl on 10/05/2017.
*/
public class ASTBuilder extends EduCodeBaseVisitor<Node>
{
private static int _currentLineNumber = 0;
private static void updateLineNumber(ParserRuleContext fromCtx)
{
ASTBuilder._currentLineNumber = fromCtx.getStart().getLine();
}
public static int getLineNumber()
{
return ASTBuilder._currentLineNumber;
}
private LogicalOperator getLogicalOperator(String operator)
{
switch (operator)
{
case "equals":
return LogicalOperator.Equals;
case "not equals":
return LogicalOperator.NotEquals;
case "less than":
return LogicalOperator.LessThan;
case "less than or equals":
return LogicalOperator.LessThanOrEquals;
case "greater than":
return LogicalOperator.GreaterThan;
case "greater than or equals":
return LogicalOperator.GreaterThanOrEquals;
default:
return LogicalOperator.Error;
}
}
private ArithmeticOperator getArithmeticOperator(String operator)
{
switch (operator)
{
case "+":
return ArithmeticOperator.Addition;
case "-":
return ArithmeticOperator.Subtraction;
case "/":
return ArithmeticOperator.Division;
case "*":
return ArithmeticOperator.Multiplication;
case "modulo":
return ArithmeticOperator.Modulo;
default:
return ArithmeticOperator.Error;
}
}
private AssignmentOperator getAssignmentOperator(String operator)
{
switch (operator)
{
case "=":
return AssignmentOperator.None;
case "+=":
return AssignmentOperator.Addition;
case "-=":
return AssignmentOperator.Subtraction;
case "/=":
return AssignmentOperator.Division;
case "*=":
return AssignmentOperator.Multiplication;
default:
return AssignmentOperator.Error;
}
}
private EventTypeBase getEventType(EduCodeParser.Event_typeContext ctx)
{
switch (ctx.getChild(0).getText())
{
case "robotDeath":
return new RobotDeathEvent();
case "robotAttacked":
return new RobotAttackedEvent();
case "entityDeath":
return new EntityDeathEvent();
case "chatMessage":
return new ChatMessageEvent();
case "stringMessageReceived":
return new StringMessageReceivedEvent((NumberLiteralNode) visit(ctx.number_literal()));
case "entityMessageReceived":
return new EntityMessageReceivedEvent((NumberLiteralNode) visit(ctx.number_literal()));
}
return null;
}
private Type getType(EduCodeParser.Data_typeContext ctx)
{
if (ctx.data_type() != null)
return new Type(getType(ctx.data_type()));
else
{
switch (ctx.getText())
{
case "string":
return Type.StringType;
case "bool":
return Type.BoolType;
case "number":
return Type.NumberType;
case "Entity":
return Type.EntityType;
case "coordinates":
return Type.CoordinatesType;
case "Item":
return Type.ItemType;
}
}
return Type.VoidType;
}
@Override
public Node visitStart(EduCodeParser.StartContext ctx)
{
updateLineNumber(ctx);
return new StartNode(ctx.ulist != null ? visit(ctx.ulist) : new UsingsNode(), visit(ctx.pr));
}
@Override
public Node visitUsings(EduCodeParser.UsingsContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> Nodes = new ArrayList<>();
for (EduCodeParser.IdentifierContext i: ctx.id)
Nodes.add(new ImportNode(visitIdentifier(i).toString()));
return new UsingsNode(Nodes);
}
@Override
public Node visitProgram(EduCodeParser.ProgramContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> nodes = new ArrayList<>();
// Add global variables
for (EduCodeParser.Variable_declarationContext v : ctx.vl)
nodes.add(visit(v));
// Add event subscriptions
for (EduCodeParser.Event_definitionContext e : ctx.el)
nodes.add(visit(e));
// Add method declarations
for (EduCodeParser.Method_declarationContext m : ctx.ml)
nodes.add(visit(m));
return new ProgramNode(nodes, (IReference) visit(ctx.id));
}
@Override
public Node visitEvent_definition(EduCodeParser.Event_definitionContext ctx)
{
return new EventDefinitionNode((IReference) visit(ctx.id), getEventType(ctx.event));
}
@Override
public Node visitMethod_declaration(EduCodeParser.Method_declarationContext ctx)
{
updateLineNumber(ctx);
Type returnType = Type.VoidType;
if (ctx.type != null)
returnType = getType(ctx.type);
if (ctx.params != null)
return new MethodDeclarationNode(visit(ctx.params), visit(ctx.body), (IReference) visit(ctx.id), returnType);
else
return new MethodDeclarationNode(null, visit(ctx.body), (IReference) visit(ctx.id), returnType);
}
@Override
public Node visitArgument_list(EduCodeParser.Argument_listContext ctx)
{
updateLineNumber(ctx);
ListNode node = new ListNode();
for (EduCodeParser.Logic_expressionContext e : ctx.exprs)
node.addChild(visit(e));
return node;
}
@Override
public Node visitParameter_list(EduCodeParser.Parameter_listContext ctx)
{
updateLineNumber(ctx);
ListNode parameterCollection = new ListNode();
for (EduCodeParser.ParameterContext p : ctx.params)
parameterCollection.addChild(visit(p));
return parameterCollection;
}
@Override
public Node visitParameter(EduCodeParser.ParameterContext ctx)
{
updateLineNumber(ctx);
return new ParameterNode((IReference) visit(ctx.id), getType(ctx.type));
}
@Override
public Node visitStatement_list(EduCodeParser.Statement_listContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> childStatements = new ArrayList<>();
for (EduCodeParser.StatementContext statement : ctx.statements)
{
Node visitResult = visit(statement);
// Some nodes (like variable declaration) will return a collection of nodes
// Instead of adding the ListNode, we will add the contained nodes
// We don't do this for NaryNode because some nodes (If-Node) can't be split up
if (visitResult instanceof ListNode)
childStatements.addAll(((NaryNode)visitResult).getChildren());
else
childStatements.add(visitResult);
}
return new BlockNode(childStatements);
}
@Override
public Node visitStatement(EduCodeParser.StatementContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitCall_statement(EduCodeParser.Call_statementContext ctx)
{
updateLineNumber(ctx);
if (ctx.method_call() != null)
return visit(ctx.method_call());
else
return new StructReferencingNode(visit(ctx.access()), visit(ctx.method_access()));
}
@Override
public Node visitIterative_statement(EduCodeParser.Iterative_statementContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitBreak_statement(EduCodeParser.Break_statementContext ctx)
{
updateLineNumber(ctx);
return new BreakNode();
}
@Override
public Node visitContinue_statement(EduCodeParser.Continue_statementContext ctx)
{
updateLineNumber(ctx);
return new ContinueNode();
}
@Override
public Node visitReturn_statement(EduCodeParser.Return_statementContext ctx)
{
updateLineNumber(ctx);
if (ctx.expr != null)
return new ReturnNode(visit(ctx.expr));
else
return new ReturnNode();
}
@Override
public Node visitRepeat_statement(EduCodeParser.Repeat_statementContext ctx)
{
updateLineNumber(ctx);
return new RepeatWhileNode(new ConditionNode(visit(ctx.predicate), visit(ctx.body)));
}
@Override
public Node visitIf_statement(EduCodeParser.If_statementContext ctx)
{
updateLineNumber(ctx);
IfNode ifNode = new IfNode();
// Add a condition node for each predicate-body pair
for (int i = 0; i < ctx.bodies.size(); i++)
ifNode.addChild(new ConditionNode(visit(ctx.predicates.get(i)), visit(ctx.bodies.get(i))));
// If there is an else block, add it finally without a ConditionNode
if (ctx.elseBody != null)
ifNode.addChild(visit(ctx.elseBody));
return ifNode;
}
@Override
public Node visitForeach_statement(EduCodeParser.Foreach_statementContext ctx)
{ return new ForEachNode((IReference) visit(ctx.id), getType(ctx.type), visit(ctx.expr), visit(ctx.body));
}
@Override
public Node visitVariable_declaration(EduCodeParser.Variable_declarationContext ctx)
{
updateLineNumber(ctx);
ArrayList<Node> nodes = new ArrayList<>();
Node current;
for (EduCodeParser.DeclaratorContext decl: ctx.decls)
{
current = visit(decl);
if (current instanceof AssignmentNode)
nodes.add( new VariableDeclarationNode((AssignmentNode)current, getType(ctx.type)));
else if (current instanceof IReference)
nodes.add( new VariableDeclarationNode((IReference)current, getType(ctx.type)));
else
System.out.println("VarDeclError at line " + ctx.getStart().getLine());
}
return new ListNode(nodes);
}
@Override
public Node visitDeclarator(EduCodeParser.DeclaratorContext ctx)
{
updateLineNumber(ctx);
if (ctx.expr != null)
return new AssignmentNode((IReference) visit(ctx.id), visit(ctx.expr));
else
return visit(ctx.id);
}
@Override
public Node visitExpression(EduCodeParser.ExpressionContext ctx)
{
updateLineNumber(ctx);
return super.visit(ctx.getChild(0));//visit(ctx.getChild(0));
}
@Override
public Node visitAssignment_expression(EduCodeParser.Assignment_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.rhs != null) // Assign to expression
{
Node left = visit(ctx.lhs);
Node right = visit(ctx.rhs);
AssignmentOperator operator = getAssignmentOperator(ctx.op.getText());
switch (operator.getKind())
{
case AssignmentOperator.NONE:
return new AssignmentNode((IReference) left, right);
case AssignmentOperator.ADDITION:
return new AssignmentNode((IReference) left, new AdditionExpressionNode(ArithmeticOperator.Addition, left, right));
case AssignmentOperator.SUBTRACTION:
return new AssignmentNode((IReference) left, new AdditionExpressionNode(ArithmeticOperator.Subtraction, left, right));
case AssignmentOperator.MULTIPLICATION:
return new AssignmentNode((IReference) left, new MultiplicationExpressionNode(ArithmeticOperator.Multiplication, left, right));
case AssignmentOperator.DIVISION:
return new AssignmentNode((IReference) left, new MultiplicationExpressionNode(ArithmeticOperator.Division, left, right));
default:
System.out.println("Unknown assignment operator at line " + ctx.getStart().getLine());
}
}
System.out.println("AssignError at line " + ctx.getStart().getLine());
System.out.println(ctx.getText());
return null;
}
@Override
public Node visitLeft_hand_side(EduCodeParser.Left_hand_sideContext ctx)
{
updateLineNumber(ctx);
if (ctx.field != null)
return new StructReferencingNode(visit(ctx.acc), visit(ctx.field_access()));
else if (ctx.element != null)
return new ArrayReferencingNode(visit(ctx.acc), visit(ctx.element_access()));
else if (ctx.id != null)
return visit(ctx.id);
else
System.out.println("LHS-Error at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitLogic_expression(EduCodeParser.Logic_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));//visit(ctx.getChild(0));
}
@Override
public Node visitOr_expression(EduCodeParser.Or_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new OrExpressionNode(visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in or-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitAnd_expression(EduCodeParser.And_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new AndExpressionNode(visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in and-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitEquality_expression(EduCodeParser.Equality_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new EqualExpressionNode(getLogicalOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in equals-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitRelative_expression(EduCodeParser.Relative_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new RelativeExpressionNode(getLogicalOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("Unexpected child count in relative-expression " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitArithmetic_expression(EduCodeParser.Arithmetic_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitAdditive_expression(EduCodeParser.Additive_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new AdditionExpressionNode(getArithmeticOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("AddError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitMultiplicative_expression(EduCodeParser.Multiplicative_expressionContext ctx)
{
updateLineNumber(ctx);
if (ctx.getChildCount() == 1)
return visit(ctx.right);
else if (ctx.getChildCount() == 3)
return new MultiplicationExpressionNode(getArithmeticOperator(ctx.op.getText()), visit(ctx.left), visit(ctx.right));
System.out.println("MultError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitFactor(EduCodeParser.FactorContext ctx)
{
updateLineNumber(ctx);
if (ctx.literal() != null)
return visit(ctx.literal());
else if (ctx.access() != null)
return visit(ctx.access());
else if (ctx.factor() != null)
{
if (ctx.op.getText().equals("not"))
return new NegateNode(visit(ctx.factor()));
else if (ctx.op.getText().equals("-"))
return new UnaryMinusNode(visit(ctx.factor()));
}
else if (ctx.type_cast() != null)
return visit(ctx.type_cast());
else if (ctx.object_instantiation() != null)
return visit(ctx.object_instantiation());
System.out.println("FactError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitAccess(EduCodeParser.AccessContext ctx)
{
updateLineNumber(ctx);
if (ctx.field_access() != null)
return new StructReferencingNode(visit(ctx.rec), visit(ctx.field_access()));
else if (ctx.element_access() != null)
return new ArrayReferencingNode(visit(ctx.rec), visit(ctx.element_access()));
else if (ctx.method_access() != null)
return new StructReferencingNode(visit(ctx.rec), visit(ctx.method_access()));
else if (ctx.sub != null)
return visit(ctx.sub);
System.out.println("AccessError at line " + ctx.getStart().getLine());
return null;
}
@Override
public Node visitField_access(EduCodeParser.Field_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.id);
}
@Override
public Node visitElement_access(EduCodeParser.Element_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.index);
}
@Override
public Node visitMethod_access(EduCodeParser.Method_accessContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.method);
}
@Override
public Node visitSubfactor(EduCodeParser.SubfactorContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitParenthesis_expression(EduCodeParser.Parenthesis_expressionContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.content);
}
@Override
public Node visitMethod_call(EduCodeParser.Method_callContext ctx)
{
updateLineNumber(ctx);
if (ctx.args != null)
return new MethodInvocationNode((IReference) visit(ctx.id), visit(ctx.args));
else
return new MethodInvocationNode((IReference) visit(ctx.id), null);
}
@Override
public Node visitType_cast(EduCodeParser.Type_castContext ctx)
{
updateLineNumber(ctx);
return new TypeCastNode(getType(ctx.type), visit(ctx.fac));
}
@Override
public Node visitObject_instantiation(EduCodeParser.Object_instantiationContext ctx)
{
updateLineNumber(ctx);
Type classType = getType(ctx.type);
if (ctx.args != null)
return new ObjectInstantiationNode(visit(ctx.args), classType);
else
return new ObjectInstantiationNode(null, classType);
}
@Override
public Node visitEvent_type(EduCodeParser.Event_typeContext ctx)
{
return null;
}
@Override
public Node visitData_type(EduCodeParser.Data_typeContext ctx)
{
return null;
}
@Override
public Node visitLiteral(EduCodeParser.LiteralContext ctx)
{
updateLineNumber(ctx);
return visit(ctx.getChild(0));
}
@Override
public Node visitRange_literal(EduCodeParser.Range_literalContext ctx)
{
updateLineNumber(ctx);
return new RangeNode(visit(ctx.left), visit(ctx.right));
}
@Override
public Node visitString_literal(EduCodeParser.String_literalContext ctx)
{
updateLineNumber(ctx);
return new StringLiteralNode(ctx.STRING_LITERAL().getText());
}
@Override
public Node visitCoordinate_literal(EduCodeParser.Coordinate_literalContext ctx)
{
updateLineNumber(ctx);
return new CoordinatesLiteralNode(visit(ctx.x), visit(ctx.y), visit(ctx.z));
}
@Override
public Node visitNumber_literal(EduCodeParser.Number_literalContext ctx)
{
updateLineNumber(ctx);
return new NumberLiteralNode(Double.parseDouble(ctx.NUMBER_LITERAL().getText()));
}
@Override
public Node visitBool_literal(EduCodeParser.Bool_literalContext ctx)
{
updateLineNumber(ctx);
return new BoolLiteralNode(ctx.BOOL_LITERAL().getText().equals("true"));
}
@Override
public Node visitNull_literal(EduCodeParser.Null_literalContext ctx)
{
updateLineNumber(ctx);
return new NullLiteralNode();
}
@Override
public Node visitIdentifier(EduCodeParser.IdentifierContext ctx)
{
updateLineNumber(ctx);
return new IdentifierReferencingNode(ctx.IDENTIFIER().getText());
}
@Override
public Node visitEnd_of_line(EduCodeParser.End_of_lineContext ctx)
{
return null;
}
}
| Fixed reserved java keywords
| src/main/java/com/educode/visitors/ASTBuilder.java | Fixed reserved java keywords | <ide><path>rc/main/java/com/educode/visitors/ASTBuilder.java
<ide> import com.educode.events.entity.EntityDeathEvent;
<ide> import com.educode.events.entity.robot.RobotAttackedEvent;
<ide> import com.educode.events.entity.robot.RobotDeathEvent;
<del>import com.educode.nodes.base.*;
<add>import com.educode.nodes.base.ListNode;
<add>import com.educode.nodes.base.NaryNode;
<add>import com.educode.nodes.base.Node;
<ide> import com.educode.nodes.expression.AdditionExpressionNode;
<ide> import com.educode.nodes.expression.MultiplicationExpressionNode;
<ide> import com.educode.nodes.expression.RangeNode;
<ide> import com.educode.nodes.statement.conditional.IfNode;
<ide> import com.educode.nodes.statement.conditional.RepeatWhileNode;
<ide> import com.educode.nodes.ungrouped.*;
<del>import com.educode.types.*;
<add>import com.educode.types.ArithmeticOperator;
<add>import com.educode.types.AssignmentOperator;
<add>import com.educode.types.LogicalOperator;
<add>import com.educode.types.Type;
<ide> import org.antlr.v4.runtime.ParserRuleContext;
<ide>
<ide> import java.util.ArrayList;
<add>import java.util.Arrays;
<add>import java.util.List;
<ide>
<ide> /**
<ide> * Created by Thomas Buhl on 10/05/2017.
<ide> */
<ide> public class ASTBuilder extends EduCodeBaseVisitor<Node>
<ide> {
<add> private final List<String> JavaKeywords = Arrays.asList("abstract", "continue", "for", "new", "switch", "assert", "default", "goto", "package", "synchronized", "boolean", "do", "if", "private", "this", "break", "double", "implements", "protected", "throw", "byte", "else", "import", "public", "throws", "case", "enum", "instanceof", "return", "transient", "catch", "extends", "int", "short", "try", "char", "final", "interface", "static", "void", "class", "finally", "long", "strictfp", "volatile", "const", "float", "native", "super", "while");
<ide> private static int _currentLineNumber = 0;
<ide>
<ide> private static void updateLineNumber(ParserRuleContext fromCtx)
<ide> {
<ide> updateLineNumber(ctx);
<ide>
<del> return new IdentifierReferencingNode(ctx.IDENTIFIER().getText());
<add> String identifier = ctx.IDENTIFIER().getText();
<add> if (JavaKeywords.contains(identifier.toLowerCase()))
<add> identifier = "_" + identifier;
<add>
<add> int ﹍dd;
<add>
<add> return new IdentifierReferencingNode(identifier);
<ide> }
<ide>
<ide> @Override |
|
Java | apache-2.0 | e7b124d7fcabe0614268087f3cdfef6c28657464 | 0 | alexparvulescu/jackrabbit-oak,meggermo/jackrabbit-oak,FlakyTestDetection/jackrabbit-oak,tripodsan/jackrabbit-oak,kwin/jackrabbit-oak,meggermo/jackrabbit-oak,ieb/jackrabbit-oak,AndreasAbdi/jackrabbit-oak,code-distillery/jackrabbit-oak,davidegiannella/jackrabbit-oak,yesil/jackrabbit-oak,kwin/jackrabbit-oak,anchela/jackrabbit-oak,davidegiannella/jackrabbit-oak,meggermo/jackrabbit-oak,alexkli/jackrabbit-oak,FlakyTestDetection/jackrabbit-oak,davidegiannella/jackrabbit-oak,code-distillery/jackrabbit-oak,FlakyTestDetection/jackrabbit-oak,leftouterjoin/jackrabbit-oak,code-distillery/jackrabbit-oak,bdelacretaz/jackrabbit-oak,tripodsan/jackrabbit-oak,chetanmeh/jackrabbit-oak,mduerig/jackrabbit-oak,yesil/jackrabbit-oak,rombert/jackrabbit-oak,rombert/jackrabbit-oak,kwin/jackrabbit-oak,AndreasAbdi/jackrabbit-oak,anchela/jackrabbit-oak,francescomari/jackrabbit-oak,alexkli/jackrabbit-oak,mduerig/jackrabbit-oak,rombert/jackrabbit-oak,ieb/jackrabbit-oak,francescomari/jackrabbit-oak,catholicon/jackrabbit-oak,joansmith/jackrabbit-oak,code-distillery/jackrabbit-oak,joansmith/jackrabbit-oak,joansmith/jackrabbit-oak,kwin/jackrabbit-oak,alexkli/jackrabbit-oak,ieb/jackrabbit-oak,catholicon/jackrabbit-oak,alexparvulescu/jackrabbit-oak,davidegiannella/jackrabbit-oak,davidegiannella/jackrabbit-oak,Kast0rTr0y/jackrabbit-oak,afilimonov/jackrabbit-oak,anchela/jackrabbit-oak,chetanmeh/jackrabbit-oak,stillalex/jackrabbit-oak,mduerig/jackrabbit-oak,afilimonov/jackrabbit-oak,stillalex/jackrabbit-oak,alexparvulescu/jackrabbit-oak,FlakyTestDetection/jackrabbit-oak,catholicon/jackrabbit-oak,ieb/jackrabbit-oak,francescomari/jackrabbit-oak,tripodsan/jackrabbit-oak,bdelacretaz/jackrabbit-oak,joansmith/jackrabbit-oak,anchela/jackrabbit-oak,alexparvulescu/jackrabbit-oak,yesil/jackrabbit-oak,Kast0rTr0y/jackrabbit-oak,leftouterjoin/jackrabbit-oak,alexkli/jackrabbit-oak,rombert/jackrabbit-oak,francescomari/jackrabbit-oak,mduerig/jackrabbit-oak,stillalex/jackrabbit-oak,mduerig/jackrabbit-oak,bdelacretaz/jackrabbit-oak,FlakyTestDetection/jackrabbit-oak,francescomari/jackrabbit-oak,catholicon/jackrabbit-oak,stillalex/jackrabbit-oak,catholicon/jackrabbit-oak,stillalex/jackrabbit-oak,chetanmeh/jackrabbit-oak,afilimonov/jackrabbit-oak,afilimonov/jackrabbit-oak,bdelacretaz/jackrabbit-oak,AndreasAbdi/jackrabbit-oak,meggermo/jackrabbit-oak,chetanmeh/jackrabbit-oak,alexparvulescu/jackrabbit-oak,Kast0rTr0y/jackrabbit-oak,leftouterjoin/jackrabbit-oak,joansmith/jackrabbit-oak,AndreasAbdi/jackrabbit-oak,Kast0rTr0y/jackrabbit-oak,code-distillery/jackrabbit-oak,kwin/jackrabbit-oak,anchela/jackrabbit-oak,meggermo/jackrabbit-oak,leftouterjoin/jackrabbit-oak,chetanmeh/jackrabbit-oak,yesil/jackrabbit-oak,tripodsan/jackrabbit-oak,alexkli/jackrabbit-oak | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.jackrabbit.oak.plugins.observation;
import static java.util.Collections.addAll;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.jcr.RepositoryException;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.api.Type;
import org.apache.jackrabbit.oak.commons.PathUtils;
import org.apache.jackrabbit.oak.core.ImmutableRoot;
import org.apache.jackrabbit.oak.namepath.GlobalNameMapper;
import org.apache.jackrabbit.oak.namepath.NamePathMapper;
import org.apache.jackrabbit.oak.namepath.NamePathMapperImpl;
import org.apache.jackrabbit.oak.plugins.observation.filter.VisibleFilter;
import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
import org.apache.jackrabbit.oak.spi.commit.Observer;
import org.apache.jackrabbit.oak.spi.state.NodeState;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Base class for {@code Observer} instances that group changes
* by node instead of tracking them down to individual properties.
*/
public abstract class NodeObserver implements Observer {
private static final Logger LOG = LoggerFactory.getLogger(NodeObserver.class);
private final String path;
private final Set<String> propertyNames = Sets.newHashSet();
private NodeState previousRoot;
/**
* Create a new instance for observing the given path.
* @param path
* @param propertyNames names of properties to report even without a change
*/
protected NodeObserver(String path, String... propertyNames) {
this.path = path;
addAll(this.propertyNames, propertyNames);
}
/**
* A node at {@code path} has been added.
* @param path Path of the added node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void added(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
/**
* A node at {@code path} has been deleted.
* @param path Path of the deleted node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void deleted(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
/**
* A node at {@code path} has been changed.
* @param path Path of the changed node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void changed(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
@Override
public void contentChanged(@Nonnull NodeState root, @Nullable CommitInfo info) {
try {
if (previousRoot != null) {
NamePathMapper namePathMapper = new NamePathMapperImpl(
new GlobalNameMapper(new ImmutableRoot(root)));
Set<String> oakPropertyNames = Sets.newHashSet();
for (String name : propertyNames) {
oakPropertyNames.add(namePathMapper.getJcrName(name));
}
NodeState before = previousRoot;
NodeState after = root;
EventHandler handler = new FilteredHandler(
new VisibleFilter(),
new NodeEventHandler("/", info, namePathMapper, oakPropertyNames));
for (String name : PathUtils.elements(path)) {
String oakName = namePathMapper.getOakName(name);
before = before.getChildNode(oakName);
after = after.getChildNode(oakName);
handler = handler.getChildHandler(oakName, before, after);
}
EventGenerator generator = new EventGenerator(before, after, handler);
while (!generator.isDone()) {
generator.generate();
}
}
previousRoot = root;
} catch (RepositoryException e) {
LOG.warn("Error while handling content change", e);
}
}
private enum EventType {ADDED, DELETED, CHANGED}
private class NodeEventHandler extends DefaultEventHandler {
private final String path;
private final CommitInfo commitInfo;
private final NamePathMapper namePathMapper;
private final Set<String> propertyNames;
private final EventType eventType;
private final Set<String> added = Sets.newHashSet();
private final Set<String> deleted = Sets.newHashSet();
private final Set<String> changed = Sets.newHashSet();
public NodeEventHandler(String path, CommitInfo commitInfo, NamePathMapper namePathMapper,
Set<String> propertyNames) {
this.path = path;
this.commitInfo = commitInfo == null ? CommitInfo.EMPTY : commitInfo;
this.namePathMapper = namePathMapper;
this.propertyNames = propertyNames;
this.eventType = EventType.CHANGED;
}
private NodeEventHandler(NodeEventHandler parent, String name, EventType eventType) {
this.path = "/".equals(parent.path) ? '/' + name : parent.path + '/' + name;
this.commitInfo = parent.commitInfo;
this.namePathMapper = parent.namePathMapper;
this.propertyNames = parent.propertyNames;
this.eventType = eventType;
}
@Override
public void leave(NodeState before, NodeState after) {
switch (eventType) {
case ADDED:
added(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(after), commitInfo);
break;
case DELETED:
deleted(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(before), commitInfo);
break;
case CHANGED:
if (!added.isEmpty() || ! deleted.isEmpty() || !changed.isEmpty()) {
changed(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(after), commitInfo);
}
break;
}
}
private Map<String, String> collectProperties(NodeState node) {
Map<String, String> properties = Maps.newHashMap();
for (String name : propertyNames) {
PropertyState p = node.getProperty(name);
if (p != null && !p.isArray()) {
properties.put(name, p.getValue(Type.STRING));
}
}
return properties;
}
@Override
public EventHandler getChildHandler(String name, NodeState before, NodeState after) {
if (!before.exists()) {
return new NodeEventHandler(this, name, EventType.ADDED);
} else if (!after.exists()) {
return new NodeEventHandler(this, name, EventType.DELETED);
} else {
return new NodeEventHandler(this, name, EventType.CHANGED);
}
}
@Override
public void propertyAdded(PropertyState after) {
added.add(namePathMapper.getJcrName(after.getName()));
}
@Override
public void propertyChanged(PropertyState before, PropertyState after) {
changed.add(namePathMapper.getJcrName(after.getName()));
}
@Override
public void propertyDeleted(PropertyState before) {
deleted.add(namePathMapper.getJcrName(before.getName()));
}
}
}
| oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/NodeObserver.java | /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 org.apache.jackrabbit.oak.plugins.observation;
import static java.util.Collections.addAll;
import java.util.Map;
import java.util.Set;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.api.Type;
import org.apache.jackrabbit.oak.commons.PathUtils;
import org.apache.jackrabbit.oak.core.ImmutableRoot;
import org.apache.jackrabbit.oak.namepath.GlobalNameMapper;
import org.apache.jackrabbit.oak.namepath.NamePathMapper;
import org.apache.jackrabbit.oak.namepath.NamePathMapperImpl;
import org.apache.jackrabbit.oak.plugins.observation.filter.VisibleFilter;
import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
import org.apache.jackrabbit.oak.spi.commit.Observer;
import org.apache.jackrabbit.oak.spi.state.NodeState;
/**
* Base class for {@code Observer} instances that group changes
* by node instead of tracking them down to individual properties.
*/
public abstract class NodeObserver implements Observer {
private final String path;
private final Set<String> propertyNames = Sets.newHashSet();
private NodeState previousRoot;
/**
* Create a new instance for observing the given path.
* @param path
* @param propertyNames names of properties to report even without a change
*/
protected NodeObserver(String path, String... propertyNames) {
this.path = path;
addAll(this.propertyNames, propertyNames);
}
/**
* A node at {@code path} has been added.
* @param path Path of the added node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void added(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
/**
* A node at {@code path} has been deleted.
* @param path Path of the deleted node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void deleted(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
/**
* A node at {@code path} has been changed.
* @param path Path of the changed node.
* @param added Names of the added properties.
* @param deleted Names of the deleted properties.
* @param changed Names of the changed properties.
* @param properties Properties as specified in the constructor
* @param commitInfo commit info associated with this change.
*/
protected abstract void changed(
@Nonnull String path,
@Nonnull Set<String> added,
@Nonnull Set<String> deleted,
@Nonnull Set<String> changed,
@Nonnull Map<String, String> properties,
@Nonnull CommitInfo commitInfo);
@Override
public void contentChanged(@Nonnull NodeState root, @Nullable CommitInfo info) {
if (previousRoot != null) {
NamePathMapper namePathMapper = new NamePathMapperImpl(
new GlobalNameMapper(new ImmutableRoot(root)));
NodeState before = previousRoot;
NodeState after = root;
EventHandler handler = new FilteredHandler(
new VisibleFilter(),
new NodeEventHandler("/", info, namePathMapper));
for (String name : PathUtils.elements(path)) {
before = before.getChildNode(name);
after = after.getChildNode(name);
handler = handler.getChildHandler(name, before, after);
}
EventGenerator generator = new EventGenerator(before, after, handler);
while (!generator.isDone()) {
generator.generate();
}
}
previousRoot = root;
}
private enum EventType {ADDED, DELETED, CHANGED}
private class NodeEventHandler extends DefaultEventHandler {
private final String path;
private final CommitInfo commitInfo;
private final NamePathMapper namePathMapper;
private final EventType eventType;
private final Set<String> added = Sets.newHashSet();
private final Set<String> deleted = Sets.newHashSet();
private final Set<String> changed = Sets.newHashSet();
public NodeEventHandler(String path, CommitInfo commitInfo, NamePathMapper namePathMapper) {
this.path = path;
this.commitInfo = commitInfo == null ? CommitInfo.EMPTY : commitInfo;
this.namePathMapper = namePathMapper;
this.eventType = EventType.CHANGED;
}
private NodeEventHandler(NodeEventHandler parent, String name, EventType eventType) {
this.path = "/".equals(parent.path) ? '/' + name : parent.path + '/' + name;
this.commitInfo = parent.commitInfo;
this.namePathMapper = parent.namePathMapper;
this.eventType = eventType;
}
@Override
public void leave(NodeState before, NodeState after) {
switch (eventType) {
case ADDED:
added(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(after), commitInfo);
break;
case DELETED:
deleted(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(before), commitInfo);
break;
case CHANGED:
if (!added.isEmpty() || ! deleted.isEmpty() || !changed.isEmpty()) {
changed(namePathMapper.getJcrPath(path), added, deleted, changed,
collectProperties(after), commitInfo);
}
break;
}
}
private Map<String, String> collectProperties(NodeState node) {
Map<String, String> properties = Maps.newHashMap();
for (String name : propertyNames) {
PropertyState p = node.getProperty(name);
if (p != null && !p.isArray()) {
properties.put(name, p.getValue(Type.STRING));
}
}
return properties;
}
@Override
public EventHandler getChildHandler(String name, NodeState before, NodeState after) {
if (!before.exists()) {
return new NodeEventHandler(this, name, EventType.ADDED);
} else if (!after.exists()) {
return new NodeEventHandler(this, name, EventType.DELETED);
} else {
return new NodeEventHandler(this, name, EventType.CHANGED);
}
}
@Override
public void propertyAdded(PropertyState after) {
added.add(namePathMapper.getJcrName(after.getName()));
}
@Override
public void propertyChanged(PropertyState before, PropertyState after) {
changed.add(namePathMapper.getJcrName(after.getName()));
}
@Override
public void propertyDeleted(PropertyState before) {
deleted.add(namePathMapper.getJcrName(before.getName()));
}
}
}
| OAK-1514: Support for Sling JcrResourceListener
Correct Jcr to Oak name conversion
git-svn-id: 67138be12999c61558c3dd34328380c8e4523e73@1576949 13f79535-47bb-0310-9956-ffa450edef68
| oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/NodeObserver.java | OAK-1514: Support for Sling JcrResourceListener Correct Jcr to Oak name conversion | <ide><path>ak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/NodeObserver.java
<ide>
<ide> import javax.annotation.Nonnull;
<ide> import javax.annotation.Nullable;
<add>import javax.jcr.RepositoryException;
<ide>
<ide> import com.google.common.collect.Maps;
<ide> import com.google.common.collect.Sets;
<ide> import org.apache.jackrabbit.oak.spi.commit.CommitInfo;
<ide> import org.apache.jackrabbit.oak.spi.commit.Observer;
<ide> import org.apache.jackrabbit.oak.spi.state.NodeState;
<add>import org.slf4j.Logger;
<add>import org.slf4j.LoggerFactory;
<ide>
<ide> /**
<ide> * Base class for {@code Observer} instances that group changes
<ide> * by node instead of tracking them down to individual properties.
<ide> */
<ide> public abstract class NodeObserver implements Observer {
<add> private static final Logger LOG = LoggerFactory.getLogger(NodeObserver.class);
<add>
<ide> private final String path;
<ide> private final Set<String> propertyNames = Sets.newHashSet();
<ide>
<ide>
<ide> @Override
<ide> public void contentChanged(@Nonnull NodeState root, @Nullable CommitInfo info) {
<del> if (previousRoot != null) {
<del> NamePathMapper namePathMapper = new NamePathMapperImpl(
<del> new GlobalNameMapper(new ImmutableRoot(root)));
<del>
<del> NodeState before = previousRoot;
<del> NodeState after = root;
<del> EventHandler handler = new FilteredHandler(
<del> new VisibleFilter(),
<del> new NodeEventHandler("/", info, namePathMapper));
<del> for (String name : PathUtils.elements(path)) {
<del> before = before.getChildNode(name);
<del> after = after.getChildNode(name);
<del> handler = handler.getChildHandler(name, before, after);
<del> }
<del>
<del> EventGenerator generator = new EventGenerator(before, after, handler);
<del> while (!generator.isDone()) {
<del> generator.generate();
<del> }
<del> }
<del>
<del> previousRoot = root;
<add> try {
<add> if (previousRoot != null) {
<add> NamePathMapper namePathMapper = new NamePathMapperImpl(
<add> new GlobalNameMapper(new ImmutableRoot(root)));
<add>
<add> Set<String> oakPropertyNames = Sets.newHashSet();
<add> for (String name : propertyNames) {
<add> oakPropertyNames.add(namePathMapper.getJcrName(name));
<add> }
<add> NodeState before = previousRoot;
<add> NodeState after = root;
<add> EventHandler handler = new FilteredHandler(
<add> new VisibleFilter(),
<add> new NodeEventHandler("/", info, namePathMapper, oakPropertyNames));
<add> for (String name : PathUtils.elements(path)) {
<add> String oakName = namePathMapper.getOakName(name);
<add> before = before.getChildNode(oakName);
<add> after = after.getChildNode(oakName);
<add> handler = handler.getChildHandler(oakName, before, after);
<add> }
<add>
<add> EventGenerator generator = new EventGenerator(before, after, handler);
<add> while (!generator.isDone()) {
<add> generator.generate();
<add> }
<add> }
<add>
<add> previousRoot = root;
<add> } catch (RepositoryException e) {
<add> LOG.warn("Error while handling content change", e);
<add> }
<ide> }
<ide>
<ide> private enum EventType {ADDED, DELETED, CHANGED}
<ide> private final String path;
<ide> private final CommitInfo commitInfo;
<ide> private final NamePathMapper namePathMapper;
<add> private final Set<String> propertyNames;
<ide> private final EventType eventType;
<ide> private final Set<String> added = Sets.newHashSet();
<ide> private final Set<String> deleted = Sets.newHashSet();
<ide> private final Set<String> changed = Sets.newHashSet();
<ide>
<del> public NodeEventHandler(String path, CommitInfo commitInfo, NamePathMapper namePathMapper) {
<add> public NodeEventHandler(String path, CommitInfo commitInfo, NamePathMapper namePathMapper,
<add> Set<String> propertyNames) {
<ide> this.path = path;
<ide> this.commitInfo = commitInfo == null ? CommitInfo.EMPTY : commitInfo;
<ide> this.namePathMapper = namePathMapper;
<add> this.propertyNames = propertyNames;
<ide> this.eventType = EventType.CHANGED;
<ide> }
<ide>
<ide> this.path = "/".equals(parent.path) ? '/' + name : parent.path + '/' + name;
<ide> this.commitInfo = parent.commitInfo;
<ide> this.namePathMapper = parent.namePathMapper;
<add> this.propertyNames = parent.propertyNames;
<ide> this.eventType = eventType;
<ide> }
<ide> |
|
Java | apache-2.0 | f04ff40d289ce5ef8b172af39a924c0d8ab1609f | 0 | hmcl/storm-apache,kevpeek/storm,srdo/storm,kevinconaway/storm,Aloomaio/incubator-storm,ujfjhz/storm,F30/storm,kamleshbhatt/storm,hmcc/storm,kishorvpatil/incubator-storm,srdo/storm,F30/storm,hmcc/storm,erikdw/storm,adityasharad/storm,knusbaum/incubator-storm,Crim/storm,srishtyagrawal/storm,kevpeek/storm,adityasharad/storm,cluo512/storm,erikdw/storm,hmcl/storm-apache,srishtyagrawal/storm,kamleshbhatt/storm,0x726d77/storm,Crim/storm,F30/storm,knusbaum/incubator-storm,0x726d77/storm,srishtyagrawal/storm,sakanaou/storm,kamleshbhatt/storm,erikdw/storm,0x726d77/storm,roshannaik/storm,F30/storm,srishtyagrawal/storm,sakanaou/storm,F30/storm,Aloomaio/incubator-storm,raviperi/storm,roshannaik/storm,hmcc/storm,cluo512/storm,adityasharad/storm,kishorvpatil/incubator-storm,carl34/storm,knusbaum/incubator-storm,carl34/storm,kevpeek/storm,kamleshbhatt/storm,ujfjhz/storm,kishorvpatil/incubator-storm,carl34/storm,sakanaou/storm,srdo/storm,cluo512/storm,cluo512/storm,0x726d77/storm,metamx/incubator-storm,kevpeek/storm,Aloomaio/incubator-storm,pczb/storm,srdo/storm,cluo512/storm,Crim/storm,hmcl/storm-apache,raviperi/storm,carl34/storm,srdo/storm,raviperi/storm,F30/storm,kevpeek/storm,erikdw/storm,kishorvpatil/incubator-storm,adityasharad/storm,kevpeek/storm,metamx/incubator-storm,Crim/storm,srishtyagrawal/storm,ujfjhz/storm,erikdw/storm,adityasharad/storm,erikdw/storm,raviperi/storm,hmcl/storm-apache,pczb/storm,kevinconaway/storm,cluo512/storm,Crim/storm,hmcc/storm,kevinconaway/storm,pczb/storm,ujfjhz/storm,kevinconaway/storm,roshannaik/storm,sakanaou/storm,knusbaum/incubator-storm,erikdw/storm,pczb/storm,kevpeek/storm,carl34/storm,metamx/incubator-storm,adityasharad/storm,sakanaou/storm,pczb/storm,roshannaik/storm,knusbaum/incubator-storm,0x726d77/storm,knusbaum/incubator-storm,roshannaik/storm,kishorvpatil/incubator-storm,srdo/storm,metamx/incubator-storm,kishorvpatil/incubator-storm,0x726d77/storm,srdo/storm,pczb/storm,cluo512/storm,raviperi/storm,Aloomaio/incubator-storm,Aloomaio/incubator-storm,raviperi/storm,carl34/storm,metamx/incubator-storm,roshannaik/storm,hmcl/storm-apache,kamleshbhatt/storm,Crim/storm,knusbaum/incubator-storm,hmcc/storm,Crim/storm,kishorvpatil/incubator-storm,srishtyagrawal/storm,sakanaou/storm,sakanaou/storm,kamleshbhatt/storm,ujfjhz/storm,pczb/storm,kevinconaway/storm,raviperi/storm,hmcc/storm,ujfjhz/storm,srishtyagrawal/storm,hmcl/storm-apache,0x726d77/storm,ujfjhz/storm,carl34/storm,kevinconaway/storm,kamleshbhatt/storm,Aloomaio/incubator-storm,kevinconaway/storm,hmcc/storm,hmcl/storm-apache,Aloomaio/incubator-storm,F30/storm,roshannaik/storm,adityasharad/storm | package storm.kafka;
import backtype.storm.Config;
import backtype.storm.LocalCluster;
import backtype.storm.spout.SpoutOutputCollector;
import backtype.storm.task.TopologyContext;
import backtype.storm.topology.OutputFieldsDeclarer;
import backtype.storm.topology.TopologyBuilder;
import backtype.storm.topology.base.BaseRichSpout;
import backtype.storm.transactional.state.TransactionalState;
import backtype.storm.utils.Utils;
import java.io.Serializable;
import java.util.ArrayList;
import kafka.javaapi.consumer.SimpleConsumer;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.UUID;
import org.apache.log4j.Logger;
import kafka.javaapi.message.ByteBufferMessageSet;
import kafka.message.MessageAndOffset;
import kafka.api.FetchRequest;
// TODO: need to add blacklisting
// TODO: need to make a best effort to not re-emit messages if don't have to
public class KafkaSpout extends BaseRichSpout {
public static class ZooMeta implements Serializable {
String id;
long offset;
public ZooMeta(String id, long offset) {
this.id = id;
this.offset = offset;
}
}
static enum EmitState {
EMITTED_MORE_LEFT,
EMITTED_END,
NO_EMITTED
}
public static final Logger LOG = Logger.getLogger(KafkaSpout.class);
static class KafkaMessageId {
public int partition;
public long offset;
public KafkaMessageId(int partition, long offset) {
this.partition = partition;
this.offset = offset;
}
}
protected class PartitionManager {
Long _emittedToOffset;
SortedSet<Long> _pending = new TreeSet<Long>();
Long _committedTo;
int _partition;
LinkedList<MessageAndOffset> _waitingToEmit = new LinkedList<MessageAndOffset>();
public PartitionManager(int partition) {
_partition = partition;
ZooMeta zooMeta = (ZooMeta) _state.getData(committedPath());
SimpleConsumer consumer = _partitions.getConsumer(_partition);
int hostPartition = _partitions.getHostPartition(_partition);
//the id stuff makes sure the spout doesn't reset the offset if it restarts
if(zooMeta==null || (!_uuid.equals(zooMeta.id) && _spoutConfig.forceFromStart)) {
_committedTo = consumer.getOffsetsBefore(_spoutConfig.topic, hostPartition, _spoutConfig.startOffsetTime, 1)[0];
} else {
_committedTo = zooMeta.offset;
}
LOG.info("Starting Kafka " + consumer.host() + ":" + hostPartition + " from offset " + _committedTo);
_emittedToOffset = _committedTo;
}
//returns false if it's reached the end of current batch
public EmitState next() {
if(_waitingToEmit.isEmpty()) fill();
MessageAndOffset toEmit = _waitingToEmit.pollFirst();
if(toEmit==null) return EmitState.NO_EMITTED;
List<Object> tup = _spoutConfig.scheme.deserialize(Utils.toByteArray(toEmit.message().payload()));
_collector.emit(tup, new KafkaMessageId(_partition, actualOffset(toEmit)));
if(_waitingToEmit.size()>0) {
return EmitState.EMITTED_MORE_LEFT;
} else {
return EmitState.EMITTED_END;
}
}
private void fill() {
SimpleConsumer consumer = _partitions.getConsumer(_partition);
int hostPartition = _partitions.getHostPartition(_partition);
//LOG.info("Fetching from Kafka: " + consumer.host() + ":" + hostPartition);
ByteBufferMessageSet msgs = consumer.fetch(
new FetchRequest(
_spoutConfig.topic,
hostPartition,
_emittedToOffset,
_spoutConfig.fetchSizeBytes));
//LOG.info("Fetched " + msgs.underlying().size() + " messages from Kafka: " + consumer.host() + ":" + hostPartition);
for(MessageAndOffset msg: msgs) {
_pending.add(actualOffset(msg));
_waitingToEmit.add(msg);
_emittedToOffset = msg.offset();
}
}
public void ack(Long offset) {
_pending.remove(offset);
}
public void fail(Long offset) {
//TODO: should it use in-memory ack set to skip anything that's been acked but not committed???
// things might get crazy with lots of timeouts
if(_emittedToOffset > offset) {
_emittedToOffset = offset;
_pending.tailSet(offset).clear();
}
}
public void commit() {
long committedTo;
if(_pending.isEmpty()) {
committedTo = _emittedToOffset;
} else {
committedTo = _pending.first();
}
if(committedTo!=_committedTo) {
_state.setData(committedPath(), new ZooMeta(_uuid, committedTo));
_committedTo = committedTo;
}
}
private long actualOffset(MessageAndOffset msg) {
return msg.offset() - msg.message().serializedSize();
}
private String committedPath() {
return _spoutConfig.id + "/" + _partition;
}
}
String _uuid = UUID.randomUUID().toString();
SpoutConfig _spoutConfig;
SpoutOutputCollector _collector;
TransactionalState _state;
KafkaPartitionConnections _partitions;
Map<Integer, PartitionManager> _managers = new HashMap<Integer, PartitionManager>();
long _lastUpdateMs = 0;
int _currPartitionIndex = 0;
List<Integer> _managedPartitions = new ArrayList<Integer>();
public KafkaSpout(SpoutConfig spoutConf) {
_spoutConfig = spoutConf;
}
@Override
public void open(Map conf, TopologyContext context, SpoutOutputCollector collector) {
_collector = collector;
Map stateConf = new HashMap(conf);
List<String> zkServers = _spoutConfig.zkServers;
if(zkServers==null) zkServers = (List<String>) conf.get(Config.STORM_ZOOKEEPER_SERVERS);
Integer zkPort = _spoutConfig.zkPort;
if(zkPort==null) zkPort = ((Number) conf.get(Config.STORM_ZOOKEEPER_PORT)).intValue();
String zkRoot = _spoutConfig.zkRoot;
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_SERVERS, zkServers);
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_PORT, zkPort);
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_ROOT, zkRoot);
Config componentConf = new Config();
componentConf.registerSerialization(ZooMeta.class);
// using TransactionalState like this is a hack
_state = TransactionalState.newUserState(stateConf, _spoutConfig.id, null);
_partitions = new KafkaPartitionConnections(_spoutConfig);
int totalPartitions = _spoutConfig.partitionsPerHost * _spoutConfig.hosts.size();
int numTasks = context.getComponentTasks(context.getThisComponentId()).size();
for(int p = context.getThisTaskIndex(); p < totalPartitions; p+=numTasks) {
_managedPartitions.add(p);
_managers.put(p, new PartitionManager(p));
}
}
@Override
public void nextTuple() {
//TODO: change behavior to stick with one partition until it's empty
for(int i=0; i<_managedPartitions.size(); i++) {
int partition = _managedPartitions.get(_currPartitionIndex);
_currPartitionIndex = (_currPartitionIndex + 1) % _managedPartitions.size();
EmitState state = _managers.get(partition).next();
if(state!=EmitState.EMITTED_MORE_LEFT) {
_currPartitionIndex = (_currPartitionIndex + 1) % _managedPartitions.size();
}
if(state!=EmitState.NO_EMITTED) {
break;
}
}
long now = System.currentTimeMillis();
if((now - _lastUpdateMs) > _spoutConfig.stateUpdateIntervalMs) {
commit();
}
}
@Override
public void ack(Object msgId) {
KafkaMessageId id = (KafkaMessageId) msgId;
_managers.get(id.partition).ack(id.offset);
}
@Override
public void fail(Object msgId) {
KafkaMessageId id = (KafkaMessageId) msgId;
_managers.get(id.partition).fail(id.offset);
}
@Override
public void deactivate() {
commit();
}
@Override
public void declareOutputFields(OutputFieldsDeclarer declarer) {
declarer.declare(_spoutConfig.scheme.getOutputFields());
}
private void commit() {
_lastUpdateMs = System.currentTimeMillis();
for(PartitionManager manager: _managers.values()) {
manager.commit();
}
}
public static void main(String[] args) {
TopologyBuilder builder = new TopologyBuilder();
List<String> hosts = new ArrayList<String>();
hosts.add("localhost");
//hosts.add("smf1-atc-13-sr1.prod.twitter.com");
//hosts.add("smf1-atx-26-sr1.prod.twitter.com");
//hosts.add("smf1-atw-05-sr4.prod.twitter.com");
//hosts.add("smf1-aty-37-sr4.prod.twitter.com");
SpoutConfig spoutConf = new SpoutConfig(hosts, 8, "clicks", "/kafkastorm", "id");
spoutConf.scheme = new StringScheme();
spoutConf.forceStartOffsetTime(-2);
// spoutConf.zkServers = new ArrayList<String>() {{
// add("localhost");
// }};
// spoutConf.zkPort = 2181;
builder.setSpout("spout", new KafkaSpout(spoutConf), 3);
Config conf = new Config();
//conf.setDebug(true);
LocalCluster cluster = new LocalCluster();
cluster.submitTopology("kafka-test", conf, builder.createTopology());
Utils.sleep(600000);
}
}
| src/jvm/storm/kafka/KafkaSpout.java | package storm.kafka;
import backtype.storm.Config;
import backtype.storm.LocalCluster;
import backtype.storm.spout.SpoutOutputCollector;
import backtype.storm.task.TopologyContext;
import backtype.storm.topology.OutputFieldsDeclarer;
import backtype.storm.topology.TopologyBuilder;
import backtype.storm.topology.base.BaseRichSpout;
import backtype.storm.transactional.state.TransactionalState;
import backtype.storm.utils.Utils;
import java.util.ArrayList;
import kafka.javaapi.consumer.SimpleConsumer;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.SortedSet;
import java.util.TreeSet;
import org.apache.log4j.Logger;
import kafka.javaapi.message.ByteBufferMessageSet;
import kafka.message.MessageAndOffset;
import kafka.api.FetchRequest;
// TODO: need to add blacklisting
// TODO: need to make a best effort to not re-emit messages if don't have to
public class KafkaSpout extends BaseRichSpout {
public static final Logger LOG = Logger.getLogger(KafkaSpout.class);
static class KafkaMessageId {
public int partition;
public long offset;
public KafkaMessageId(int partition, long offset) {
this.partition = partition;
this.offset = offset;
}
}
protected class PartitionManager {
Long _emittedToOffset;
SortedSet<Long> _pending = new TreeSet<Long>();
Long _committedTo;
int _partition;
LinkedList<MessageAndOffset> _waitingToEmit = new LinkedList<MessageAndOffset>();
public PartitionManager(int partition) {
_partition = partition;
_committedTo = (Long) _state.getData(committedPath());
SimpleConsumer consumer = _partitions.getConsumer(_partition);
int hostPartition = _partitions.getHostPartition(_partition);
if(_committedTo==null || _spoutConfig.forceFromStart) {
_committedTo = consumer.getOffsetsBefore(_spoutConfig.topic, hostPartition, _spoutConfig.startOffsetTime, 1)[0];
}
LOG.info("Starting Kafka " + consumer.host() + ":" + hostPartition + " from offset " + _committedTo);
_emittedToOffset = _committedTo;
}
public boolean next() {
if(_waitingToEmit.isEmpty()) fill();
MessageAndOffset toEmit = _waitingToEmit.pollFirst();
if(toEmit==null) return false;
List<Object> tup = _spoutConfig.scheme.deserialize(Utils.toByteArray(toEmit.message().payload()));
_collector.emit(tup, new KafkaMessageId(_partition, actualOffset(toEmit)));
return true;
}
private void fill() {
SimpleConsumer consumer = _partitions.getConsumer(_partition);
int hostPartition = _partitions.getHostPartition(_partition);
//LOG.info("Fetching from Kafka: " + consumer.host() + ":" + hostPartition);
ByteBufferMessageSet msgs = consumer.fetch(
new FetchRequest(
_spoutConfig.topic,
hostPartition,
_emittedToOffset,
_spoutConfig.fetchSizeBytes));
//LOG.info("Fetched " + msgs.underlying().size() + " messages from Kafka: " + consumer.host() + ":" + hostPartition);
for(MessageAndOffset msg: msgs) {
_pending.add(actualOffset(msg));
_waitingToEmit.add(msg);
_emittedToOffset = msg.offset();
}
}
public void ack(Long offset) {
_pending.remove(offset);
}
public void fail(Long offset) {
//TODO: should it use in-memory ack set to skip anything that's been acked but not committed???
// things might get crazy with lots of timeouts
if(_emittedToOffset > offset) {
_emittedToOffset = offset;
_pending.tailSet(offset).clear();
}
}
public void commit() {
long committedTo;
if(_pending.isEmpty()) {
committedTo = _emittedToOffset;
} else {
committedTo = _pending.first();
}
if(committedTo!=_committedTo) {
_state.setData(committedPath(), committedTo);
_committedTo = committedTo;
}
}
private long actualOffset(MessageAndOffset msg) {
return msg.offset() - msg.message().serializedSize();
}
private String committedPath() {
return _spoutConfig.id + "/" + _partition;
}
}
SpoutConfig _spoutConfig;
SpoutOutputCollector _collector;
TransactionalState _state;
KafkaPartitionConnections _partitions;
Map<Integer, PartitionManager> _managers = new HashMap<Integer, PartitionManager>();
long _lastUpdateMs = 0;
int _currPartitionIndex = 0;
List<Integer> _managedPartitions = new ArrayList<Integer>();
public KafkaSpout(SpoutConfig spoutConf) {
_spoutConfig = spoutConf;
}
@Override
public void open(Map conf, TopologyContext context, SpoutOutputCollector collector) {
_collector = collector;
Map stateConf = new HashMap(conf);
List<String> zkServers = _spoutConfig.zkServers;
if(zkServers==null) zkServers = (List<String>) conf.get(Config.STORM_ZOOKEEPER_SERVERS);
Integer zkPort = _spoutConfig.zkPort;
if(zkPort==null) zkPort = ((Number) conf.get(Config.STORM_ZOOKEEPER_PORT)).intValue();
String zkRoot = _spoutConfig.zkRoot;
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_SERVERS, zkServers);
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_PORT, zkPort);
stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_ROOT, zkRoot);
// using TransactionalState like this is a hack
_state = TransactionalState.newUserState(stateConf, _spoutConfig.id, null);
_partitions = new KafkaPartitionConnections(_spoutConfig);
int totalPartitions = _spoutConfig.partitionsPerHost * _spoutConfig.hosts.size();
int numTasks = context.getComponentTasks(context.getThisComponentId()).size();
for(int p = context.getThisTaskIndex(); p < totalPartitions; p+=numTasks) {
_managedPartitions.add(p);
_managers.put(p, new PartitionManager(p));
}
}
@Override
public void nextTuple() {
for(int i=0; i<_managedPartitions.size(); i++) {
int partition = _managedPartitions.get(_currPartitionIndex);
_currPartitionIndex = (_currPartitionIndex + 1) % _managedPartitions.size();
if(_managers.get(partition).next()) break;
}
long now = System.currentTimeMillis();
if((now - _lastUpdateMs) > _spoutConfig.stateUpdateIntervalMs) {
commit();
}
}
@Override
public void ack(Object msgId) {
KafkaMessageId id = (KafkaMessageId) msgId;
_managers.get(id.partition).ack(id.offset);
}
@Override
public void fail(Object msgId) {
KafkaMessageId id = (KafkaMessageId) msgId;
_managers.get(id.partition).fail(id.offset);
}
@Override
public void deactivate() {
commit();
}
@Override
public void declareOutputFields(OutputFieldsDeclarer declarer) {
declarer.declare(_spoutConfig.scheme.getOutputFields());
}
private void commit() {
_lastUpdateMs = System.currentTimeMillis();
for(PartitionManager manager: _managers.values()) {
manager.commit();
}
}
public static void main(String[] args) {
TopologyBuilder builder = new TopologyBuilder();
List<String> hosts = new ArrayList<String>();
hosts.add("localhost");
//hosts.add("smf1-atc-13-sr1.prod.twitter.com");
//hosts.add("smf1-atx-26-sr1.prod.twitter.com");
//hosts.add("smf1-atw-05-sr4.prod.twitter.com");
//hosts.add("smf1-aty-37-sr4.prod.twitter.com");
SpoutConfig spoutConf = new SpoutConfig(hosts, 8, "clicks", "/kafkastorm", "id");
spoutConf.scheme = new StringScheme();
spoutConf.forceStartOffsetTime(1335774001000L);
// spoutConf.zkServers = new ArrayList<String>() {{
// add("localhost");
// }};
// spoutConf.zkPort = 2181;
builder.setSpout("spout", new KafkaSpout(spoutConf), 3);
Config conf = new Config();
//conf.setDebug(true);
LocalCluster cluster = new LocalCluster();
cluster.submitTopology("kafka-test", conf, builder.createTopology());
Utils.sleep(600000);
}
}
| round robin only after finishing batch for one partition, fix how resetting of offsets works
| src/jvm/storm/kafka/KafkaSpout.java | round robin only after finishing batch for one partition, fix how resetting of offsets works | <ide><path>rc/jvm/storm/kafka/KafkaSpout.java
<ide> import backtype.storm.topology.base.BaseRichSpout;
<ide> import backtype.storm.transactional.state.TransactionalState;
<ide> import backtype.storm.utils.Utils;
<add>import java.io.Serializable;
<ide> import java.util.ArrayList;
<ide> import kafka.javaapi.consumer.SimpleConsumer;
<ide> import java.util.HashMap;
<ide> import java.util.Map;
<ide> import java.util.SortedSet;
<ide> import java.util.TreeSet;
<add>import java.util.UUID;
<ide> import org.apache.log4j.Logger;
<ide> import kafka.javaapi.message.ByteBufferMessageSet;
<ide> import kafka.message.MessageAndOffset;
<ide> // TODO: need to add blacklisting
<ide> // TODO: need to make a best effort to not re-emit messages if don't have to
<ide> public class KafkaSpout extends BaseRichSpout {
<add> public static class ZooMeta implements Serializable {
<add> String id;
<add> long offset;
<add>
<add> public ZooMeta(String id, long offset) {
<add> this.id = id;
<add> this.offset = offset;
<add> }
<add> }
<add>
<add> static enum EmitState {
<add> EMITTED_MORE_LEFT,
<add> EMITTED_END,
<add> NO_EMITTED
<add> }
<add>
<ide> public static final Logger LOG = Logger.getLogger(KafkaSpout.class);
<ide>
<ide> static class KafkaMessageId {
<ide>
<ide> public PartitionManager(int partition) {
<ide> _partition = partition;
<del> _committedTo = (Long) _state.getData(committedPath());
<add> ZooMeta zooMeta = (ZooMeta) _state.getData(committedPath());
<ide> SimpleConsumer consumer = _partitions.getConsumer(_partition);
<ide> int hostPartition = _partitions.getHostPartition(_partition);
<del> if(_committedTo==null || _spoutConfig.forceFromStart) {
<add>
<add> //the id stuff makes sure the spout doesn't reset the offset if it restarts
<add> if(zooMeta==null || (!_uuid.equals(zooMeta.id) && _spoutConfig.forceFromStart)) {
<ide> _committedTo = consumer.getOffsetsBefore(_spoutConfig.topic, hostPartition, _spoutConfig.startOffsetTime, 1)[0];
<add> } else {
<add> _committedTo = zooMeta.offset;
<ide> }
<ide> LOG.info("Starting Kafka " + consumer.host() + ":" + hostPartition + " from offset " + _committedTo);
<ide> _emittedToOffset = _committedTo;
<ide> }
<ide>
<del> public boolean next() {
<add> //returns false if it's reached the end of current batch
<add> public EmitState next() {
<ide> if(_waitingToEmit.isEmpty()) fill();
<ide> MessageAndOffset toEmit = _waitingToEmit.pollFirst();
<del> if(toEmit==null) return false;
<add> if(toEmit==null) return EmitState.NO_EMITTED;
<ide> List<Object> tup = _spoutConfig.scheme.deserialize(Utils.toByteArray(toEmit.message().payload()));
<ide> _collector.emit(tup, new KafkaMessageId(_partition, actualOffset(toEmit)));
<del> return true;
<add> if(_waitingToEmit.size()>0) {
<add> return EmitState.EMITTED_MORE_LEFT;
<add> } else {
<add> return EmitState.EMITTED_END;
<add> }
<ide> }
<ide>
<ide> private void fill() {
<ide> committedTo = _pending.first();
<ide> }
<ide> if(committedTo!=_committedTo) {
<del> _state.setData(committedPath(), committedTo);
<add> _state.setData(committedPath(), new ZooMeta(_uuid, committedTo));
<ide> _committedTo = committedTo;
<ide> }
<ide> }
<ide> }
<ide> }
<ide>
<add> String _uuid = UUID.randomUUID().toString();
<ide> SpoutConfig _spoutConfig;
<ide> SpoutOutputCollector _collector;
<ide> TransactionalState _state;
<ide> stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_PORT, zkPort);
<ide> stateConf.put(Config.TRANSACTIONAL_ZOOKEEPER_ROOT, zkRoot);
<ide>
<add> Config componentConf = new Config();
<add> componentConf.registerSerialization(ZooMeta.class);
<add>
<ide> // using TransactionalState like this is a hack
<ide> _state = TransactionalState.newUserState(stateConf, _spoutConfig.id, null);
<ide> _partitions = new KafkaPartitionConnections(_spoutConfig);
<ide> }
<ide>
<ide> @Override
<del> public void nextTuple() {
<add> public void nextTuple() {
<add> //TODO: change behavior to stick with one partition until it's empty
<ide> for(int i=0; i<_managedPartitions.size(); i++) {
<ide> int partition = _managedPartitions.get(_currPartitionIndex);
<ide> _currPartitionIndex = (_currPartitionIndex + 1) % _managedPartitions.size();
<del> if(_managers.get(partition).next()) break;
<add> EmitState state = _managers.get(partition).next();
<add> if(state!=EmitState.EMITTED_MORE_LEFT) {
<add> _currPartitionIndex = (_currPartitionIndex + 1) % _managedPartitions.size();
<add> }
<add> if(state!=EmitState.NO_EMITTED) {
<add> break;
<add> }
<ide> }
<ide>
<ide> long now = System.currentTimeMillis();
<ide> for(PartitionManager manager: _managers.values()) {
<ide> manager.commit();
<ide> }
<del> }
<del>
<add> }
<ide>
<ide> public static void main(String[] args) {
<ide> TopologyBuilder builder = new TopologyBuilder();
<ide> //hosts.add("smf1-aty-37-sr4.prod.twitter.com");
<ide> SpoutConfig spoutConf = new SpoutConfig(hosts, 8, "clicks", "/kafkastorm", "id");
<ide> spoutConf.scheme = new StringScheme();
<del> spoutConf.forceStartOffsetTime(1335774001000L);
<add> spoutConf.forceStartOffsetTime(-2);
<add>
<ide> // spoutConf.zkServers = new ArrayList<String>() {{
<ide> // add("localhost");
<ide> // }}; |
|
Java | mit | 24ff50f5e6e3e4d15cf233a0dfe3dfd14e52e4c4 | 0 | JGeovani/Fitness-Buddy-Group-Project,fitness-buddy/Fitness-Buddy-Group-Project | package com.strengthcoach.strengthcoach.activities;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.content.res.TypedArray;
import android.graphics.Color;
import android.graphics.drawable.Drawable;
import android.os.Build;
import android.os.Bundle;
import android.preference.PreferenceManager;
import android.support.v4.graphics.drawable.DrawableCompat;
import android.support.v7.app.AppCompatActivity;
import android.text.Html;
import android.util.Log;
import android.util.TypedValue;
import android.view.LayoutInflater;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.view.ViewGroup;
import android.view.animation.Animation;
import android.view.animation.AnimationUtils;
import android.widget.Button;
import android.widget.FrameLayout;
import android.widget.ImageView;
import android.widget.LinearLayout;
import android.widget.RatingBar;
import android.widget.RelativeLayout;
import android.widget.TextView;
import android.widget.Toast;
import com.daimajia.androidanimations.library.Techniques;
import com.daimajia.androidanimations.library.YoYo;
import com.github.ksoichiro.android.observablescrollview.ObservableScrollView;
import com.github.ksoichiro.android.observablescrollview.ObservableScrollViewCallbacks;
import com.github.ksoichiro.android.observablescrollview.ScrollState;
import com.github.ksoichiro.android.observablescrollview.ScrollUtils;
import com.google.android.gms.maps.CameraUpdateFactory;
import com.google.android.gms.maps.GoogleMap;
import com.google.android.gms.maps.OnMapReadyCallback;
import com.google.android.gms.maps.SupportMapFragment;
import com.google.android.gms.maps.model.BitmapDescriptor;
import com.google.android.gms.maps.model.BitmapDescriptorFactory;
import com.google.android.gms.maps.model.LatLng;
import com.google.android.gms.maps.model.Marker;
import com.google.android.gms.maps.model.MarkerOptions;
import com.nineoldandroids.view.ViewHelper;
import com.nineoldandroids.view.ViewPropertyAnimator;
import com.parse.FindCallback;
import com.parse.GetCallback;
import com.parse.ParseGeoPoint;
import com.parse.ParseQuery;
import com.parse.SaveCallback;
import com.squareup.picasso.Picasso;
import com.strengthcoach.strengthcoach.R;
import com.strengthcoach.strengthcoach.adapters.TrainerDetailPagerAdapter;
import com.strengthcoach.strengthcoach.models.ChatPerson;
import com.strengthcoach.strengthcoach.models.Gym;
import com.strengthcoach.strengthcoach.models.LocalTrainer;
import com.strengthcoach.strengthcoach.models.Review;
import com.strengthcoach.strengthcoach.models.SimpleUser;
import com.strengthcoach.strengthcoach.models.Trainer;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
public class TrainerDetailsAnimatedActivity extends AppCompatActivity implements ObservableScrollViewCallbacks {
private static final float MAX_TEXT_SCALE_DELTA = 0.3f;
private View mOverlayView;
private ObservableScrollView mScrollView;
private TextView mTitleView;
private View mFab;
private int mActionBarSize;
private int mFlexibleSpaceShowFabOffset;
private int mFlexibleSpaceImageHeight;
private int mFabMargin;
private boolean mFabIsShown;
private RelativeLayout mImageContainer;
int LOGIN_FOR_CHAT_ACTIVITY_ID = 997;
Trainer m_trainer;
ArrayList<Review> reviews;
GoogleMap m_map;
Button bBookSlot;
TrainerDetailPagerAdapter mDetailPagerAdapter;
String trainerId;
String imageUrl;
LocalTrainer localTrainer;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_trainer_details_animated);
if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
getWindow().setNavigationBarColor(getResources().getColor(R.color.navigationBarColor));
}
mFlexibleSpaceImageHeight = getResources().getDimensionPixelSize(R.dimen.flexible_space_image_height);
mFlexibleSpaceShowFabOffset = getResources().getDimensionPixelSize(R.dimen.flexible_space_show_fab_offset);
mActionBarSize = getActionBarSize();
mOverlayView = findViewById(R.id.overlay);
mScrollView = (ObservableScrollView) findViewById(R.id.scroll);
mScrollView.setScrollViewCallbacks(this);
mTitleView = (TextView) findViewById(R.id.title);
mImageContainer = (RelativeLayout) findViewById(R.id.rlImageContainer);
// Get the trainer object from parse and setup the view
imageUrl = getIntent().getStringExtra("imageUrl");
// Get the localTrainer object
localTrainer = (LocalTrainer) getIntent().getSerializableExtra("localTrainer");
// Load the image as early as possible for a smooth shared element tranistion animation
setupBasicInfo();
trainerId = localTrainer.getId();
ParseQuery<Trainer> query = ParseQuery.getQuery("Trainer");
query.whereEqualTo("objectId", trainerId);
query.include("favorited_by");
query.findInBackground(new FindCallback<Trainer>() {
@Override
public void done(List<Trainer> list, com.parse.ParseException e) {
Log.d("DEBUG", ((Trainer) list.get(0)).getName());
m_trainer = list.get(0);
mTitleView.setText(m_trainer.getName());
setTitle(null);
// Get the gym where the trainer goes to workout
getTrainerGym();
}
});
mFab = findViewById(R.id.fab);
mFab.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
String currentUserId = getLoggedInUserId();
if (currentUserId.equals("")) {
// Start login activity
Intent intent = new Intent(getBaseContext(), LoginActivity.class);
startActivityForResult(intent, LOGIN_FOR_CHAT_ACTIVITY_ID);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
}
else {
getCurrentUserAndStartChat(currentUserId);
}
}
});
mFabMargin = getResources().getDimensionPixelSize(R.dimen.margin_standard);
ViewHelper.setScaleX(mFab, 0);
ViewHelper.setScaleY(mFab, 0);
ScrollUtils.addOnGlobalLayoutListener(mScrollView, new Runnable() {
@Override
public void run() {
mScrollView.scrollTo(0, mFlexibleSpaceImageHeight - mActionBarSize);
// If you'd like to start from scrollY == 0, don't write like this:
//mScrollView.scrollTo(0, 0);
// The initial scrollY is 0, so it won't invoke onScrollChanged().
// To do this, use the following:
onScrollChanged(0, false, false);
// You can also achieve it with the following codes.
// This causes scroll change from 1 to 0.
mScrollView.scrollTo(0, 1);
mScrollView.scrollTo(0, 0);
}
});
}
protected int getActionBarSize() {
TypedValue typedValue = new TypedValue();
int[] textSizeAttr = new int[]{R.attr.actionBarSize};
int indexOfAttrTextSize = 0;
TypedArray a = obtainStyledAttributes(typedValue.data, textSizeAttr);
int actionBarSize = a.getDimensionPixelSize(indexOfAttrTextSize, -1);
a.recycle();
return actionBarSize;
}
private void getTrainerGym() {
ParseQuery<Gym> query = ParseQuery.getQuery("Gym");
query.whereEqualTo("trainers", m_trainer);
query.include("address");
query.findInBackground(new FindCallback<Gym>() {
public void done(List<Gym> gyms, com.parse.ParseException e) {
// Associate the gym with the trainer
m_trainer.setGym(gyms.get(0));
// Get all the reviews for the trainer
getReviewsAndSetupViews(m_trainer.getObjectId());
}
});
}
// Reviews are in a separate table so it needs to be fetched separately
private void getReviewsAndSetupViews(String trainerId) {
ParseQuery<Review> query = ParseQuery.getQuery("Review");
query.whereEqualTo("reviewee", m_trainer);
query.include("reviewer");
query.include("reviewee");
query.findInBackground(new FindCallback<Review>() {
@Override
public void done(List<Review> reviews, com.parse.ParseException e) {
TrainerDetailsAnimatedActivity.this.reviews = new ArrayList<Review>(reviews);
setupTrainerView();
}
});
}
public void onFavoriteClicked(View view) {
if (m_trainer.isFavorite()) {
// If the trainer is already favorited; reset the icon; undo favorite
((ImageView) view).setImageResource(0);
((ImageView) view).setImageResource(R.drawable.heart);
zoomAnimation((ImageView) view);
m_trainer.getFavoritedBy().remove(SimpleUser.currentUserObject);
m_trainer.saveInBackground(new SaveCallback() {
@Override
public void done(com.parse.ParseException e) {
if (e == null) {
Log.d("DEBUG", "Successfully removed favorite trainer");
} else {
e.printStackTrace();
}
}
});
} else {
// Change icon and save in parse
((ImageView) view).setImageResource(0);
((ImageView) view).setImageResource(R.drawable.heart_selected);
zoomAnimation((ImageView) view);
ArrayList<SimpleUser> favorites = m_trainer.getFavoritedBy();
if (favorites == null) {
// This is to handle the case where current user is the one to mark the trainer
// as favorite
ArrayList<SimpleUser> favoritedBy = new ArrayList<SimpleUser>();
favoritedBy.add(SimpleUser.currentUserObject);
m_trainer.setFavoritedBy(favoritedBy);
m_trainer.saveInBackground();
} else {
m_trainer.getFavoritedBy().add(SimpleUser.currentUserObject);
}
m_trainer.getFavoritedBy().add(SimpleUser.currentUserObject);
m_trainer.saveInBackground();
}
}
private void zoomAnimation(View view) {
Animation animation = AnimationUtils.loadAnimation(getApplicationContext(), R.anim.zoom);
view.startAnimation(animation);
}
private void setupBasicInfo() {
ImageView ivImage = (ImageView) findViewById(R.id.ivImage);
Picasso.with(this).load(imageUrl).into(ivImage);
// Show trainer name
mTitleView.setText(localTrainer.getName());
YoYo.with(Techniques.FlipInX)
.duration(1200)
.playOn(mTitleView);
// Show fav icon
ImageView ivFavorite = (ImageView) findViewById(R.id.ivFavorite);
if (localTrainer.isFavorite()) {
ivFavorite.setImageResource(R.drawable.heart_selected);
} else {
ivFavorite.setImageResource(R.drawable.heart);
}
YoYo.with(Techniques.Landing)
.duration(1200)
.playOn(ivFavorite);
TextView tvAboutTrainer = (TextView) findViewById(R.id.tvAboutTrainer);
tvAboutTrainer.setText(localTrainer.getAboutMe());
TextView tvPrice = (TextView) findViewById(R.id.tvPrice);
tvPrice.setText(localTrainer.getPriceFormatted());
YoYo.with(Techniques.RubberBand).duration(1200).playOn(tvPrice);
TextView tvTrainerEducation = (TextView) findViewById(R.id.tvTrainerEducation);
String educationAndCertifications = "";
ArrayList<String> educationAndCertificationsArrayList = localTrainer.getEducationAndCertifications();
for (int i = 0; i < educationAndCertificationsArrayList.size(); i++) {
educationAndCertifications += educationAndCertificationsArrayList.get(i);
if (i != educationAndCertificationsArrayList.size() - 1) {
educationAndCertifications += " • ";
}
}
tvTrainerEducation.setText(Html.fromHtml(educationAndCertifications));
TextView tvTrainerInterests = (TextView) findViewById(R.id.tvTrainerInterests);
String interestsAndAchievements = "";
ArrayList<String> interestsAndAchievementsArrayList = localTrainer.getInterestsAndAchievements();
for (int i = 0; i < interestsAndAchievementsArrayList.size(); i++) {
interestsAndAchievements += interestsAndAchievementsArrayList.get(i);
if (i != interestsAndAchievementsArrayList.size() - 1) {
interestsAndAchievements += " • ";
}
}
tvTrainerInterests.setText(Html.fromHtml(interestsAndAchievements));
RatingBar ratingBar = (RatingBar) findViewById(R.id.ratingBar);
ratingBar.setRating((float) localTrainer.getRatings());
Drawable progress = ratingBar.getProgressDrawable();
DrawableCompat.setTint(progress, Color.parseColor("#FFD700"));
ImageView ivProfileImage2 = (ImageView) findViewById(R.id.ivProfileImage2);
Picasso.with(this).load(localTrainer.getProfileImageUrl()).placeholder(R.drawable.ic_placeholder).into(ivProfileImage2);
}
private void setupTrainerView() {
SupportMapFragment mapFragment = ((SupportMapFragment) getSupportFragmentManager().findFragmentById(R.id.map));
if (mapFragment != null) {
mapFragment.getMapAsync(new OnMapReadyCallback() {
@Override
public void onMapReady(GoogleMap map) {
m_map = map;
ParseGeoPoint parseGeoPoint = m_trainer.getGym().point();
LatLng point = new LatLng(parseGeoPoint.getLatitude(), parseGeoPoint.getLongitude());
m_map.moveCamera(CameraUpdateFactory.newLatLngZoom(point, 15));
BitmapDescriptor defaultMarker =
BitmapDescriptorFactory.defaultMarker(BitmapDescriptorFactory.HUE_RED);
// Extract content from alert dialog
String title = m_trainer.getGym().getName();
String snippet = m_trainer.getGym().getAddress().toString();
// Creates and adds marker to the map
Marker marker = m_map.addMarker(new MarkerOptions()
.position(point)
.title(title)
.snippet(snippet)
.icon(defaultMarker));
marker.showInfoWindow();
}
});
} else {
Toast.makeText(this, "Error - Map Fragment was null!!", Toast.LENGTH_SHORT).show();
}
TextView tvReviewsCount = (TextView) findViewById(R.id.tvReviewsCount);
tvReviewsCount.setText(getReviewsCount());
LinearLayout llReviews = (LinearLayout) findViewById(R.id.llContent);
addReviewsInView(llReviews);
// added by neeraja for booking slots starts
bBookSlot= (Button) findViewById(R.id.bBookSlot);
bBookSlot.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Trainer.currentTrainerObjectId = trainerId;
Trainer.currentTrainerName = m_trainer.getName();
Trainer.currentPrice = m_trainer.getPrice();
Intent intent = new Intent(getBaseContext(), BlockSlotActivity.class);
startActivity(intent);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
}
});
// added by neeraja for booking slots ends
}
private void addReviewsInView(LinearLayout llReviews){
LayoutInflater vi = (LayoutInflater) getApplicationContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
for (int i = 0; i < reviews.size(); i++) {
Review review = reviews.get(i);
View v = vi.inflate(R.layout.review_item, null);
TextView tvReviewerName = (TextView) v.findViewById(R.id.tvReviewerName);
tvReviewerName.setText(((SimpleUser)review.getReviewer()).getName());
String PATTERN="MMM yyyy";
SimpleDateFormat dateFormat = new SimpleDateFormat();
dateFormat.applyPattern(PATTERN);
String date = dateFormat.format(review.getCreatedAt());
TextView tvReviewDate = (TextView) v.findViewById(R.id.tvReviewDate);
tvReviewDate.setText(date);
TextView tvReviewText = (TextView) v.findViewById(R.id.tvReviewText);
tvReviewText.setText(review.getReviewBody());
llReviews.addView(v, new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT));
}
}
private String getReviewsCount() {
if (reviews.size() == 1) {
return reviews.size() + " Review";
} else {
return reviews.size() + " Reviews";
}
}
@Override
public void onScrollChanged(int scrollY, boolean firstScroll, boolean dragging) {
// Translate overlay and image
float flexibleRange = mFlexibleSpaceImageHeight - mActionBarSize;
int minOverlayTransitionY = mActionBarSize - mOverlayView.getHeight();
ViewHelper.setTranslationY(mOverlayView, ScrollUtils.getFloat(-scrollY, minOverlayTransitionY, 0));
ViewHelper.setTranslationY(mImageContainer, ScrollUtils.getFloat(-scrollY / 2, minOverlayTransitionY, 0));
// ViewHelper.setTranslationY(mImageView, ScrollUtils.getFloat(-scrollY / 2, minOverlayTransitionY, 0));
// Change alpha of overlay
ViewHelper.setAlpha(mOverlayView, ScrollUtils.getFloat((float) scrollY / flexibleRange, 0, 1));
// Scale title text
float scale = 1 + ScrollUtils.getFloat((flexibleRange - scrollY) / flexibleRange, 0, MAX_TEXT_SCALE_DELTA);
ViewHelper.setPivotX(mTitleView, 0);
ViewHelper.setPivotY(mTitleView, 0);
ViewHelper.setScaleX(mTitleView, scale);
ViewHelper.setScaleY(mTitleView, scale);
// Translate title text
int maxTitleTranslationY = (int) (mFlexibleSpaceImageHeight - mTitleView.getHeight() * scale);
int titleTranslationY = maxTitleTranslationY - scrollY;
ViewHelper.setTranslationY(mTitleView, titleTranslationY);
// Translate FAB
int maxFabTranslationY = mFlexibleSpaceImageHeight - mFab.getHeight() / 2;
float fabTranslationY = ScrollUtils.getFloat(
-scrollY + mFlexibleSpaceImageHeight - mFab.getHeight() / 2,
mActionBarSize - mFab.getHeight() / 2,
maxFabTranslationY);
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.HONEYCOMB) {
// On pre-honeycomb, ViewHelper.setTranslationX/Y does not set margin,
// which causes FAB's OnClickListener not working.
FrameLayout.LayoutParams lp = (FrameLayout.LayoutParams) mFab.getLayoutParams();
lp.leftMargin = mOverlayView.getWidth() - mFabMargin - mFab.getWidth();
lp.topMargin = (int) fabTranslationY;
mFab.requestLayout();
} else {
ViewHelper.setTranslationX(mFab, mOverlayView.getWidth() - mFabMargin - mFab.getWidth());
ViewHelper.setTranslationY(mFab, fabTranslationY);
}
// Show/hide FAB
if (fabTranslationY < mFlexibleSpaceShowFabOffset) {
hideFab();
} else {
showFab();
}
}
@Override
public void onDownMotionEvent() {
}
@Override
public void onUpOrCancelMotionEvent(ScrollState scrollState) {
}
private void showFab() {
if (!mFabIsShown) {
ViewPropertyAnimator.animate(mFab).cancel();
ViewPropertyAnimator.animate(mFab).scaleX(1).scaleY(1).setDuration(200).start();
mFabIsShown = true;
}
}
private void hideFab() {
if (mFabIsShown) {
ViewPropertyAnimator.animate(mFab).cancel();
ViewPropertyAnimator.animate(mFab).scaleX(0).scaleY(0).setDuration(200).start();
mFabIsShown = false;
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.menu_trainer_details_animated, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
// Handle action bar item clicks here. The action bar will
// automatically handle clicks on the Home/Up button, so long
// as you specify a parent activity in AndroidManifest.xml.
int id = item.getItemId();
//noinspection SimplifiableIfStatement
if (id == R.id.action_settings) {
return true;
}
return super.onOptionsItemSelected(item);
}
private void getCurrentUserAndStartChat(String userObjectId) {
ParseQuery<SimpleUser> query = ParseQuery.getQuery("SimpleUser");
query.whereEqualTo("objectId", userObjectId);
query.getFirstInBackground(new GetCallback<SimpleUser>() {
public void done(SimpleUser user, com.parse.ParseException e) {
if (e == null) {
ChatPerson me = new ChatPerson();
me.name = user.getName();
me.objectId = user.getObjectId();
me.imageUrl = "";
SimpleUser.currentUserObject = user;
ChatPerson other = new ChatPerson();
other.name = m_trainer.getName();
other.objectId = m_trainer.getObjectId();
other.imageUrl = m_trainer.getProfileImageUrl();
Intent intent = new Intent(getBaseContext(), ChatActivity.class);
intent.putExtra("me", me);
intent.putExtra("other", other);
startActivity(intent);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
} else {
Log.d("DEBUG", "Error: " + e.getMessage());
}
}
});
}
private String getLoggedInUserId() {
SharedPreferences pref = PreferenceManager.getDefaultSharedPreferences(getApplicationContext());
String userId = pref.getString("userId", "");
SimpleUser.currentUserObjectId = userId;
return userId;
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode == LOGIN_FOR_CHAT_ACTIVITY_ID) {
if(resultCode == RESULT_OK){
String currentUserId = getLoggedInUserId();
getCurrentUserAndStartChat(currentUserId);
}
}
}
@Override
public void onBackPressed() {
Intent returnIntent = new Intent();
setResult(RESULT_CANCELED, returnIntent);
supportFinishAfterTransition();
}
}
| StrengthCoach/app/src/main/java/com/strengthcoach/strengthcoach/activities/TrainerDetailsAnimatedActivity.java | package com.strengthcoach.strengthcoach.activities;
import android.content.Context;
import android.content.Intent;
import android.content.SharedPreferences;
import android.content.res.TypedArray;
import android.graphics.Color;
import android.graphics.drawable.Drawable;
import android.os.Build;
import android.os.Bundle;
import android.preference.PreferenceManager;
import android.support.v4.graphics.drawable.DrawableCompat;
import android.support.v7.app.AppCompatActivity;
import android.text.Html;
import android.util.Log;
import android.util.TypedValue;
import android.view.LayoutInflater;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.view.ViewGroup;
import android.view.animation.Animation;
import android.view.animation.AnimationUtils;
import android.widget.Button;
import android.widget.FrameLayout;
import android.widget.ImageView;
import android.widget.LinearLayout;
import android.widget.RatingBar;
import android.widget.RelativeLayout;
import android.widget.TextView;
import android.widget.Toast;
import com.daimajia.androidanimations.library.Techniques;
import com.daimajia.androidanimations.library.YoYo;
import com.github.ksoichiro.android.observablescrollview.ObservableScrollView;
import com.github.ksoichiro.android.observablescrollview.ObservableScrollViewCallbacks;
import com.github.ksoichiro.android.observablescrollview.ScrollState;
import com.github.ksoichiro.android.observablescrollview.ScrollUtils;
import com.google.android.gms.maps.CameraUpdateFactory;
import com.google.android.gms.maps.GoogleMap;
import com.google.android.gms.maps.OnMapReadyCallback;
import com.google.android.gms.maps.SupportMapFragment;
import com.google.android.gms.maps.model.BitmapDescriptor;
import com.google.android.gms.maps.model.BitmapDescriptorFactory;
import com.google.android.gms.maps.model.LatLng;
import com.google.android.gms.maps.model.Marker;
import com.google.android.gms.maps.model.MarkerOptions;
import com.nineoldandroids.view.ViewHelper;
import com.nineoldandroids.view.ViewPropertyAnimator;
import com.parse.FindCallback;
import com.parse.GetCallback;
import com.parse.ParseGeoPoint;
import com.parse.ParseQuery;
import com.parse.SaveCallback;
import com.squareup.picasso.Picasso;
import com.strengthcoach.strengthcoach.R;
import com.strengthcoach.strengthcoach.adapters.TrainerDetailPagerAdapter;
import com.strengthcoach.strengthcoach.models.ChatPerson;
import com.strengthcoach.strengthcoach.models.Gym;
import com.strengthcoach.strengthcoach.models.LocalTrainer;
import com.strengthcoach.strengthcoach.models.Review;
import com.strengthcoach.strengthcoach.models.SimpleUser;
import com.strengthcoach.strengthcoach.models.Trainer;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
public class TrainerDetailsAnimatedActivity extends AppCompatActivity implements ObservableScrollViewCallbacks {
private static final float MAX_TEXT_SCALE_DELTA = 0.3f;
private View mOverlayView;
private ObservableScrollView mScrollView;
private TextView mTitleView;
private View mFab;
private int mActionBarSize;
private int mFlexibleSpaceShowFabOffset;
private int mFlexibleSpaceImageHeight;
private int mFabMargin;
private boolean mFabIsShown;
private RelativeLayout mImageContainer;
int LOGIN_FOR_CHAT_ACTIVITY_ID = 997;
Trainer m_trainer;
ArrayList<Review> reviews;
GoogleMap m_map;
Button bBookSlot;
TrainerDetailPagerAdapter mDetailPagerAdapter;
String trainerId;
String imageUrl;
LocalTrainer localTrainer;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_trainer_details_animated);
if (android.os.Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
getWindow().setNavigationBarColor(getResources().getColor(R.color.navigationBarColor));
}
mFlexibleSpaceImageHeight = getResources().getDimensionPixelSize(R.dimen.flexible_space_image_height);
mFlexibleSpaceShowFabOffset = getResources().getDimensionPixelSize(R.dimen.flexible_space_show_fab_offset);
mActionBarSize = getActionBarSize();
mOverlayView = findViewById(R.id.overlay);
mScrollView = (ObservableScrollView) findViewById(R.id.scroll);
mScrollView.setScrollViewCallbacks(this);
mTitleView = (TextView) findViewById(R.id.title);
mImageContainer = (RelativeLayout) findViewById(R.id.rlImageContainer);
// Get the trainer object from parse and setup the view
imageUrl = getIntent().getStringExtra("imageUrl");
// Get the localTrainer object
localTrainer = (LocalTrainer) getIntent().getSerializableExtra("localTrainer");
// Load the image as early as possible for a smooth shared element tranistion animation
setupBasicInfo();
trainerId = localTrainer.getId();
ParseQuery<Trainer> query = ParseQuery.getQuery("Trainer");
query.whereEqualTo("objectId", trainerId);
query.include("favorited_by");
query.findInBackground(new FindCallback<Trainer>() {
@Override
public void done(List<Trainer> list, com.parse.ParseException e) {
Log.d("DEBUG", ((Trainer) list.get(0)).getName());
m_trainer = list.get(0);
mTitleView.setText(m_trainer.getName());
setTitle(null);
// Get the gym where the trainer goes to workout
getTrainerGym();
}
});
mFab = findViewById(R.id.fab);
mFab.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
String currentUserId = getLoggedInUserId();
if (currentUserId.equals("")) {
// Start login activity
Intent intent = new Intent(getBaseContext(), LoginActivity.class);
startActivityForResult(intent, LOGIN_FOR_CHAT_ACTIVITY_ID);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
}
else {
getCurrentUserAndStartChat(currentUserId);
}
}
});
mFabMargin = getResources().getDimensionPixelSize(R.dimen.margin_standard);
ViewHelper.setScaleX(mFab, 0);
ViewHelper.setScaleY(mFab, 0);
ScrollUtils.addOnGlobalLayoutListener(mScrollView, new Runnable() {
@Override
public void run() {
mScrollView.scrollTo(0, mFlexibleSpaceImageHeight - mActionBarSize);
// If you'd like to start from scrollY == 0, don't write like this:
//mScrollView.scrollTo(0, 0);
// The initial scrollY is 0, so it won't invoke onScrollChanged().
// To do this, use the following:
onScrollChanged(0, false, false);
// You can also achieve it with the following codes.
// This causes scroll change from 1 to 0.
mScrollView.scrollTo(0, 1);
mScrollView.scrollTo(0, 0);
}
});
}
protected int getActionBarSize() {
TypedValue typedValue = new TypedValue();
int[] textSizeAttr = new int[]{R.attr.actionBarSize};
int indexOfAttrTextSize = 0;
TypedArray a = obtainStyledAttributes(typedValue.data, textSizeAttr);
int actionBarSize = a.getDimensionPixelSize(indexOfAttrTextSize, -1);
a.recycle();
return actionBarSize;
}
private void getTrainerGym() {
ParseQuery<Gym> query = ParseQuery.getQuery("Gym");
query.whereEqualTo("trainers", m_trainer);
query.include("address");
query.findInBackground(new FindCallback<Gym>() {
public void done(List<Gym> gyms, com.parse.ParseException e) {
// Associate the gym with the trainer
m_trainer.setGym(gyms.get(0));
// Get all the reviews for the trainer
getReviewsAndSetupViews(m_trainer.getObjectId());
}
});
}
// Reviews are in a separate table so it needs to be fetched separately
private void getReviewsAndSetupViews(String trainerId) {
ParseQuery<Review> query = ParseQuery.getQuery("Review");
query.whereEqualTo("reviewee", m_trainer);
query.include("reviewer");
query.include("reviewee");
query.findInBackground(new FindCallback<Review>() {
@Override
public void done(List<Review> reviews, com.parse.ParseException e) {
TrainerDetailsAnimatedActivity.this.reviews = new ArrayList<Review>(reviews);
setupTrainerView();
}
});
}
public void onFavoriteClicked(View view) {
if (m_trainer.isFavorite()) {
// If the trainer is already favorited; reset the icon; undo favorite
((ImageView) view).setImageResource(0);
((ImageView) view).setImageResource(R.drawable.heart);
zoomAnimation((ImageView) view);
m_trainer.getFavoritedBy().remove(SimpleUser.currentUserObject);
m_trainer.saveInBackground(new SaveCallback() {
@Override
public void done(com.parse.ParseException e) {
if (e == null) {
Log.d("DEBUG", "Successfully removed favorite trainer");
} else {
e.printStackTrace();
}
}
});
} else {
// Change icon and save in parse
((ImageView) view).setImageResource(0);
((ImageView) view).setImageResource(R.drawable.heart_selected);
zoomAnimation((ImageView) view);
ArrayList<SimpleUser> favorites = m_trainer.getFavoritedBy();
if (favorites == null) {
// This is to handle the case where current user is the one to mark the trainer
// as favorite
ArrayList<SimpleUser> favoritedBy = new ArrayList<SimpleUser>();
favoritedBy.add(SimpleUser.currentUserObject);
m_trainer.setFavoritedBy(favoritedBy);
m_trainer.saveInBackground();
} else {
m_trainer.getFavoritedBy().add(SimpleUser.currentUserObject);
}
m_trainer.getFavoritedBy().add(SimpleUser.currentUserObject);
m_trainer.saveInBackground();
}
}
private void zoomAnimation(View view) {
Animation animation = AnimationUtils.loadAnimation(getApplicationContext(), R.anim.zoom);
view.startAnimation(animation);
}
private void setupBasicInfo() {
ImageView ivImage = (ImageView) findViewById(R.id.ivImage);
Picasso.with(this).load(imageUrl).into(ivImage);
// Show trainer name
mTitleView.setText(localTrainer.getName());
YoYo.with(Techniques.FlipInX)
.duration(2000)
.playOn(mTitleView);
// Show fav icon
ImageView ivFavorite = (ImageView) findViewById(R.id.ivFavorite);
if (localTrainer.isFavorite()) {
ivFavorite.setImageResource(R.drawable.heart_selected);
} else {
ivFavorite.setImageResource(R.drawable.heart);
}
YoYo.with(Techniques.Landing)
.duration(2000)
.playOn(ivFavorite);
TextView tvAboutTrainer = (TextView) findViewById(R.id.tvAboutTrainer);
tvAboutTrainer.setText(localTrainer.getAboutMe());
TextView tvPrice = (TextView) findViewById(R.id.tvPrice);
tvPrice.setText(localTrainer.getPriceFormatted());
YoYo.with(Techniques.RubberBand).duration(2000).playOn(tvPrice);
TextView tvTrainerEducation = (TextView) findViewById(R.id.tvTrainerEducation);
String educationAndCertifications = "";
ArrayList<String> educationAndCertificationsArrayList = localTrainer.getEducationAndCertifications();
for (int i = 0; i < educationAndCertificationsArrayList.size(); i++) {
educationAndCertifications += educationAndCertificationsArrayList.get(i);
if (i != educationAndCertificationsArrayList.size() - 1) {
educationAndCertifications += " • ";
}
}
tvTrainerEducation.setText(Html.fromHtml(educationAndCertifications));
TextView tvTrainerInterests = (TextView) findViewById(R.id.tvTrainerInterests);
String interestsAndAchievements = "";
ArrayList<String> interestsAndAchievementsArrayList = localTrainer.getInterestsAndAchievements();
for (int i = 0; i < interestsAndAchievementsArrayList.size(); i++) {
interestsAndAchievements += interestsAndAchievementsArrayList.get(i);
if (i != interestsAndAchievementsArrayList.size() - 1) {
interestsAndAchievements += " • ";
}
}
tvTrainerInterests.setText(Html.fromHtml(interestsAndAchievements));
RatingBar ratingBar = (RatingBar) findViewById(R.id.ratingBar);
ratingBar.setRating((float) localTrainer.getRatings());
Drawable progress = ratingBar.getProgressDrawable();
DrawableCompat.setTint(progress, Color.parseColor("#FFD700"));
ImageView ivProfileImage2 = (ImageView) findViewById(R.id.ivProfileImage2);
Picasso.with(this).load(localTrainer.getProfileImageUrl()).placeholder(R.drawable.ic_placeholder).into(ivProfileImage2);
}
private void setupTrainerView() {
SupportMapFragment mapFragment = ((SupportMapFragment) getSupportFragmentManager().findFragmentById(R.id.map));
if (mapFragment != null) {
mapFragment.getMapAsync(new OnMapReadyCallback() {
@Override
public void onMapReady(GoogleMap map) {
m_map = map;
ParseGeoPoint parseGeoPoint = m_trainer.getGym().point();
LatLng point = new LatLng(parseGeoPoint.getLatitude(), parseGeoPoint.getLongitude());
m_map.moveCamera(CameraUpdateFactory.newLatLngZoom(point, 15));
BitmapDescriptor defaultMarker =
BitmapDescriptorFactory.defaultMarker(BitmapDescriptorFactory.HUE_RED);
// Extract content from alert dialog
String title = m_trainer.getGym().getName();
String snippet = m_trainer.getGym().getAddress().toString();
// Creates and adds marker to the map
Marker marker = m_map.addMarker(new MarkerOptions()
.position(point)
.title(title)
.snippet(snippet)
.icon(defaultMarker));
marker.showInfoWindow();
}
});
} else {
Toast.makeText(this, "Error - Map Fragment was null!!", Toast.LENGTH_SHORT).show();
}
TextView tvReviewsCount = (TextView) findViewById(R.id.tvReviewsCount);
tvReviewsCount.setText(getReviewsCount());
LinearLayout llReviews = (LinearLayout) findViewById(R.id.llContent);
addReviewsInView(llReviews);
// added by neeraja for booking slots starts
bBookSlot= (Button) findViewById(R.id.bBookSlot);
bBookSlot.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Trainer.currentTrainerObjectId = trainerId;
Trainer.currentTrainerName = m_trainer.getName();
Trainer.currentPrice = m_trainer.getPrice();
Intent intent = new Intent(getBaseContext(), BlockSlotActivity.class);
startActivity(intent);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
}
});
// added by neeraja for booking slots ends
}
private void addReviewsInView(LinearLayout llReviews){
LayoutInflater vi = (LayoutInflater) getApplicationContext().getSystemService(Context.LAYOUT_INFLATER_SERVICE);
for (int i = 0; i < reviews.size(); i++) {
Review review = reviews.get(i);
View v = vi.inflate(R.layout.review_item, null);
TextView tvReviewerName = (TextView) v.findViewById(R.id.tvReviewerName);
tvReviewerName.setText(((SimpleUser)review.getReviewer()).getName());
String PATTERN="MMM yyyy";
SimpleDateFormat dateFormat = new SimpleDateFormat();
dateFormat.applyPattern(PATTERN);
String date = dateFormat.format(review.getCreatedAt());
TextView tvReviewDate = (TextView) v.findViewById(R.id.tvReviewDate);
tvReviewDate.setText(date);
TextView tvReviewText = (TextView) v.findViewById(R.id.tvReviewText);
tvReviewText.setText(review.getReviewBody());
llReviews.addView(v, new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT));
}
}
private String getReviewsCount() {
if (reviews.size() == 1) {
return reviews.size() + " Review";
} else {
return reviews.size() + " Reviews";
}
}
@Override
public void onScrollChanged(int scrollY, boolean firstScroll, boolean dragging) {
// Translate overlay and image
float flexibleRange = mFlexibleSpaceImageHeight - mActionBarSize;
int minOverlayTransitionY = mActionBarSize - mOverlayView.getHeight();
ViewHelper.setTranslationY(mOverlayView, ScrollUtils.getFloat(-scrollY, minOverlayTransitionY, 0));
ViewHelper.setTranslationY(mImageContainer, ScrollUtils.getFloat(-scrollY / 2, minOverlayTransitionY, 0));
// ViewHelper.setTranslationY(mImageView, ScrollUtils.getFloat(-scrollY / 2, minOverlayTransitionY, 0));
// Change alpha of overlay
ViewHelper.setAlpha(mOverlayView, ScrollUtils.getFloat((float) scrollY / flexibleRange, 0, 1));
// Scale title text
float scale = 1 + ScrollUtils.getFloat((flexibleRange - scrollY) / flexibleRange, 0, MAX_TEXT_SCALE_DELTA);
ViewHelper.setPivotX(mTitleView, 0);
ViewHelper.setPivotY(mTitleView, 0);
ViewHelper.setScaleX(mTitleView, scale);
ViewHelper.setScaleY(mTitleView, scale);
// Translate title text
int maxTitleTranslationY = (int) (mFlexibleSpaceImageHeight - mTitleView.getHeight() * scale);
int titleTranslationY = maxTitleTranslationY - scrollY;
ViewHelper.setTranslationY(mTitleView, titleTranslationY);
// Translate FAB
int maxFabTranslationY = mFlexibleSpaceImageHeight - mFab.getHeight() / 2;
float fabTranslationY = ScrollUtils.getFloat(
-scrollY + mFlexibleSpaceImageHeight - mFab.getHeight() / 2,
mActionBarSize - mFab.getHeight() / 2,
maxFabTranslationY);
if (Build.VERSION.SDK_INT < Build.VERSION_CODES.HONEYCOMB) {
// On pre-honeycomb, ViewHelper.setTranslationX/Y does not set margin,
// which causes FAB's OnClickListener not working.
FrameLayout.LayoutParams lp = (FrameLayout.LayoutParams) mFab.getLayoutParams();
lp.leftMargin = mOverlayView.getWidth() - mFabMargin - mFab.getWidth();
lp.topMargin = (int) fabTranslationY;
mFab.requestLayout();
} else {
ViewHelper.setTranslationX(mFab, mOverlayView.getWidth() - mFabMargin - mFab.getWidth());
ViewHelper.setTranslationY(mFab, fabTranslationY);
}
// Show/hide FAB
if (fabTranslationY < mFlexibleSpaceShowFabOffset) {
hideFab();
} else {
showFab();
}
}
@Override
public void onDownMotionEvent() {
}
@Override
public void onUpOrCancelMotionEvent(ScrollState scrollState) {
}
private void showFab() {
if (!mFabIsShown) {
ViewPropertyAnimator.animate(mFab).cancel();
ViewPropertyAnimator.animate(mFab).scaleX(1).scaleY(1).setDuration(200).start();
mFabIsShown = true;
}
}
private void hideFab() {
if (mFabIsShown) {
ViewPropertyAnimator.animate(mFab).cancel();
ViewPropertyAnimator.animate(mFab).scaleX(0).scaleY(0).setDuration(200).start();
mFabIsShown = false;
}
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.menu_trainer_details_animated, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
// Handle action bar item clicks here. The action bar will
// automatically handle clicks on the Home/Up button, so long
// as you specify a parent activity in AndroidManifest.xml.
int id = item.getItemId();
//noinspection SimplifiableIfStatement
if (id == R.id.action_settings) {
return true;
}
return super.onOptionsItemSelected(item);
}
private void getCurrentUserAndStartChat(String userObjectId) {
ParseQuery<SimpleUser> query = ParseQuery.getQuery("SimpleUser");
query.whereEqualTo("objectId", userObjectId);
query.getFirstInBackground(new GetCallback<SimpleUser>() {
public void done(SimpleUser user, com.parse.ParseException e) {
if (e == null) {
ChatPerson me = new ChatPerson();
me.name = user.getName();
me.objectId = user.getObjectId();
me.imageUrl = "";
SimpleUser.currentUserObject = user;
ChatPerson other = new ChatPerson();
other.name = m_trainer.getName();
other.objectId = m_trainer.getObjectId();
other.imageUrl = m_trainer.getProfileImageUrl();
Intent intent = new Intent(getBaseContext(), ChatActivity.class);
intent.putExtra("me", me);
intent.putExtra("other", other);
startActivity(intent);
overridePendingTransition(R.anim.enter_from_bottom, R.anim.stay_in_place);
} else {
Log.d("DEBUG", "Error: " + e.getMessage());
}
}
});
}
private String getLoggedInUserId() {
SharedPreferences pref = PreferenceManager.getDefaultSharedPreferences(getApplicationContext());
String userId = pref.getString("userId", "");
SimpleUser.currentUserObjectId = userId;
return userId;
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode == LOGIN_FOR_CHAT_ACTIVITY_ID) {
if(resultCode == RESULT_OK){
String currentUserId = getLoggedInUserId();
getCurrentUserAndStartChat(currentUserId);
}
}
}
@Override
public void onBackPressed() {
Intent returnIntent = new Intent();
setResult(RESULT_CANCELED, returnIntent);
supportFinishAfterTransition();
}
}
| Adjust animation interval in details activity
| StrengthCoach/app/src/main/java/com/strengthcoach/strengthcoach/activities/TrainerDetailsAnimatedActivity.java | Adjust animation interval in details activity | <ide><path>trengthCoach/app/src/main/java/com/strengthcoach/strengthcoach/activities/TrainerDetailsAnimatedActivity.java
<ide> // Show trainer name
<ide> mTitleView.setText(localTrainer.getName());
<ide> YoYo.with(Techniques.FlipInX)
<del> .duration(2000)
<add> .duration(1200)
<ide> .playOn(mTitleView);
<ide>
<ide> // Show fav icon
<ide> ivFavorite.setImageResource(R.drawable.heart);
<ide> }
<ide> YoYo.with(Techniques.Landing)
<del> .duration(2000)
<add> .duration(1200)
<ide> .playOn(ivFavorite);
<ide>
<ide> TextView tvAboutTrainer = (TextView) findViewById(R.id.tvAboutTrainer);
<ide>
<ide> TextView tvPrice = (TextView) findViewById(R.id.tvPrice);
<ide> tvPrice.setText(localTrainer.getPriceFormatted());
<del> YoYo.with(Techniques.RubberBand).duration(2000).playOn(tvPrice);
<add> YoYo.with(Techniques.RubberBand).duration(1200).playOn(tvPrice);
<ide>
<ide> TextView tvTrainerEducation = (TextView) findViewById(R.id.tvTrainerEducation);
<ide> String educationAndCertifications = ""; |
|
Java | apache-2.0 | 667be0d2182048a6f8b4f5da5765c440c0b648f6 | 0 | MichaelVose2/uPortal,vertein/uPortal,EdiaEducationTechnology/uPortal,drewwills/uPortal,mgillian/uPortal,Mines-Albi/esup-uportal,jameswennmacher/uPortal,andrewstuart/uPortal,EdiaEducationTechnology/uPortal,GIP-RECIA/esco-portail,jameswennmacher/uPortal,vertein/uPortal,joansmith/uPortal,ChristianMurphy/uPortal,groybal/uPortal,EsupPortail/esup-uportal,apetro/uPortal,EsupPortail/esup-uportal,vertein/uPortal,kole9273/uPortal,groybal/uPortal,jhelmer-unicon/uPortal,MichaelVose2/uPortal,kole9273/uPortal,joansmith/uPortal,drewwills/uPortal,apetro/uPortal,vertein/uPortal,vbonamy/esup-uportal,ASU-Capstone/uPortal,groybal/uPortal,Jasig/uPortal,stalele/uPortal,jl1955/uPortal5,doodelicious/uPortal,groybal/uPortal,timlevett/uPortal,ASU-Capstone/uPortal,apetro/uPortal,jhelmer-unicon/uPortal,EdiaEducationTechnology/uPortal,mgillian/uPortal,andrewstuart/uPortal,GIP-RECIA/esup-uportal,ASU-Capstone/uPortal-Forked,phillips1021/uPortal,chasegawa/uPortal,apetro/uPortal,Jasig/uPortal-start,jameswennmacher/uPortal,Jasig/uPortal,drewwills/uPortal,Mines-Albi/esup-uportal,bjagg/uPortal,Mines-Albi/esup-uportal,cousquer/uPortal,GIP-RECIA/esup-uportal,phillips1021/uPortal,jonathanmtran/uPortal,jameswennmacher/uPortal,doodelicious/uPortal,pspaude/uPortal,ChristianMurphy/uPortal,mgillian/uPortal,chasegawa/uPortal,doodelicious/uPortal,kole9273/uPortal,groybal/uPortal,phillips1021/uPortal,andrewstuart/uPortal,cousquer/uPortal,Jasig/uPortal-start,ASU-Capstone/uPortal,bjagg/uPortal,EsupPortail/esup-uportal,timlevett/uPortal,apetro/uPortal,joansmith/uPortal,jonathanmtran/uPortal,jonathanmtran/uPortal,doodelicious/uPortal,MichaelVose2/uPortal,vbonamy/esup-uportal,kole9273/uPortal,Jasig/uPortal,stalele/uPortal,stalele/uPortal,Jasig/SSP-Platform,stalele/uPortal,jl1955/uPortal5,ASU-Capstone/uPortal,GIP-RECIA/esco-portail,andrewstuart/uPortal,phillips1021/uPortal,Jasig/SSP-Platform,ASU-Capstone/uPortal-Forked,stalele/uPortal,pspaude/uPortal,Mines-Albi/esup-uportal,MichaelVose2/uPortal,ChristianMurphy/uPortal,jl1955/uPortal5,jhelmer-unicon/uPortal,ASU-Capstone/uPortal-Forked,jhelmer-unicon/uPortal,jl1955/uPortal5,joansmith/uPortal,chasegawa/uPortal,chasegawa/uPortal,cousquer/uPortal,doodelicious/uPortal,Jasig/SSP-Platform,Jasig/SSP-Platform,bjagg/uPortal,pspaude/uPortal,kole9273/uPortal,chasegawa/uPortal,EsupPortail/esup-uportal,EdiaEducationTechnology/uPortal,GIP-RECIA/esup-uportal,MichaelVose2/uPortal,andrewstuart/uPortal,ASU-Capstone/uPortal-Forked,vbonamy/esup-uportal,joansmith/uPortal,vbonamy/esup-uportal,EsupPortail/esup-uportal,jl1955/uPortal5,Mines-Albi/esup-uportal,Jasig/SSP-Platform,phillips1021/uPortal,timlevett/uPortal,ASU-Capstone/uPortal,jhelmer-unicon/uPortal,drewwills/uPortal,vbonamy/esup-uportal,timlevett/uPortal,GIP-RECIA/esup-uportal,GIP-RECIA/esco-portail,jameswennmacher/uPortal,pspaude/uPortal,GIP-RECIA/esup-uportal,ASU-Capstone/uPortal-Forked | /* Copyright 2001, 2005 The JA-SIG Collaborative. All rights reserved.
* See license distributed with this file and
* available online at http://www.uportal.org/license.html
*/
package org.jasig.portal;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Timestamp;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.sql.DataSource;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jasig.portal.properties.PropertiesManager;
import org.jasig.portal.rdbm.DatabaseServerImpl;
import org.jasig.portal.rdbm.IDatabaseServer;
import org.jasig.portal.rdbm.IJoinQueryString;
import org.jasig.portal.rdbm.JoinQueryString;
import org.jasig.portal.rdbm.pool.IPooledDataSourceFactory;
import org.jasig.portal.rdbm.pool.PooledDataSourceFactoryFactory;
import org.springframework.dao.DataAccessException;
import org.springframework.dao.DataAccessResourceFailureException;
/**
* Provides relational database access and helper methods.
* A static routine determins if the database/driver supports
* prepared statements and/or outer joins.
*
* @author Ken Weiner, [email protected]
* @author George Lindholm, [email protected]
* @author Eric Dalquist <a href="mailto:[email protected]">[email protected]</a>
* @version $Revision $
*/
public class RDBMServices {
public static final String PORTAL_DB = PropertiesManager.getProperty("org.jasig.portal.RDBMServices.PortalDatasourceJndiName", "PortalDb"); // JNDI name for portal database
public static final String PERSON_DB = PropertiesManager.getProperty("org.jasig.portal.RDBMServices.PersonDatasourceJndiName", "PersonDb"); // JNDI name for person database
public static final String DEFAULT_DATABASE = "DEFAULT_DATABASE";
private static final boolean getDatasourceFromJndi = PropertiesManager.getPropertyAsBoolean("org.jasig.portal.RDBMServices.getDatasourceFromJndi", true);
private static final Log LOG = LogFactory.getLog(RDBMServices.class);
//DBFlag constants
private static final String FLAG_TRUE = "Y";
private static final String FLAG_TRUE_OTHER = "T";
private static final String FLAG_FALSE = "N";
/** Specifies how long to wait before trying to look a JNDI data source that previously failed */
private static final int JNDI_RETRY_TIME = PropertiesManager.getPropertyAsInt("org.jasig.portal.RDBMServices.jndiRetryDelay", 30000); // JNDI retry delay;
public static IJoinQueryString joinQuery = null;
public static boolean supportsOuterJoins = false;
public static boolean supportsTransactions = false;
public static int RETRY_COUNT = 5;
protected static boolean supportsPreparedStatements = false;
protected static final boolean usePreparedStatements = true;
private static boolean rdbmPropsLoaded = false;
private static Map namedDbServers = Collections.synchronizedMap(new HashMap());
private static Map namedDbServerFailures = Collections.synchronizedMap(new HashMap());
private static IDatabaseServer jdbcDbServer = null;
/**
* Perform one time initialization of the data source
*/
static {
loadRDBMServer();
//Cache lookups to the two JNDI data sources we "know" about
if (getDatasourceFromJndi) {
getDatabaseServer(PORTAL_DB);
getDatabaseServer(PERSON_DB);
}
//Legacy support for the public fields
final IDatabaseServer dbs = getDatabaseServer();
if(dbs != null) {
joinQuery = dbs.getJoinQuery();
supportsOuterJoins = dbs.supportsOuterJoins();
supportsTransactions = dbs.supportsTransactions();
supportsPreparedStatements = dbs.supportsPreparedStatements();
}
else {
final RuntimeException re = new IllegalStateException("No default database could be found after static initialization.");
LOG.fatal("Error initializing RDBMServices", re);
throw re;
}
}
/**
* Loads a JDBC data source from rdbm.properties. Attempts to uses
* a connection pooling data source wrapper for added performance.
*/
private synchronized static void loadRDBMServer() {
final String PROP_FILE = "/properties/rdbm.properties";
if (!rdbmPropsLoaded) {
final InputStream jdbcPropStream = RDBMServices.class.getResourceAsStream(PROP_FILE);
try {
try {
final Properties jdbpProperties = new Properties();
jdbpProperties.load(jdbcPropStream);
final IPooledDataSourceFactory pdsf = PooledDataSourceFactoryFactory.getPooledDataSourceFactory();
final String driverClass = jdbpProperties.getProperty("jdbcDriver");
final String username = jdbpProperties.getProperty("jdbcUser");
final String password = jdbpProperties.getProperty("jdbcPassword");
final String url = jdbpProperties.getProperty("jdbcUrl");
final boolean usePool = Boolean.valueOf(jdbpProperties.getProperty("jdbcUsePool")).booleanValue();
if (usePool) {
//Try using a pooled DataSource
try {
final DataSource ds = pdsf.createPooledDataSource(driverClass, username, password, url);
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for pooled JDBC");
jdbcDbServer = new DatabaseServerImpl(ds);
}
catch (Exception e) {
LOG.error("Error using pooled JDBC data source.", e);
}
}
if (jdbcDbServer == null) {
//Pooled DataSource isn't being used or failed during creation
try {
final Driver d = (Driver)Class.forName(driverClass).newInstance();
final DataSource ds = new GenericDataSource(d, url, username, password);
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for JDBC");
jdbcDbServer = new DatabaseServerImpl(ds);
}
catch (Exception e) {
LOG.error("JDBC Driver Creation Failed. (" + driverClass + ")", e);
}
}
}
finally {
jdbcPropStream.close();
}
}
catch (IOException ioe) {
LOG.error("An error occured while reading " + PROP_FILE, ioe);
}
if (!getDatasourceFromJndi && jdbcDbServer == null) {
throw new RuntimeException("No JDBC DataSource or JNDI DataSource avalable.");
}
rdbmPropsLoaded = true;
}
}
/**
* Gets the default {@link IDatabaseServer}. If getDatasourceFromJndi
* is true {@link #getDatabaseServer(String)} is called with
* {@link RDBMServices#PORTAL_DB} as the argument. If no server is found
* the jdbc based server loaded from rdbm.properties is used.
*
* @return The default {@link IDatabaseServer}.
*/
public static IDatabaseServer getDatabaseServer() {
IDatabaseServer dbs = null;
if (getDatasourceFromJndi) {
dbs = getDatabaseServer(PORTAL_DB);
}
if (dbs == null) {
dbs = jdbcDbServer;
}
return dbs;
}
/**
* Gets a named {@link IDatabaseServer} from JNDI. Successfull lookups
* are cached and not done again. Failed lookups are cached for the
* number of milliseconds specified by {@link #JNDI_RETRY_TIME} to reduce
* JNDI overhead and log spam.
*
* @param name The name of the {@link IDatabaseServer} to get.
* @return A named {@link IDatabaseServer} or <code>null</code> if one cannot be found.
*/
public static IDatabaseServer getDatabaseServer(final String name) {
if (DEFAULT_DATABASE.equals(name)) {
return getDatabaseServer();
}
IDatabaseServer dbs = (IDatabaseServer)namedDbServers.get(name);
if (dbs == null) {
final Long failTime = (Long)namedDbServerFailures.get(name);
if (failTime == null || (failTime.longValue() + JNDI_RETRY_TIME) <= System.currentTimeMillis()) {
if (failTime != null) {
namedDbServerFailures.remove(name);
}
try {
final Context initCtx = new InitialContext();
final Context envCtx = (Context)initCtx.lookup("java:comp/env");
final DataSource ds = (DataSource)envCtx.lookup("jdbc/" + name);
if (ds != null) {
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for " + name);
dbs = new DatabaseServerImpl(ds);
namedDbServers.put(name, dbs);
}
}
catch (Throwable t) {
//Cache the failure to decrease lookup attempts and reduce log spam.
namedDbServerFailures.put(name, new Long(System.currentTimeMillis()));
if (LOG.isWarnEnabled())
LOG.warn("Error getting DataSource named (" + name + ") from JNDI.", t);
}
}
else {
if (LOG.isDebugEnabled()) {
final long waitTime = (failTime.longValue() + JNDI_RETRY_TIME) - System.currentTimeMillis();
LOG.debug("Skipping lookup on failed JNDI lookup for name (" + name + ") for approximately " + waitTime + " more milliseconds.");
}
}
}
return dbs;
}
/**
* Gets a database connection to the portal database.
*
* This implementation will first try to get the connection by looking in the
* JNDI context for the name defined by the portal property
* org.jasig.portal.RDBMServices.PortalDatasourceJndiName
* if the org.jasig.portal.RDBMServices.getDatasourceFromJndi
* property is enabled.
*
* If not enabled, the Connection will be produced by
* {@link java.sql.Driver#connect(java.lang.String, java.util.Properties)}
*
* @return a database Connection object
* @throws DataAccessException if unable to return a connection
*/
public static Connection getConnection() {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getConnection();
throw new DataAccessResourceFailureException("RDBMServices fatally misconfigured such that getDatabaseServer() returned null.");
}
/**
* Returns a connection produced by a DataSource found in the
* JNDI context. The DataSource should be configured and
* loaded into JNDI by the J2EE container.
* @param dbName the database name which will be retrieved from
* the JNDI context relative to "jdbc/"
* @return a database Connection object or <code>null</code> if no Connection
*/
public static Connection getConnection(final String dbName) {
final IDatabaseServer dbs = getDatabaseServer(dbName);
if (dbs != null)
return dbs.getConnection();
throw new DataAccessResourceFailureException("RDBMServices fatally misconfigured such that getDatabaseServer() returned null.");
}
/**
* Releases database connection
* @param con a database Connection object
*/
public static void releaseConnection(final Connection con) {
try {
con.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing Connection: " + con, e);
}
}
//******************************************
// Utility Methods
//******************************************
/**
* Close a ResultSet
* @param rs a database ResultSet object
*/
public static void closeResultSet(final ResultSet rs) {
try {
rs.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing ResultSet: " + rs, e);
}
}
/**
* Close a Statement
* @param st a database Statement object
*/
public static void closeStatement(final Statement st) {
try {
st.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing Statement: " + st, e);
}
}
/**
* Close a PreparedStatement. Simply delegates the call to
* {@link #closeStatement(Statement)}
* @param pst a database PreparedStatement object
* @deprecated Use {@link #closeStatement(Statement)}.
*/
public static void closePreparedStatement(final java.sql.PreparedStatement pst) {
closeStatement(pst);
}
/**
* Commit pending transactions
* @param connection
*/
static final public void commit(final Connection connection) throws SQLException {
try {
connection.commit();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error committing Connection: " + connection, e);
}
}
/**
* Set auto commit state for the connection
* @param connection
* @param autocommit
*/
public static final void setAutoCommit(final Connection connection, boolean autocommit) throws SQLException {
try {
connection.setAutoCommit(autocommit);
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error committing Connection: " + connection + " to: " + autocommit, e);
}
}
/**
* rollback unwanted changes to the database
* @param connection
*/
public static final void rollback(final Connection connection) throws SQLException {
try {
connection.rollback();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error rolling back Connection: " + connection, e);
}
}
/**
* Returns the name of the JDBC driver being used for the default
* uPortal database connections.
*
* This implementation calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcDriver()} on the returned instance.
*
* @see IDatabaseServer#getJdbcDriver()
* @return the name of the JDBC Driver.
* @throws DataAccessException if unable to determine name of driver.
*/
public static String getJdbcDriver () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcDriver();
throw new DataAccessResourceFailureException("RDBMServices " +
"fatally misconfigured such that getDatabaseServer() returned null.");
}
/**
* Gets the JDBC URL of the default uPortal database connections.
*
* This implementation calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcUrl()} on the returned instance.
*
* @see IDatabaseServer#getJdbcUrl()
* @throws DataAccessException on internal failure
* @return the JDBC URL of the default uPortal database connections
*/
public static String getJdbcUrl () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcUrl();
throw new DataAccessResourceFailureException("RDBMServices " +
"fatally misconfigured such that getDatabaseServer() returned null.");
}
/**
* Get the username under which we are connecting for the default uPortal
* database connections.
*
* This implementation calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcUser()} on the returned instance.
*
* @see IDatabaseServer#getJdbcUser()
* @return the username under which we are connecting for default connections
* @throws DataAccessException on internal failure
*/
public static String getJdbcUser () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcUser();
throw new DataAccessResourceFailureException("RDBMServices " +
"fatally misconfigured such that getDatabaseServer() returned null.");
}
//******************************************
// Data Type / Formatting Methods
//******************************************
/**
* Return DB format of a boolean. "Y" for true and "N" for false.
* @param flag true or false
* @return either "Y" or "N"
*/
public static final String dbFlag(final boolean flag) {
if (flag)
return FLAG_TRUE;
else
return FLAG_FALSE;
}
/**
* Return boolean value of DB flag, "Y" or "N".
* @param flag either "Y" or "N"
* @return boolean true or false
*/
public static final boolean dbFlag(final String flag) {
return flag != null && (FLAG_TRUE.equalsIgnoreCase(flag) || FLAG_TRUE_OTHER.equalsIgnoreCase(flag));
}
/**
* Returns a String representing the current time
* in SQL suitable for use with the default database connections.
*
* This implementation calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp()} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp()
* @return SQL representing the current time
*/
public static final String sqlTimeStamp() {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp();
}
else {
return localSqlTimeStamp(System.currentTimeMillis());
}
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp(long)} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp(long)
*/
public static final String sqlTimeStamp(final long date) {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp(date);
}
else {
return localSqlTimeStamp(date);
}
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp(Date)} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp(Date)
*/
public static final String sqlTimeStamp(final Date date) {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp(date);
}
else {
if (date == null)
return "NULL";
else
return localSqlTimeStamp(date.getTime());
}
}
/**
* Utility method if there is no default {@link IDatabaseServer}
* instance.
*
* @param date The date in milliseconds to convert into a SQL TimeStamp.
* @return A SQL TimeStamp representing the date.
*/
private static final String localSqlTimeStamp(final long date) {
final StringBuffer sqlTS = new StringBuffer();
sqlTS.append("'");
sqlTS.append(new Timestamp(date).toString());
sqlTS.append("'");
return sqlTS.toString();
}
/**
* Make a string SQL safe
* @param sql
* @return SQL safe string
*/
public static final String sqlEscape(final String sql) {
if (sql == null) {
return "";
}
else {
int primePos = sql.indexOf("'");
if (primePos == -1) {
return sql;
}
else {
final StringBuffer sb = new StringBuffer(sql.length() + 4);
int startPos = 0;
do {
sb.append(sql.substring(startPos, primePos + 1));
sb.append("'");
startPos = primePos + 1;
primePos = sql.indexOf("'", startPos);
} while (primePos != -1);
sb.append(sql.substring(startPos));
return sb.toString();
}
}
}
/**
* @author Eric Dalquist <a href="mailto:[email protected]">[email protected]</a>
* @version $Revision $
*/
public static class GenericDataSource implements DataSource {
final private Driver driverRef;
final private String userName;
final private String password;
final private String jdbcUrl;
final private Properties jdbcProperties = new Properties();
private PrintWriter log = null;
/**
* Create a new {@link GenericDataSource} with the wraps the specified
* {@link Driver}.
*
* @param d The {@link Driver} to wrap.
*/
public GenericDataSource(final Driver d, final String url, final String user, final String pass) {
String argErr = "";
if (d == null) {
argErr += "Driver cannot be null. ";
}
if (url == null) {
argErr += "url cannot be null. ";
}
if (user == null) {
argErr += "user cannot be null. ";
}
if (pass == null) {
argErr += "pass cannot be null. ";
}
if (!argErr.equals("")) {
throw new IllegalArgumentException(argErr);
}
this.driverRef = d;
this.jdbcUrl = url;
this.userName = user;
this.password = pass;
this.jdbcProperties.put("user", this.userName);
this.jdbcProperties.put("password", this.password);
}
/**
* @see javax.sql.DataSource#getLoginTimeout()
*/
public int getLoginTimeout() throws SQLException {
return 0;
}
/**
* @see javax.sql.DataSource#setLoginTimeout(int)
*/
public void setLoginTimeout(final int timeout) throws SQLException {
//NOOP our timeout is always 0
}
/**
* @see javax.sql.DataSource#getLogWriter()
*/
public PrintWriter getLogWriter() throws SQLException {
return this.log;
}
/**
* @see javax.sql.DataSource#setLogWriter(java.io.PrintWriter)
*/
public void setLogWriter(final PrintWriter out) throws SQLException {
this.log = out;
}
/**
* @see javax.sql.DataSource#getConnection()
*/
public Connection getConnection() throws SQLException {
return this.getConnection(this.userName, this.password);
}
/**
* @see javax.sql.DataSource#getConnection(java.lang.String, java.lang.String)
*/
public Connection getConnection(final String user, final String pass) throws SQLException {
final Properties tempProperties = new Properties();
tempProperties.putAll(this.jdbcProperties);
tempProperties.put("user", user);
tempProperties.put("password", pass);
return this.driverRef.connect(this.jdbcUrl, tempProperties);
}
}
/**
* Wrapper for/Emulator of PreparedStatement class
* @deprecated Instead of this class a wrapper around the DataSource, Connection and Prepared statement should be done in {@link DatabaseServerImpl}
*/
public static final class PreparedStatement {
private Connection con;
private String query;
private String activeQuery;
private java.sql.PreparedStatement pstmt;
private Statement stmt;
private int lastIndex;
public PreparedStatement(Connection con, String query) throws SQLException {
this.con = con;
this.query = query;
activeQuery = this.query;
if (supportsPreparedStatements) {
pstmt = con.prepareStatement(query);
}
else {
stmt = con.createStatement();
}
}
public void clearParameters() throws SQLException {
if (supportsPreparedStatements) {
pstmt.clearParameters();
}
else {
lastIndex = 0;
activeQuery = query;
}
}
public void setDate(int index, java.sql.Date value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setDate(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + sqlTimeStamp(value)
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setInt(int index, int value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setInt(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + value
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setNull(int index, int sqlType) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setNull(index, sqlType);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + "NULL"
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setString(int index, String value) throws SQLException {
if (value == null || value.length() == 0) {
setNull(index, java.sql.Types.VARCHAR);
}
else {
if (supportsPreparedStatements) {
pstmt.setString(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + "'" + sqlEscape(value) + "'"
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
}
public void setTimestamp(int index, java.sql.Timestamp value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setTimestamp(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + sqlTimeStamp(value)
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public ResultSet executeQuery() throws SQLException {
if (supportsPreparedStatements) {
return pstmt.executeQuery();
}
else {
return stmt.executeQuery(activeQuery);
}
}
public int executeUpdate() throws SQLException {
if (supportsPreparedStatements) {
return pstmt.executeUpdate();
}
else {
return stmt.executeUpdate(activeQuery);
}
}
public String toString() {
if (supportsPreparedStatements) {
return query;
}
else {
return activeQuery;
}
}
public void close() throws SQLException {
if (supportsPreparedStatements) {
pstmt.close();
}
else {
stmt.close();
}
}
}
public static final class JdbcDb extends JoinQueryString {
public JdbcDb(final String testString) {
super(testString);
}
}
public static final class OracleDb extends JoinQueryString {
public OracleDb(final String testString) {
super(testString);
}
}
public static final class PostgreSQLDb extends JoinQueryString {
public PostgreSQLDb(final String testString) {
super(testString);
}
}
} | source/org/jasig/portal/RDBMServices.java | /* Copyright 2001 The JA-SIG Collaborative. All rights reserved.
* See license distributed with this file and
* available online at http://www.uportal.org/license.html
*/
package org.jasig.portal;
import java.io.IOException;
import java.io.InputStream;
import java.io.PrintWriter;
import java.sql.Connection;
import java.sql.Driver;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Timestamp;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.sql.DataSource;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jasig.portal.properties.PropertiesManager;
import org.jasig.portal.rdbm.DatabaseServerImpl;
import org.jasig.portal.rdbm.IDatabaseServer;
import org.jasig.portal.rdbm.IJoinQueryString;
import org.jasig.portal.rdbm.JoinQueryString;
import org.jasig.portal.rdbm.pool.IPooledDataSourceFactory;
import org.jasig.portal.rdbm.pool.PooledDataSourceFactoryFactory;
/**
* Provides relational database access and helper methods.
* A static routine determins if the database/driver supports
* prepared statements and/or outer joins.
*
* @author Ken Weiner, [email protected]
* @author George Lindholm, [email protected]
* @author Eric Dalquist <a href="mailto:[email protected]">[email protected]</a>
* @version $Revision $
*/
public class RDBMServices {
public static final String PORTAL_DB = PropertiesManager.getProperty("org.jasig.portal.RDBMServices.PortalDatasourceJndiName", "PortalDb"); // JNDI name for portal database
public static final String PERSON_DB = PropertiesManager.getProperty("org.jasig.portal.RDBMServices.PersonDatasourceJndiName", "PersonDb"); // JNDI name for person database
public static final String DEFAULT_DATABASE = "DEFAULT_DATABASE";
private static final boolean getDatasourceFromJndi = PropertiesManager.getPropertyAsBoolean("org.jasig.portal.RDBMServices.getDatasourceFromJndi", true);
private static final Log LOG = LogFactory.getLog(RDBMServices.class);
//DBFlag constants
private static final String FLAG_TRUE = "Y";
private static final String FLAG_TRUE_OTHER = "T";
private static final String FLAG_FALSE = "N";
/** Specifies how long to wait before trying to look a JNDI data source that previously failed */
private static final int JNDI_RETRY_TIME = PropertiesManager.getPropertyAsInt("org.jasig.portal.RDBMServices.jndiRetryDelay", 30000); // JNDI retry delay;
public static IJoinQueryString joinQuery = null;
public static boolean supportsOuterJoins = false;
public static boolean supportsTransactions = false;
public static int RETRY_COUNT = 5;
protected static boolean supportsPreparedStatements = false;
protected static final boolean usePreparedStatements = true;
private static boolean rdbmPropsLoaded = false;
private static Map namedDbServers = Collections.synchronizedMap(new HashMap());
private static Map namedDbServerFailures = Collections.synchronizedMap(new HashMap());
private static IDatabaseServer jdbcDbServer = null;
/**
* Perform one time initialization of the data source
*/
static {
loadRDBMServer();
//Cache lookups to the two JNDI data sources we "know" about
if (getDatasourceFromJndi) {
getDatabaseServer(PORTAL_DB);
getDatabaseServer(PERSON_DB);
}
//Legacy support for the public fields
final IDatabaseServer dbs = getDatabaseServer();
if(dbs != null) {
joinQuery = dbs.getJoinQuery();
supportsOuterJoins = dbs.supportsOuterJoins();
supportsTransactions = dbs.supportsTransactions();
supportsPreparedStatements = dbs.supportsPreparedStatements();
}
else {
final RuntimeException re = new IllegalStateException("No default database could be found after static initialization.");
LOG.fatal("Error initializing RDBMServices", re);
throw re;
}
}
/**
* Loads a JDBC data source from rdbm.properties. Attempts to uses
* a connection pooling data source wrapper for added performance.
*/
private synchronized static void loadRDBMServer() {
final String PROP_FILE = "/properties/rdbm.properties";
if (!rdbmPropsLoaded) {
final InputStream jdbcPropStream = RDBMServices.class.getResourceAsStream(PROP_FILE);
try {
try {
final Properties jdbpProperties = new Properties();
jdbpProperties.load(jdbcPropStream);
final IPooledDataSourceFactory pdsf = PooledDataSourceFactoryFactory.getPooledDataSourceFactory();
final String driverClass = jdbpProperties.getProperty("jdbcDriver");
final String username = jdbpProperties.getProperty("jdbcUser");
final String password = jdbpProperties.getProperty("jdbcPassword");
final String url = jdbpProperties.getProperty("jdbcUrl");
final boolean usePool = Boolean.valueOf(jdbpProperties.getProperty("jdbcUsePool")).booleanValue();
if (usePool) {
//Try using a pooled DataSource
try {
final DataSource ds = pdsf.createPooledDataSource(driverClass, username, password, url);
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for pooled JDBC");
jdbcDbServer = new DatabaseServerImpl(ds);
}
catch (Exception e) {
LOG.error("Error using pooled JDBC data source.", e);
}
}
if (jdbcDbServer == null) {
//Pooled DataSource isn't being used or failed during creation
try {
final Driver d = (Driver)Class.forName(driverClass).newInstance();
final DataSource ds = new GenericDataSource(d, url, username, password);
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for JDBC");
jdbcDbServer = new DatabaseServerImpl(ds);
}
catch (Exception e) {
LOG.error("JDBC Driver Creation Failed. (" + driverClass + ")", e);
}
}
}
finally {
jdbcPropStream.close();
}
}
catch (IOException ioe) {
LOG.error("An error occured while reading " + PROP_FILE, ioe);
}
if (!getDatasourceFromJndi && jdbcDbServer == null) {
throw new RuntimeException("No JDBC DataSource or JNDI DataSource avalable.");
}
rdbmPropsLoaded = true;
}
}
/**
* Gets the default {@link IDatabaseServer}. If getDatasourceFromJndi
* is true {@link #getDatabaseServer(String)} is called with
* {@link RDBMServices#PORTAL_DB} as the argument. If no server is found
* the jdbc based server loaded from rdbm.properties is used.
*
* @return The default {@link IDatabaseServer}.
*/
public static IDatabaseServer getDatabaseServer() {
IDatabaseServer dbs = null;
if (getDatasourceFromJndi) {
dbs = getDatabaseServer(PORTAL_DB);
}
if (dbs == null) {
dbs = jdbcDbServer;
}
return dbs;
}
/**
* Gets a named {@link IDatabaseServer} from JNDI. Successfull lookups
* are cached and not done again. Failed lookups are cached for the
* number of milliseconds specified by {@link #JNDI_RETRY_TIME} to reduce
* JNDI overhead and log spam.
*
* @param name The name of the {@link IDatabaseServer} to get.
* @return A named {@link IDatabaseServer} or <code>null</code> if one cannot be found.
*/
public static IDatabaseServer getDatabaseServer(final String name) {
if (DEFAULT_DATABASE.equals(name)) {
return getDatabaseServer();
}
IDatabaseServer dbs = (IDatabaseServer)namedDbServers.get(name);
if (dbs == null) {
final Long failTime = (Long)namedDbServerFailures.get(name);
if (failTime == null || (failTime.longValue() + JNDI_RETRY_TIME) <= System.currentTimeMillis()) {
if (failTime != null) {
namedDbServerFailures.remove(name);
}
try {
final Context initCtx = new InitialContext();
final Context envCtx = (Context)initCtx.lookup("java:comp/env");
final DataSource ds = (DataSource)envCtx.lookup("jdbc/" + name);
if (ds != null) {
if (LOG.isInfoEnabled())
LOG.info("Creating IDatabaseServer instance for " + name);
dbs = new DatabaseServerImpl(ds);
namedDbServers.put(name, dbs);
}
}
catch (Throwable t) {
//Cache the failure to decrease lookup attempts and reduce log spam.
namedDbServerFailures.put(name, new Long(System.currentTimeMillis()));
if (LOG.isWarnEnabled())
LOG.warn("Error getting DataSource named (" + name + ") from JNDI.", t);
}
}
else {
if (LOG.isDebugEnabled()) {
final long waitTime = (failTime.longValue() + JNDI_RETRY_TIME) - System.currentTimeMillis();
LOG.debug("Skipping lookup on failed JNDI lookup for name (" + name + ") for approximately " + waitTime + " more milliseconds.");
}
}
}
return dbs;
}
/**
* Gets a database connection to the portal database.
* This method will first try to get the connection by looking in the
* JNDI context for the name defined by the portal property
* org.jasig.portal.RDBMServices.PortalDatasourceJndiName
* if the org.jasig.portal.RDBMServices.getDatasourceFromJndi
* property is enabled.
*
* If not enabled, the Connection will be produced by
* {@link java.sql.Driver#connect(java.lang.String, java.util.Properties)}
*
* @return a database Connection object
*/
public static Connection getConnection() {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getConnection();
else
return null;
}
/**
* Returns a connection produced by a DataSource found in the
* JNDI context. The DataSource should be configured and
* loaded into JNDI by the J2EE container.
* @param dbName the database name which will be retrieved from
* the JNDI context relative to "jdbc/"
* @return a database Connection object or <code>null</code> if no Connection
*/
public static Connection getConnection(final String dbName) {
final IDatabaseServer dbs = getDatabaseServer(dbName);
if (dbs != null)
return dbs.getConnection();
else
return null;
}
/**
* Releases database connection
* @param con a database Connection object
*/
public static void releaseConnection(final Connection con) {
try {
con.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing Connection: " + con, e);
}
}
//******************************************
// Utility Methods
//******************************************
/**
* Close a ResultSet
* @param rs a database ResultSet object
*/
public static void closeResultSet(final ResultSet rs) {
try {
rs.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing ResultSet: " + rs, e);
}
}
/**
* Close a Statement
* @param st a database Statement object
*/
public static void closeStatement(final Statement st) {
try {
st.close();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error closing Statement: " + st, e);
}
}
/**
* Close a PreparedStatement. Simply delegates the call to
* {@link #closeStatement(Statement)}
* @param st a database PreparedStatement object
* @deprecated Use {@link #closeStatement(Statement)}.
*/
public static void closePreparedStatement(final java.sql.PreparedStatement pst) {
closeStatement(pst);
}
/**
* Commit pending transactions
* @param connection
*/
static final public void commit(final Connection connection) throws SQLException {
try {
connection.commit();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error committing Connection: " + connection, e);
}
}
/**
* Set auto commit state for the connection
* @param connection
* @param autocommit
*/
public static final void setAutoCommit(final Connection connection, boolean autocommit) throws SQLException {
try {
connection.setAutoCommit(autocommit);
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error committing Connection: " + connection + " to: " + autocommit, e);
}
}
/**
* rollback unwanted changes to the database
* @param connection
*/
public static final void rollback(final Connection connection) throws SQLException {
try {
connection.rollback();
}
catch (Exception e) {
if (LOG.isWarnEnabled())
LOG.warn("Error rolling back Connection: " + connection, e);
}
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcDriver()} on the returned instance.
*
* @see IDatabaseServer#getJdbcDriver()
*/
public static String getJdbcDriver () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcDriver();
else
return null;
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcUrl()} on the returned instance.
*
* @see IDatabaseServer#getJdbcUrl()
*/
public static String getJdbcUrl () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcUrl();
else
return null;
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#getJdbcUser()} on the returned instance.
*
* @see IDatabaseServer#getJdbcUser()
*/
public static String getJdbcUser () {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null)
return dbs.getJdbcUser();
else
return null;
}
//******************************************
// Data Type / Formatting Methods
//******************************************
/**
* Return DB format of a boolean. "Y" for true and "N" for false.
* @param flag true or false
* @return either "Y" or "N"
*/
public static final String dbFlag(final boolean flag) {
if (flag)
return FLAG_TRUE;
else
return FLAG_FALSE;
}
/**
* Return boolean value of DB flag, "Y" or "N".
* @param flag either "Y" or "N"
* @return boolean true or false
*/
public static final boolean dbFlag(final String flag) {
return flag != null && (FLAG_TRUE.equalsIgnoreCase(flag) || FLAG_TRUE_OTHER.equalsIgnoreCase(flag));
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp()} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp()
*/
public static final String sqlTimeStamp() {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp();
}
else {
return localSqlTimeStamp(System.currentTimeMillis());
}
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp(long)} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp(long)
*/
public static final String sqlTimeStamp(final long date) {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp(date);
}
else {
return localSqlTimeStamp(date);
}
}
/**
* Calls {@link #getDatabaseServer()} then calls
* {@link IDatabaseServer#sqlTimeStamp(Date)} on the returned instance.
*
* @see IDatabaseServer#sqlTimeStamp(Date)
*/
public static final String sqlTimeStamp(final Date date) {
final IDatabaseServer dbs = getDatabaseServer();
if (dbs != null) {
return dbs.sqlTimeStamp(date);
}
else {
if (date == null)
return "NULL";
else
return localSqlTimeStamp(date.getTime());
}
}
/**
* Utility method if there is no default {@link IDatabaseServer}
* instance.
*
* @param date The date in milliseconds to convert into a SQL TimeStamp.
* @return A SQL TimeStamp representing the date.
*/
private static final String localSqlTimeStamp(final long date) {
final StringBuffer sqlTS = new StringBuffer();
sqlTS.append("'");
sqlTS.append(new Timestamp(date).toString());
sqlTS.append("'");
return sqlTS.toString();
}
/**
* Make a string SQL safe
* @param sql
* @return SQL safe string
*/
public static final String sqlEscape(final String sql) {
if (sql == null) {
return "";
}
else {
int primePos = sql.indexOf("'");
if (primePos == -1) {
return sql;
}
else {
final StringBuffer sb = new StringBuffer(sql.length() + 4);
int startPos = 0;
do {
sb.append(sql.substring(startPos, primePos + 1));
sb.append("'");
startPos = primePos + 1;
primePos = sql.indexOf("'", startPos);
} while (primePos != -1);
sb.append(sql.substring(startPos));
return sb.toString();
}
}
}
/**
* @author Eric Dalquist <a href="mailto:[email protected]">[email protected]</a>
* @version $Revision $
*/
public static class GenericDataSource implements DataSource {
final private Driver driverRef;
final private String userName;
final private String password;
final private String jdbcUrl;
final private Properties jdbcProperties = new Properties();
private PrintWriter log = null;
/**
* Create a new {@link GenericDataSource} with the wraps the specified
* {@link Driver}.
*
* @param d The {@link Driver} to wrap.
*/
public GenericDataSource(final Driver d, final String url, final String user, final String pass) {
String argErr = "";
if (d == null) {
argErr += "Driver cannot be null. ";
}
if (url == null) {
argErr += "url cannot be null. ";
}
if (user == null) {
argErr += "user cannot be null. ";
}
if (pass == null) {
argErr += "pass cannot be null. ";
}
if (!argErr.equals("")) {
throw new IllegalArgumentException(argErr);
}
this.driverRef = d;
this.jdbcUrl = url;
this.userName = user;
this.password = pass;
this.jdbcProperties.put("user", this.userName);
this.jdbcProperties.put("password", this.password);
}
/**
* @see javax.sql.DataSource#getLoginTimeout()
*/
public int getLoginTimeout() throws SQLException {
return 0;
}
/**
* @see javax.sql.DataSource#setLoginTimeout(int)
*/
public void setLoginTimeout(final int timeout) throws SQLException {
//NOOP our timeout is always 0
}
/**
* @see javax.sql.DataSource#getLogWriter()
*/
public PrintWriter getLogWriter() throws SQLException {
return this.log;
}
/**
* @see javax.sql.DataSource#setLogWriter(java.io.PrintWriter)
*/
public void setLogWriter(final PrintWriter out) throws SQLException {
this.log = out;
}
/**
* @see javax.sql.DataSource#getConnection()
*/
public Connection getConnection() throws SQLException {
return this.getConnection(this.userName, this.password);
}
/**
* @see javax.sql.DataSource#getConnection(java.lang.String, java.lang.String)
*/
public Connection getConnection(final String user, final String pass) throws SQLException {
final Properties tempProperties = new Properties();
tempProperties.putAll(this.jdbcProperties);
tempProperties.put("user", user);
tempProperties.put("password", pass);
return this.driverRef.connect(this.jdbcUrl, tempProperties);
}
}
/**
* Wrapper for/Emulator of PreparedStatement class
* @deprecated Instead of this class a wrapper around the DataSource, Connection and Prepared statement should be done in {@link DatabaseServerImpl}
*/
public static final class PreparedStatement {
private Connection con;
private String query;
private String activeQuery;
private java.sql.PreparedStatement pstmt;
private Statement stmt;
private int lastIndex;
public PreparedStatement(Connection con, String query) throws SQLException {
this.con = con;
this.query = query;
activeQuery = this.query;
if (supportsPreparedStatements) {
pstmt = con.prepareStatement(query);
}
else {
stmt = con.createStatement();
}
}
public void clearParameters() throws SQLException {
if (supportsPreparedStatements) {
pstmt.clearParameters();
}
else {
lastIndex = 0;
activeQuery = query;
}
}
public void setDate(int index, java.sql.Date value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setDate(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + sqlTimeStamp(value)
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setInt(int index, int value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setInt(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + value
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setNull(int index, int sqlType) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setNull(index, sqlType);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + "NULL"
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public void setString(int index, String value) throws SQLException {
if (value == null || value.length() == 0) {
setNull(index, java.sql.Types.VARCHAR);
}
else {
if (supportsPreparedStatements) {
pstmt.setString(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + "'" + sqlEscape(value) + "'"
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
}
public void setTimestamp(int index, java.sql.Timestamp value) throws SQLException {
if (supportsPreparedStatements) {
pstmt.setTimestamp(index, value);
}
else {
if (index != lastIndex + 1) {
throw new SQLException("Out of order index");
}
else {
int pos = activeQuery.indexOf("?");
if (pos == -1) {
throw new SQLException("Missing '?'");
}
activeQuery = activeQuery.substring(0, pos) + sqlTimeStamp(value)
+ activeQuery.substring(pos + 1);
lastIndex = index;
}
}
}
public ResultSet executeQuery() throws SQLException {
if (supportsPreparedStatements) {
return pstmt.executeQuery();
}
else {
return stmt.executeQuery(activeQuery);
}
}
public int executeUpdate() throws SQLException {
if (supportsPreparedStatements) {
return pstmt.executeUpdate();
}
else {
return stmt.executeUpdate(activeQuery);
}
}
public String toString() {
if (supportsPreparedStatements) {
return query;
}
else {
return activeQuery;
}
}
public void close() throws SQLException {
if (supportsPreparedStatements) {
pstmt.close();
}
else {
stmt.close();
}
}
}
public static final class JdbcDb extends JoinQueryString {
public JdbcDb(final String testString) {
super(testString);
}
}
public static final class OracleDb extends JoinQueryString {
public OracleDb(final String testString) {
super(testString);
}
}
public static final class PostgreSQLDb extends JoinQueryString {
public PostgreSQLDb(final String testString) {
super(testString);
}
}
} | UP-852 Change API to throw RuntimeException rather than return null.
git-svn-id: 477788cc2a8229a747c5b8073e47c1d0f6ec0604@9931 f5dbab47-78f9-eb45-b975-e544023573eb
| source/org/jasig/portal/RDBMServices.java | UP-852 Change API to throw RuntimeException rather than return null. | <ide><path>ource/org/jasig/portal/RDBMServices.java
<del>/* Copyright 2001 The JA-SIG Collaborative. All rights reserved.
<add>/* Copyright 2001, 2005 The JA-SIG Collaborative. All rights reserved.
<ide> * See license distributed with this file and
<ide> * available online at http://www.uportal.org/license.html
<ide> */
<ide> import org.jasig.portal.rdbm.JoinQueryString;
<ide> import org.jasig.portal.rdbm.pool.IPooledDataSourceFactory;
<ide> import org.jasig.portal.rdbm.pool.PooledDataSourceFactoryFactory;
<add>import org.springframework.dao.DataAccessException;
<add>import org.springframework.dao.DataAccessResourceFailureException;
<ide>
<ide>
<ide>
<ide>
<ide> /**
<ide> * Gets a database connection to the portal database.
<del> * This method will first try to get the connection by looking in the
<add> *
<add> * This implementation will first try to get the connection by looking in the
<ide> * JNDI context for the name defined by the portal property
<ide> * org.jasig.portal.RDBMServices.PortalDatasourceJndiName
<ide> * if the org.jasig.portal.RDBMServices.getDatasourceFromJndi
<ide> * {@link java.sql.Driver#connect(java.lang.String, java.util.Properties)}
<ide> *
<ide> * @return a database Connection object
<add> * @throws DataAccessException if unable to return a connection
<ide> */
<ide> public static Connection getConnection() {
<ide> final IDatabaseServer dbs = getDatabaseServer();
<ide>
<ide> if (dbs != null)
<ide> return dbs.getConnection();
<del> else
<del> return null;
<add>
<add> throw new DataAccessResourceFailureException("RDBMServices fatally misconfigured such that getDatabaseServer() returned null.");
<ide> }
<ide>
<ide>
<ide>
<ide> if (dbs != null)
<ide> return dbs.getConnection();
<del> else
<del> return null;
<add>
<add> throw new DataAccessResourceFailureException("RDBMServices fatally misconfigured such that getDatabaseServer() returned null.");
<ide> }
<ide>
<ide> /**
<ide> /**
<ide> * Close a PreparedStatement. Simply delegates the call to
<ide> * {@link #closeStatement(Statement)}
<del> * @param st a database PreparedStatement object
<add> * @param pst a database PreparedStatement object
<ide> * @deprecated Use {@link #closeStatement(Statement)}.
<ide> */
<ide> public static void closePreparedStatement(final java.sql.PreparedStatement pst) {
<ide>
<ide>
<ide> /**
<del> * Calls {@link #getDatabaseServer()} then calls
<add> * Returns the name of the JDBC driver being used for the default
<add> * uPortal database connections.
<add> *
<add> * This implementation calls {@link #getDatabaseServer()} then calls
<ide> * {@link IDatabaseServer#getJdbcDriver()} on the returned instance.
<ide> *
<ide> * @see IDatabaseServer#getJdbcDriver()
<add> * @return the name of the JDBC Driver.
<add> * @throws DataAccessException if unable to determine name of driver.
<ide> */
<ide> public static String getJdbcDriver () {
<ide> final IDatabaseServer dbs = getDatabaseServer();
<ide>
<ide> if (dbs != null)
<ide> return dbs.getJdbcDriver();
<del> else
<del> return null;
<del> }
<del>
<del> /**
<del> * Calls {@link #getDatabaseServer()} then calls
<add>
<add> throw new DataAccessResourceFailureException("RDBMServices " +
<add> "fatally misconfigured such that getDatabaseServer() returned null.");
<add> }
<add>
<add> /**
<add> * Gets the JDBC URL of the default uPortal database connections.
<add> *
<add> * This implementation calls {@link #getDatabaseServer()} then calls
<ide> * {@link IDatabaseServer#getJdbcUrl()} on the returned instance.
<ide> *
<ide> * @see IDatabaseServer#getJdbcUrl()
<add> * @throws DataAccessException on internal failure
<add> * @return the JDBC URL of the default uPortal database connections
<ide> */
<ide> public static String getJdbcUrl () {
<ide> final IDatabaseServer dbs = getDatabaseServer();
<ide>
<ide> if (dbs != null)
<ide> return dbs.getJdbcUrl();
<del> else
<del> return null;
<del> }
<del>
<del> /**
<del> * Calls {@link #getDatabaseServer()} then calls
<add>
<add> throw new DataAccessResourceFailureException("RDBMServices " +
<add> "fatally misconfigured such that getDatabaseServer() returned null.");
<add> }
<add>
<add> /**
<add> * Get the username under which we are connecting for the default uPortal
<add> * database connections.
<add> *
<add> * This implementation calls {@link #getDatabaseServer()} then calls
<ide> * {@link IDatabaseServer#getJdbcUser()} on the returned instance.
<ide> *
<ide> * @see IDatabaseServer#getJdbcUser()
<add> * @return the username under which we are connecting for default connections
<add> * @throws DataAccessException on internal failure
<ide> */
<ide> public static String getJdbcUser () {
<ide> final IDatabaseServer dbs = getDatabaseServer();
<ide>
<ide> if (dbs != null)
<ide> return dbs.getJdbcUser();
<del> else
<del> return null;
<add>
<add> throw new DataAccessResourceFailureException("RDBMServices " +
<add> "fatally misconfigured such that getDatabaseServer() returned null.");
<ide> }
<ide>
<ide>
<ide> }
<ide>
<ide> /**
<del> * Calls {@link #getDatabaseServer()} then calls
<add> * Returns a String representing the current time
<add> * in SQL suitable for use with the default database connections.
<add> *
<add> * This implementation calls {@link #getDatabaseServer()} then calls
<ide> * {@link IDatabaseServer#sqlTimeStamp()} on the returned instance.
<ide> *
<ide> * @see IDatabaseServer#sqlTimeStamp()
<add> * @return SQL representing the current time
<ide> */
<ide> public static final String sqlTimeStamp() {
<ide> final IDatabaseServer dbs = getDatabaseServer(); |
|
Java | mit | b18ea23a8c298f16be3da90888554c960aed60ca | 0 | teiler/api.teiler.io | package io.teiler.server.services;
import io.teiler.server.Tylr;
import io.teiler.server.dto.Compensation;
import io.teiler.server.dto.Expense;
import io.teiler.server.dto.Group;
import io.teiler.server.dto.Person;
import io.teiler.server.dto.Profiteer;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Tylr.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
@TestPropertySource(properties = {"local.server.port=4567"})
@ActiveProfiles("test")
public class SuggestedCompensationServiceTest {
private static final String TEST_GROUP_NAME = "Testgroup";
private static final String TEST_NAME_PREFIX = "Person ";
@Autowired
private SuggestedCompensationService suggestedCompensationService;
@Autowired
private ExpenseService expenseService;
@Autowired
private CompensationService compensationService;
@Autowired
private PersonService personService;
@Autowired
private GroupService groupService;
/*
Means that the balance of the person with the highest Debt is smaller than the balance of the person
with the highest credit. This should test the if part of the algorithm.
*/
@Test
public void testReturnCorrectSuggestionsWithSameDebtAsCredit() {
final int personCount = 5;
final int share = 10;
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Person> people = new LinkedList<>();
for (int i = 0; i < personCount; i++) {
people.add(personService.createPerson(group.getId(), TEST_NAME_PREFIX + i));
}
Person payer = people.get(0);
Person profiteer = people.get(people.size() - 1);
Compensation compensation = new Compensation(null, share, payer, profiteer);
compensationService.createCompensation(compensation, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Compensation suggestedCompensation = suggestedCompensations.get(0);
Assert.assertEquals(payer.getId(), suggestedCompensation.getProfiteer().getId());
Assert.assertEquals(profiteer.getId(), suggestedCompensation.getPayer().getId());
Assert.assertEquals(share, suggestedCompensation.getAmount().intValue());
}
/*
Means that the balance of the person with the highest debt is higher than the the balance of the person
with the highest credit. This should the the else part of the algorithm.
*/
@Test
public void testReturnCorrectSuggestionsWithMoreDebtThanCredit() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Person> people = new LinkedList<>();
for (int i = 0; i < 3; i++) {
people.add(personService.createPerson(group.getId(), TEST_NAME_PREFIX + i));
}
Compensation firstCompensation = new Compensation(null, 10, people.get(0), people.get(2));
compensationService.createCompensation(firstCompensation, group.getId());
Compensation secondCompensation = new Compensation(null, 8, people.get(1), people.get(2));
compensationService.createCompensation(secondCompensation, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(2, suggestedCompensations.size());
for (Compensation suggestedCompensation : suggestedCompensations) {
if (suggestedCompensation.getProfiteer().getId() == people.get(0).getId()) {
Assert.assertEquals(10, suggestedCompensation.getAmount().intValue());
Assert.assertEquals(people.get(2).getId(), suggestedCompensation.getPayer().getId());
} else {
Assert.assertEquals(8, suggestedCompensation.getAmount().intValue());
Assert.assertEquals(people.get(1).getId(), suggestedCompensation.getProfiteer().getId());
Assert.assertEquals(people.get(2).getId(), suggestedCompensation.getPayer().getId());
}
}
}
@Test
public void testGroupWithoutPeople() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testGroupWithoutTransactions() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
for (int i = 0; i < 5; i++) {
personService.createPerson(group.getId(), TEST_NAME_PREFIX + i);
}
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testCompensationsCancelEachOtherOut() {
Group testGroup = groupService.createGroup(TEST_GROUP_NAME);
String groupId = testGroup.getId();
Person firstPerson = personService.createPerson(groupId, "Richi");
Person secondPerson = personService.createPerson(groupId, "Heiri");
Compensation firstCompensation = new Compensation(null, 500, firstPerson, secondPerson);
Compensation secondCompensation = new Compensation(null, 500, secondPerson, firstPerson);
compensationService.createCompensation(firstCompensation, groupId);
compensationService.createCompensation(secondCompensation, groupId);
List<Compensation> suggestedCompensations = suggestedCompensationService.getSuggestedCompensations(groupId);
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testSameBalancesWork() {
// This test checks that the @tk-codes bug is fixed ;)
Group group = groupService.createGroup("May 13");
Person hello = personService.createPerson(group.getId(), "Hello");
Person bye = personService.createPerson(group.getId(), "Bye");
Person vanakkam = personService.createPerson(group.getId(), "Vanakkam");
Person ciao = personService.createPerson(group.getId(), "Ciao");
Profiteer helloProfiteer = new Profiteer(null, hello, 250);
Profiteer byeProfiteer = new Profiteer(null, bye, 250);
Profiteer vanakkamProfiteer = new Profiteer(null, vanakkam, 250);
Profiteer ciaoProfiteer = new Profiteer(null, ciao, 250);
List<Profiteer> profiteers = new LinkedList<>(
Arrays.asList(helloProfiteer, byeProfiteer, vanakkamProfiteer, ciaoProfiteer));
Expense expense = new Expense(null, 1000, hello, "May 13", profiteers);
expenseService.createExpense(expense, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(3, suggestedCompensations.size());
for (Compensation suggestedCompensation : suggestedCompensations) {
Assert.assertEquals(250, suggestedCompensation.getAmount().longValue());
Assert.assertEquals(hello.getId(), suggestedCompensation.getProfiteer().getId());
}
}
@Test
public void testCyrill() {
Group group = groupService.createGroup("Test Cyrill");
Person cyrill = personService.createPerson(group.getId(), "Cyrill");
Person dominik = personService.createPerson(group.getId(), "Dominik");
Person remo = personService.createPerson(group.getId(), "Remo");
Profiteer dominikProfiteer = new Profiteer(null, dominik, 5000);
Profiteer cyrillProfiteer = new Profiteer(null, cyrill, 7000);
Profiteer remoProfiteer = new Profiteer(null, remo, 3000);
List<Profiteer> profiteers = new LinkedList<>(
Arrays.asList(dominikProfiteer, cyrillProfiteer, remoProfiteer));
Expense expense = new Expense(null, 15000, dominik, "Restaurant", profiteers);
expenseService.createExpense(expense, group.getId());
Compensation compensation = new Compensation(null, 5000, cyrill, dominik);
compensationService.createCompensation(compensation, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(2, suggestedCompensations.size());
Assert.assertEquals(3000, suggestedCompensations.get(0).getAmount().longValue());
Assert.assertEquals(remo, suggestedCompensations.get(0).getPayer());
Assert.assertEquals(dominik, suggestedCompensations.get(0).getProfiteer());
Assert.assertEquals(2000, suggestedCompensations.get(1).getAmount().longValue());
Assert.assertEquals(cyrill, suggestedCompensations.get(1).getPayer());
Assert.assertEquals(dominik, suggestedCompensations.get(1).getProfiteer());
}
}
| src/test/java/io/teiler/server/services/SuggestedCompensationServiceTest.java | package io.teiler.server.services;
import io.teiler.server.Tylr;
import io.teiler.server.dto.Compensation;
import io.teiler.server.dto.Expense;
import io.teiler.server.dto.Group;
import io.teiler.server.dto.Person;
import io.teiler.server.dto.Profiteer;
import java.util.Arrays;
import java.util.LinkedList;
import java.util.List;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringRunner;
@RunWith(SpringRunner.class)
@SpringBootTest(classes = Tylr.class, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
@TestPropertySource(properties = {"local.server.port=4567"})
@ActiveProfiles("test")
public class SuggestedCompensationServiceTest {
private static final String TEST_GROUP_NAME = "Testgroup";
private static final String TEST_NAME_PREFIX = "Person ";
@Autowired
private SuggestedCompensationService suggestedCompensationService;
@Autowired
private ExpenseService expenseService;
@Autowired
private CompensationService compensationService;
@Autowired
private PersonService personService;
@Autowired
private GroupService groupService;
/*
Means that the balance of the person with the highest Debt is smaller than the balance of the person
with the highest credit. This should test the if part of the algorithm.
*/
@Test
public void testReturnCorrectSuggestionsWithSameDebtAsCredit() {
final int personCount = 5;
final int share = 10;
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Person> people = new LinkedList<>();
for (int i = 0; i < personCount; i++) {
people.add(personService.createPerson(group.getId(), TEST_NAME_PREFIX + i));
}
Person payer = people.get(0);
Person profiteer = people.get(people.size() - 1);
Compensation compensation = new Compensation(null, share, payer, profiteer);
compensationService.createCompensation(compensation, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Compensation suggestedCompensation = suggestedCompensations.get(0);
Assert.assertEquals(payer.getId(), suggestedCompensation.getProfiteer().getId());
Assert.assertEquals(profiteer.getId(), suggestedCompensation.getPayer().getId());
Assert.assertEquals(share, suggestedCompensation.getAmount().intValue());
}
/*
Means that the balance of the person with the highest debt is higher than the the balance of the person
with the highest credit. This should the the else part of the algorithm.
*/
@Test
public void testReturnCorrectSuggestionsWithMoreDebtThanCredit() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Person> people = new LinkedList<>();
for (int i = 0; i < 3; i++) {
people.add(personService.createPerson(group.getId(), TEST_NAME_PREFIX + i));
}
Compensation firstCompensation = new Compensation(null, 10, people.get(0), people.get(2));
compensationService.createCompensation(firstCompensation, group.getId());
Compensation secondCompensation = new Compensation(null, 8, people.get(1), people.get(2));
compensationService.createCompensation(secondCompensation, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(2, suggestedCompensations.size());
for (Compensation suggestedCompensation : suggestedCompensations) {
if (suggestedCompensation.getProfiteer().getId() == people.get(0).getId()) {
Assert.assertEquals(10, suggestedCompensation.getAmount().intValue());
Assert.assertEquals(people.get(2).getId(), suggestedCompensation.getPayer().getId());
} else {
Assert.assertEquals(8, suggestedCompensation.getAmount().intValue());
Assert.assertEquals(people.get(1).getId(), suggestedCompensation.getProfiteer().getId());
Assert.assertEquals(people.get(2).getId(), suggestedCompensation.getPayer().getId());
}
}
}
@Test
public void testGroupWithoutPeople() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testGroupWithoutTransactions() {
Group group = groupService.createGroup(TEST_GROUP_NAME);
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
for (int i = 0; i < 5; i++) {
personService.createPerson(group.getId(), TEST_NAME_PREFIX + i);
}
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testCompensationsCancelEachOtherOut() {
Group testGroup = groupService.createGroup(TEST_GROUP_NAME);
String groupId = testGroup.getId();
Person firstPerson = personService.createPerson(groupId, "Richi");
Person secondPerson = personService.createPerson(groupId, "Heiri");
Compensation firstCompensation = new Compensation(null, 500, firstPerson, secondPerson);
Compensation secondCompensation = new Compensation(null, 500, secondPerson, firstPerson);
compensationService.createCompensation(firstCompensation, groupId);
compensationService.createCompensation(secondCompensation, groupId);
List<Compensation> suggestedCompensations = suggestedCompensationService.getSuggestedCompensations(groupId);
Assert.assertEquals(0, suggestedCompensations.size());
}
@Test
public void testSameBalancesWork() {
// This test checks that the @tk-codes bug is fixed ;)
Group group = groupService.createGroup("May 13");
Person hello = personService.createPerson(group.getId(), "Hello");
Person bye = personService.createPerson(group.getId(), "Bye");
Person vanakkam = personService.createPerson(group.getId(), "Vanakkam");
Person ciao = personService.createPerson(group.getId(), "Ciao");
Profiteer helloProfiteer = new Profiteer(null, hello, 250);
Profiteer byeProfiteer = new Profiteer(null, bye, 250);
Profiteer vanakkamProfiteer = new Profiteer(null, vanakkam, 250);
Profiteer ciaoProfiteer = new Profiteer(null, ciao, 250);
List<Profiteer> profiteers = new LinkedList<>(
Arrays.asList(helloProfiteer, byeProfiteer, vanakkamProfiteer, ciaoProfiteer));
Expense expense = new Expense(null, 1000, hello, "May 13", profiteers);
expenseService.createExpense(expense, group.getId());
List<Compensation> suggestedCompensations = suggestedCompensationService
.getSuggestedCompensations(group.getId());
Assert.assertEquals(3, suggestedCompensations.size());
for (Compensation suggestedCompensation : suggestedCompensations) {
Assert.assertEquals(250, suggestedCompensation.getAmount().longValue());
Assert.assertEquals(hello.getId(), suggestedCompensation.getProfiteer().getId());
}
}
}
| Add test for problem we encountered
| src/test/java/io/teiler/server/services/SuggestedCompensationServiceTest.java | Add test for problem we encountered | <ide><path>rc/test/java/io/teiler/server/services/SuggestedCompensationServiceTest.java
<ide> Assert.assertEquals(hello.getId(), suggestedCompensation.getProfiteer().getId());
<ide> }
<ide> }
<add>
<add> @Test
<add> public void testCyrill() {
<add> Group group = groupService.createGroup("Test Cyrill");
<add> Person cyrill = personService.createPerson(group.getId(), "Cyrill");
<add> Person dominik = personService.createPerson(group.getId(), "Dominik");
<add> Person remo = personService.createPerson(group.getId(), "Remo");
<add>
<add> Profiteer dominikProfiteer = new Profiteer(null, dominik, 5000);
<add> Profiteer cyrillProfiteer = new Profiteer(null, cyrill, 7000);
<add> Profiteer remoProfiteer = new Profiteer(null, remo, 3000);
<add> List<Profiteer> profiteers = new LinkedList<>(
<add> Arrays.asList(dominikProfiteer, cyrillProfiteer, remoProfiteer));
<add> Expense expense = new Expense(null, 15000, dominik, "Restaurant", profiteers);
<add> expenseService.createExpense(expense, group.getId());
<add> Compensation compensation = new Compensation(null, 5000, cyrill, dominik);
<add> compensationService.createCompensation(compensation, group.getId());
<add> List<Compensation> suggestedCompensations = suggestedCompensationService
<add> .getSuggestedCompensations(group.getId());
<add> Assert.assertEquals(2, suggestedCompensations.size());
<add> Assert.assertEquals(3000, suggestedCompensations.get(0).getAmount().longValue());
<add> Assert.assertEquals(remo, suggestedCompensations.get(0).getPayer());
<add> Assert.assertEquals(dominik, suggestedCompensations.get(0).getProfiteer());
<add> Assert.assertEquals(2000, suggestedCompensations.get(1).getAmount().longValue());
<add> Assert.assertEquals(cyrill, suggestedCompensations.get(1).getPayer());
<add> Assert.assertEquals(dominik, suggestedCompensations.get(1).getProfiteer());
<add> }
<ide> } |
|
Java | apache-2.0 | b57e6f00f5ffca6212a6843dad71708032608cac | 0 | rackerlabs/rackspace-docs-maven-plugin,stackforge/clouddocs-maven-plugin,rackerlabs/rackspace-docs-maven-plugin,rackerlabs/clouddocs-maven-plugin,rackerlabs/clouddocs-maven-plugin,rackerlabs/rackspace-docs-maven-plugin,stackforge/clouddocs-maven-plugin,inocybe/sdndocs-maven-plugin,OCselected/clouddocs-maven-plugin,rackerlabs/clouddocs-maven-plugin,OCselected/clouddocs-maven-plugin,rackerlabs/rackspace-docs-maven-plugin,OCselected/clouddocs-maven-plugin,inocybe/sdndocs-maven-plugin,stackforge/clouddocs-maven-plugin,stackforge/clouddocs-maven-plugin,OCselected/clouddocs-maven-plugin,inocybe/sdndocs-maven-plugin | package com.rackspace.cloud.api.docs;
import com.agilejava.docbkx.maven.AbstractFoMojo;
import com.agilejava.docbkx.maven.PreprocessingFilter;
import com.agilejava.docbkx.maven.TransformerBuilder;
import com.rackspace.cloud.api.docs.CalabashHelper;
import com.rackspace.cloud.api.docs.FileUtils;
import com.rackspace.cloud.api.docs.GlossaryResolver;
import org.antlr.stringtemplate.StringTemplate;
import org.antlr.stringtemplate.StringTemplateGroup;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.commons.io.IOUtils;
import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.MimeConstants;
import org.apache.maven.plugin.MojoExecutionException;
import org.xml.sax.SAXException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.URIResolver;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
public abstract class PDFMojo extends AbstractFoMojo {
private File imageDirectory;
private File sourceDirectory;
private File sourceDocBook;
private File coverImageTemplate;
private File coverImage;
private static final String COVER_IMAGE_TEMPLATE_NAME = "cover.st";
private static final String COVER_IMAGE_NAME = "cover.svg";
private static final String COVER_XSL = "cloud/cover.xsl";
/**
* @parameter expression="${project.build.directory}"
*/
private String projectBuildDirectory;
/**
* The greeting to display.
*
* @parameter expression="${generate-pdf.branding}" default-value="rackspace"
*/
private String branding;
/**
* Display built for OpenStack logo?
*
* @parameter expression="${generate-pdf.builtForOpenStack}" default-value="0"
*/
private String builtForOpenStack;
/**
* Path to an alternative cover logo.
*
* @parameter expression="${generate-pdf.coverLogoPath}" default-value=""
*/
private String coverLogoPath;
/**
* Path to an alternative cover logo.
*
* @parameter expression="${generate-pdf.secondaryCoverLogoPath}" default-value=""
*/
private String secondaryCoverLogoPath;
/**
* Distance from the left edge of the page at which the
* cover logo is displayed.
*
* @parameter expression="${generate-pdf.coverLogoLeft}" default-value=""
*/
private String coverLogoLeft;
/**
* Distance from the top of the page at which teh
* cover logo is displayed.
*
* @parameter expression="${generate-pdf.coverLogoTop}" default-value=""
*/
private String coverLogoTop;
/**
* url to display under the cover logo.
*
* @parameter expression="${generate-pdf.coverUrl}" default-value=""
*/
private String coverUrl;
/**
* The color to use for the polygon on the cover
*
* @parameter expression="${generate-pdf.coverColor}" default-value=""
*/
private String coverColor;
/**
* The greeting to display.
*
* @parameter expression="${generate-pdf.variablelistAsBlocks}"
*/
private String variablelistAsBlocks;
/**
* A parameter used to configure how many elements to trim from the URI in the documentation for a wadl method.
*
* @parameter expression="${generate-pdf.trim.wadl.uri.count}" default-value=""
*/
private String trimWadlUriCount;
/**
* Controls how the path to the wadl is calculated. If 0 or not set, then
* The xslts look for the normalized wadl in /generated-resources/xml/xslt/.
* Otherwise, in /generated-resources/xml/xslt/path/to/docbook-src, e.g.
* /generated-resources/xml/xslt/src/docbkx/foo.wadl
*
* @parameter expression="${generate-pdf.compute.wadl.path.from.docbook.path}" default-value="0"
*/
private String computeWadlPathFromDocbookPath;
/**
* @parameter
* expression="${generate-pdf.canonicalUrlBase}"
* default-value=""
*/
private String canonicalUrlBase;
/**
* @parameter
* expression="${generate-pdf.replacementsFile}"
* default-value="replacements.config"
*/
private String replacementsFile;
/**
*
* @parameter
* expression="${generate-pdf.failOnValidationError}"
* default-value="yes"
*/
private String failOnValidationError;
/**
* A parameter used to specify the security level (external, internal, reviewer, writeronly) of the document.
*
* @parameter
* expression="${generate-pdf.security}"
*/
private String security;
/**
*
* @parameter
* expression="${generate-pdf.strictImageValidation}"
* default-value=true
*/
private boolean strictImageValidation;
/**
*
*
* @parameter expression="${generate-pdf.draft.status}" default-value=""
*/
private String draftStatus;
/**
*
*
* @parameter expression="${generate-webhelp.draft.status}" default-value=""
*/
private String statusBarText;
protected void setImageDirectory (File imageDirectory) {
this.imageDirectory = imageDirectory;
}
protected File getImageDirectory() {
return this.imageDirectory;
}
protected String getNonDefaultStylesheetLocation() {
return "cloud/fo/docbook.xsl";
}
public void preProcess() throws MojoExecutionException {
super.preProcess();
final File targetDirectory = getTargetDirectory();
File imageParentDirectory = targetDirectory.getParentFile();
File xslParentDirectory = targetDirectory.getParentFile();
if (!targetDirectory.exists()) {
FileUtils.mkdir(targetDirectory);
}
//
// Extract all images into the image directory.
//
FileUtils.extractJaredDirectory("images",PDFMojo.class,imageParentDirectory);
setImageDirectory (new File (imageParentDirectory, "images"));
FileUtils.extractJaredDirectory("cloud/war",PDFMojo.class,xslParentDirectory);
//
// Extract all fonts into fonts directory
//
FileUtils.extractJaredDirectory("fonts",PDFMojo.class,imageParentDirectory);
}
//
// Really this is an exact copy of the parent impl, except I use
// my own version of loadFOPConfig. Really, I should be able to
// overwrite that method.
//
public void postProcessResult(File result) throws MojoExecutionException {
final FopFactory fopFactory = FopFactory.newInstance();
final FOUserAgent userAgent = fopFactory.newFOUserAgent();
// First transform the cover page
transformCover();
// FOUserAgent can be used to set PDF metadata
Configuration configuration = loadFOPConfig();
InputStream in = null;
OutputStream out = null;
try
{
String baseURL = sourceDirectory.toURL().toExternalForm();
baseURL = baseURL.replace("file:/", "file:///");
userAgent.setBaseURL(baseURL);
System.err.println ("Absolute path is "+baseURL);
in = openFileForInput(result);
out = openFileForOutput(getOutputFile(result));
fopFactory.setUserConfig(configuration);
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent, out);
// Setup JAXP using identity transformer
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(); // identity transformer
// Setup input stream
Source src = new StreamSource(in);
// Resulting SAX events (the generated FO) must be piped through to FOP
Result res = new SAXResult(fop.getDefaultHandler());
// Start XSLT transformation and FOP processing
transformer.transform(src, res);
}
catch (FOPException e)
{
throw new MojoExecutionException("Failed to convert to PDF", e);
}
catch (TransformerConfigurationException e)
{
throw new MojoExecutionException("Failed to load JAXP configuration", e);
}
catch (TransformerException e)
{
throw new MojoExecutionException("Failed to transform to PDF", e);
}
catch (MalformedURLException e)
{
throw new MojoExecutionException("Failed to get FO basedir", e);
}
finally
{
IOUtils.closeQuietly(out);
IOUtils.closeQuietly(in);
}
}
protected InputStream openFileForInput(File file)
throws MojoExecutionException {
try {
return new FileInputStream(file);
} catch (FileNotFoundException fnfe) {
throw new MojoExecutionException("Failed to open " + file
+ " for input.");
}
}
protected File getOutputFile(File inputFile) {
return new File (inputFile.getAbsolutePath().replaceAll(".fo$",".pdf"));
}
protected OutputStream openFileForOutput(File file)
throws MojoExecutionException {
try {
return new BufferedOutputStream(new FileOutputStream(file));
} catch (FileNotFoundException fnfe) {
throw new MojoExecutionException("Failed to open " + file
+ " for output.");
}
}
protected Configuration loadFOPConfig() throws MojoExecutionException {
System.out.println ("At load config");
String fontPath = (new File(getTargetDirectory().getParentFile(), "fonts")).getAbsolutePath();
StringTemplateGroup templateGroup = new StringTemplateGroup("fonts", fontPath);
StringTemplate template = templateGroup.getInstanceOf("fontconfig");
DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
template.setAttribute ("fontPath",fontPath);
final String config = template.toString();
if (getLog().isDebugEnabled()) {
getLog().debug(config);
}
try {
return builder.build(IOUtils.toInputStream(config));
} catch (IOException ioe) {
throw new MojoExecutionException("Failed to load FOP config.", ioe);
} catch (SAXException saxe) {
throw new MojoExecutionException("Failed to parse FOP config.",
saxe);
} catch (ConfigurationException e) {
throw new MojoExecutionException(
"Failed to do something Avalon requires....", e);
}
}
protected TransformerBuilder createTransformerBuilder(URIResolver resolver) {
return super.createTransformerBuilder (new GlossaryResolver(new DocBookResolver (resolver, getType()), getType()));
}
public void adjustTransformer(Transformer transformer, String sourceFilename, File targetFile) {
super.adjustTransformer(transformer, sourceFilename, targetFile);
transformer.setParameter("branding", branding);
transformer.setParameter("builtForOpenStack", builtForOpenStack);
transformer.setParameter("coverLogoPath", coverLogoPath);
transformer.setParameter("secondaryCoverLogoPath", secondaryCoverLogoPath);
transformer.setParameter("coverLogoLeft", coverLogoLeft);
transformer.setParameter("coverLogoTop", coverLogoTop);
transformer.setParameter("coverUrl", coverUrl);
transformer.setParameter("coverColor", coverColor);
String sysDraftStatus=System.getProperty("draft.status");
getLog().info("adjustTransformer():sysDraftStatus="+sysDraftStatus);
if(null!=sysDraftStatus && !sysDraftStatus.isEmpty()){
draftStatus=sysDraftStatus;
}
transformer.setParameter("draft.status", draftStatus);
String sysStatusBarText=System.getProperty("statusBarText");
if(null!=sysStatusBarText && !sysStatusBarText.isEmpty()){
statusBarText=sysStatusBarText;
}
transformer.setParameter("statusBarText", statusBarText);
transformer.setParameter("project.build.directory", projectBuildDirectory);
String sysSecurity=System.getProperty("security");
getLog().info("adjustTransformer():sysSecurity="+sysSecurity);
if(null!=sysSecurity && !sysSecurity.isEmpty()){
security=sysSecurity;
}
if(security != null){
transformer.setParameter("security",security);
}
if(trimWadlUriCount != null){
transformer.setParameter("trim.wadl.uri.count",trimWadlUriCount);
}
//
// Setup graphics paths
//
sourceDocBook = new File(sourceFilename);
sourceDirectory = sourceDocBook.getParentFile();
File imageDirectory = getImageDirectory();
File calloutDirectory = new File (imageDirectory, "callouts");
transformer.setParameter("docbook.infile",sourceDocBook.getAbsolutePath());
transformer.setParameter("source.directory",sourceDirectory);
transformer.setParameter("compute.wadl.path.from.docbook.path",computeWadlPathFromDocbookPath);
transformer.setParameter ("admon.graphics.path", imageDirectory.getAbsolutePath()+File.separator);
transformer.setParameter ("callout.graphics.path", calloutDirectory.getAbsolutePath()+File.separator);
//
// Setup the background image file
//
File cloudSub = new File (imageDirectory, "cloud");
File ccSub = new File (imageDirectory, "cc");
coverImage = new File (cloudSub, COVER_IMAGE_NAME);
coverImageTemplate = new File (cloudSub, COVER_IMAGE_TEMPLATE_NAME);
coverImageTemplate = new File (cloudSub, "rackspace-cover.st");
transformer.setParameter ("cloud.api.background.image", coverImage.getAbsolutePath());
transformer.setParameter ("cloud.api.cc.image.dir", ccSub.getAbsolutePath());
}
protected void transformCover() throws MojoExecutionException {
try {
ClassLoader classLoader = Thread.currentThread()
.getContextClassLoader();
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(new StreamSource(classLoader.getResourceAsStream(COVER_XSL)));
if(coverColor != null){
transformer.setParameter("coverColor", coverColor);
}
String sysDraftStatus=System.getProperty("draft.status");
if(null!=sysDraftStatus && !sysDraftStatus.isEmpty()){
draftStatus=sysDraftStatus;
}
if(null!=draftStatus){
transformer.setParameter("draft.status", draftStatus);
}
String sysStatusBarText=System.getProperty("statusBarText");
if(null!=sysStatusBarText && !sysStatusBarText.isEmpty()){
statusBarText=sysStatusBarText;
}
if(null != statusBarText){
transformer.setParameter("status.bar.text", statusBarText);
}
transformer.setParameter("branding", branding);
//transformer.setParameter("docbook.infile",sourceDocBook.getAbsolutePath());
String srcFilename = sourceDocBook.getName();
getLog().info("SOURCE FOR COVER PAGE: "+this.projectBuildDirectory+"/docbkx/"+srcFilename);
transformer.setParameter("docbook.infile", this.projectBuildDirectory+"/docbkx/"+srcFilename);
transformer.transform (new StreamSource(coverImageTemplate), new StreamResult(coverImage));
}
catch (TransformerConfigurationException e)
{
throw new MojoExecutionException("Failed to load JAXP configuration", e);
}
catch (TransformerException e)
{
throw new MojoExecutionException("Failed to transform to cover", e);
}
}
@Override
protected Source createSource(String inputFilename, File sourceFile, PreprocessingFilter filter)
throws MojoExecutionException {
String pathToPipelineFile = "classpath:/pdf.xpl"; //use "classpath:/path" for this to work
Source source = super.createSource(inputFilename, sourceFile, filter);
Map map=new HashMap<String, String>();
String sysSecurity=System.getProperty("security");
getLog().info("adjustTransformer():sysSecurity="+sysSecurity);
if(null!=sysSecurity && !sysSecurity.isEmpty()){
security=sysSecurity;
}
map.put("targetDirectory", this.getTargetDirectory().getParentFile().getAbsolutePath());
map.put("security", security);
map.put("canonicalUrlBase", canonicalUrlBase);
map.put("replacementsFile", replacementsFile);
map.put("failOnValidationError", failOnValidationError);
map.put("project.build.directory", this.projectBuildDirectory);
map.put("inputSrcFile", inputFilename);
map.put("outputType", "pdf");
map.put("strictImageValidation", String.valueOf(this.strictImageValidation));
map.put("status.bar.text", getProperty("statusBarText"));
map.put("draft.status", getProperty("draftStatus"));
// Profiling attrs:
map.put("profile.os", getProperty("profileOs"));
map.put("profile.arch", getProperty("profileArch"));
map.put("profile.condition", getProperty("profileCondition"));
map.put("profile.audience", getProperty("profileAudience"));
map.put("profile.conformance", getProperty("profileConformance"));
map.put("profile.revision", getProperty("profileRevision"));
map.put("profile.userlevel", getProperty("profileUserlevel"));
map.put("profile.vendor", getProperty("profileVendor"));
//String outputDir=System.getProperty("project.build.outputDirectory ");
return CalabashHelper.createSource(source, pathToPipelineFile, map);
}
}
| src/main/java/com/rackspace/cloud/api/docs/PDFMojo.java | package com.rackspace.cloud.api.docs;
import com.agilejava.docbkx.maven.AbstractFoMojo;
import com.agilejava.docbkx.maven.PreprocessingFilter;
import com.agilejava.docbkx.maven.TransformerBuilder;
import com.rackspace.cloud.api.docs.CalabashHelper;
import com.rackspace.cloud.api.docs.FileUtils;
import com.rackspace.cloud.api.docs.GlossaryResolver;
import org.antlr.stringtemplate.StringTemplate;
import org.antlr.stringtemplate.StringTemplateGroup;
import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationException;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.commons.io.IOUtils;
import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.MimeConstants;
import org.apache.maven.plugin.MojoExecutionException;
import org.xml.sax.SAXException;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.URIResolver;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.MalformedURLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
public abstract class PDFMojo extends AbstractFoMojo {
private File imageDirectory;
private File sourceDirectory;
private File sourceDocBook;
private File coverImageTemplate;
private File coverImage;
private static final String COVER_IMAGE_TEMPLATE_NAME = "cover.st";
private static final String COVER_IMAGE_NAME = "cover.svg";
private static final String COVER_XSL = "cloud/cover.xsl";
/**
* @parameter expression="${project.build.directory}"
*/
private String projectBuildDirectory;
/**
* The greeting to display.
*
* @parameter expression="${generate-pdf.branding}" default-value="rackspace"
*/
private String branding;
/**
* Display built for OpenStack logo?
*
* @parameter expression="${generate-pdf.builtForOpenStack}" default-value="0"
*/
private String builtForOpenStack;
/**
* Path to an alternative cover logo.
*
* @parameter expression="${generate-pdf.coverLogoPath}" default-value=""
*/
private String coverLogoPath;
/**
* Path to an alternative cover logo.
*
* @parameter expression="${generate-pdf.secondaryCoverLogoPath}" default-value=""
*/
private String secondaryCoverLogoPath;
/**
* Distance from the left edge of the page at which the
* cover logo is displayed.
*
* @parameter expression="${generate-pdf.coverLogoLeft}" default-value=""
*/
private String coverLogoLeft;
/**
* Distance from the top of the page at which teh
* cover logo is displayed.
*
* @parameter expression="${generate-pdf.coverLogoTop}" default-value=""
*/
private String coverLogoTop;
/**
* url to display under the cover logo.
*
* @parameter expression="${generate-pdf.coverUrl}" default-value=""
*/
private String coverUrl;
/**
* The color to use for the polygon on the cover
*
* @parameter expression="${generate-pdf.coverColor}" default-value=""
*/
private String coverColor;
/**
* The greeting to display.
*
* @parameter expression="${generate-pdf.variablelistAsBlocks}"
*/
private String variablelistAsBlocks;
/**
* A parameter used to configure how many elements to trim from the URI in the documentation for a wadl method.
*
* @parameter expression="${generate-pdf.trim.wadl.uri.count}" default-value=""
*/
private String trimWadlUriCount;
/**
* Controls how the path to the wadl is calculated. If 0 or not set, then
* The xslts look for the normalized wadl in /generated-resources/xml/xslt/.
* Otherwise, in /generated-resources/xml/xslt/path/to/docbook-src, e.g.
* /generated-resources/xml/xslt/src/docbkx/foo.wadl
*
* @parameter expression="${generate-pdf.compute.wadl.path.from.docbook.path}" default-value="0"
*/
private String computeWadlPathFromDocbookPath;
/**
* @parameter
* expression="${generate-pdf.canonicalUrlBase}"
* default-value=""
*/
private String canonicalUrlBase;
/**
* @parameter
* expression="${generate-pdf.replacementsFile}"
* default-value="replacements.config"
*/
private String replacementsFile;
/**
*
* @parameter
* expression="${generate-pdf.failOnValidationError}"
* default-value="yes"
*/
private String failOnValidationError;
/**
* A parameter used to specify the security level (external, internal, reviewer, writeronly) of the document.
*
* @parameter
* expression="${generate-pdf.security}"
*/
private String security;
/**
*
* @parameter
* expression="${generate-pdf.strictImageValidation}"
* default-value=true
*/
private boolean strictImageValidation;
/**
*
*
* @parameter expression="${generate-pdf.draft.status}" default-value=""
*/
private String draftStatus;
/**
*
*
* @parameter expression="${generate-webhelp.draft.status}" default-value=""
*/
private String statusBarText;
protected void setImageDirectory (File imageDirectory) {
this.imageDirectory = imageDirectory;
}
protected File getImageDirectory() {
return this.imageDirectory;
}
protected String getNonDefaultStylesheetLocation() {
return "cloud/fo/docbook.xsl";
}
public void preProcess() throws MojoExecutionException {
super.preProcess();
final File targetDirectory = getTargetDirectory();
File imageParentDirectory = targetDirectory.getParentFile();
File xslParentDirectory = targetDirectory.getParentFile();
if (!targetDirectory.exists()) {
FileUtils.mkdir(targetDirectory);
}
//
// Extract all images into the image directory.
//
FileUtils.extractJaredDirectory("images",PDFMojo.class,imageParentDirectory);
setImageDirectory (new File (imageParentDirectory, "images"));
FileUtils.extractJaredDirectory("cloud/war",PDFMojo.class,xslParentDirectory);
//
// Extract all fonts into fonts directory
//
FileUtils.extractJaredDirectory("fonts",PDFMojo.class,imageParentDirectory);
}
//
// Really this is an exact copy of the parent impl, except I use
// my own version of loadFOPConfig. Really, I should be able to
// overwrite that method.
//
public void postProcessResult(File result) throws MojoExecutionException {
final FopFactory fopFactory = FopFactory.newInstance();
final FOUserAgent userAgent = fopFactory.newFOUserAgent();
// First transform the cover page
transformCover();
// FOUserAgent can be used to set PDF metadata
Configuration configuration = loadFOPConfig();
InputStream in = null;
OutputStream out = null;
try
{
String baseURL = sourceDirectory.toURL().toExternalForm();
baseURL = baseURL.replace("file:/", "file:///");
userAgent.setBaseURL(baseURL);
System.err.println ("Absolute path is "+baseURL);
in = openFileForInput(result);
out = openFileForOutput(getOutputFile(result));
fopFactory.setUserConfig(configuration);
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, userAgent, out);
// Setup JAXP using identity transformer
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(); // identity transformer
// Setup input stream
Source src = new StreamSource(in);
// Resulting SAX events (the generated FO) must be piped through to FOP
Result res = new SAXResult(fop.getDefaultHandler());
// Start XSLT transformation and FOP processing
transformer.transform(src, res);
}
catch (FOPException e)
{
throw new MojoExecutionException("Failed to convert to PDF", e);
}
catch (TransformerConfigurationException e)
{
throw new MojoExecutionException("Failed to load JAXP configuration", e);
}
catch (TransformerException e)
{
throw new MojoExecutionException("Failed to transform to PDF", e);
}
catch (MalformedURLException e)
{
throw new MojoExecutionException("Failed to get FO basedir", e);
}
finally
{
IOUtils.closeQuietly(out);
IOUtils.closeQuietly(in);
}
}
protected InputStream openFileForInput(File file)
throws MojoExecutionException {
try {
return new FileInputStream(file);
} catch (FileNotFoundException fnfe) {
throw new MojoExecutionException("Failed to open " + file
+ " for input.");
}
}
protected File getOutputFile(File inputFile) {
return new File (inputFile.getAbsolutePath().replaceAll(".fo$",".pdf"));
}
protected OutputStream openFileForOutput(File file)
throws MojoExecutionException {
try {
return new BufferedOutputStream(new FileOutputStream(file));
} catch (FileNotFoundException fnfe) {
throw new MojoExecutionException("Failed to open " + file
+ " for output.");
}
}
protected Configuration loadFOPConfig() throws MojoExecutionException {
System.out.println ("At load config");
String fontPath = (new File(getTargetDirectory().getParentFile(), "fonts")).getAbsolutePath();
StringTemplateGroup templateGroup = new StringTemplateGroup("fonts", fontPath);
StringTemplate template = templateGroup.getInstanceOf("fontconfig");
DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
template.setAttribute ("fontPath",fontPath);
final String config = template.toString();
if (getLog().isDebugEnabled()) {
getLog().debug(config);
}
try {
return builder.build(IOUtils.toInputStream(config));
} catch (IOException ioe) {
throw new MojoExecutionException("Failed to load FOP config.", ioe);
} catch (SAXException saxe) {
throw new MojoExecutionException("Failed to parse FOP config.",
saxe);
} catch (ConfigurationException e) {
throw new MojoExecutionException(
"Failed to do something Avalon requires....", e);
}
}
protected TransformerBuilder createTransformerBuilder(URIResolver resolver) {
return super.createTransformerBuilder (new GlossaryResolver(new DocBookResolver (resolver, getType()), getType()));
}
public void adjustTransformer(Transformer transformer, String sourceFilename, File targetFile) {
super.adjustTransformer(transformer, sourceFilename, targetFile);
transformer.setParameter("branding", branding);
transformer.setParameter("builtForOpenStack", builtForOpenStack);
transformer.setParameter("coverLogoPath", coverLogoPath);
transformer.setParameter("secondaryCoverLogoPath", secondaryCoverLogoPath);
transformer.setParameter("coverLogoLeft", coverLogoLeft);
transformer.setParameter("coverLogoTop", coverLogoTop);
transformer.setParameter("coverUrl", coverUrl);
transformer.setParameter("coverColor", coverColor);
String sysDraftStatus=System.getProperty("draft.status");
getLog().info("adjustTransformer():sysDraftStatus="+sysDraftStatus);
if(null!=sysDraftStatus && !sysDraftStatus.isEmpty()){
draftStatus=sysDraftStatus;
}
transformer.setParameter("draft.status", draftStatus);
String sysStatusBarText=System.getProperty("statusBarText");
if(null!=sysStatusBarText && !sysStatusBarText.isEmpty()){
statusBarText=sysStatusBarText;
}
transformer.setParameter("statusBarText", statusBarText);
transformer.setParameter("project.build.directory", projectBuildDirectory);
String sysSecurity=System.getProperty("security");
getLog().info("adjustTransformer():sysSecurity="+sysSecurity);
if(null!=sysSecurity && !sysSecurity.isEmpty()){
security=sysSecurity;
}
if(security != null){
transformer.setParameter("security",security);
}
if(trimWadlUriCount != null){
transformer.setParameter("trim.wadl.uri.count",trimWadlUriCount);
}
//
// Setup graphics paths
//
sourceDocBook = new File(sourceFilename);
sourceDirectory = sourceDocBook.getParentFile();
File imageDirectory = getImageDirectory();
File calloutDirectory = new File (imageDirectory, "callouts");
transformer.setParameter("docbook.infile",sourceDocBook.getAbsolutePath());
transformer.setParameter("source.directory",sourceDirectory);
transformer.setParameter("compute.wadl.path.from.docbook.path",computeWadlPathFromDocbookPath);
transformer.setParameter ("admon.graphics.path", imageDirectory.getAbsolutePath()+File.separator);
transformer.setParameter ("callout.graphics.path", calloutDirectory.getAbsolutePath()+File.separator);
//
// Setup the background image file
//
File cloudSub = new File (imageDirectory, "cloud");
File ccSub = new File (imageDirectory, "cc");
coverImage = new File (cloudSub, COVER_IMAGE_NAME);
coverImageTemplate = new File (cloudSub, COVER_IMAGE_TEMPLATE_NAME);
coverImageTemplate = new File (cloudSub, "rackspace-cover.st");
transformer.setParameter ("cloud.api.background.image", coverImage.getAbsolutePath());
transformer.setParameter ("cloud.api.cc.image.dir", ccSub.getAbsolutePath());
}
protected void transformCover() throws MojoExecutionException {
try {
ClassLoader classLoader = Thread.currentThread()
.getContextClassLoader();
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(new StreamSource(classLoader.getResourceAsStream(COVER_XSL)));
if(coverColor != null){
transformer.setParameter("coverColor", coverColor);
}
String sysDraftStatus=System.getProperty("draft.status");
if(null!=sysDraftStatus && !sysDraftStatus.isEmpty()){
draftStatus=sysDraftStatus;
}
if(null!=draftStatus){
transformer.setParameter("draft.status", draftStatus);
}
String sysStatusBarText=System.getProperty("statusBarText");
if(null!=sysStatusBarText && !sysStatusBarText.isEmpty()){
statusBarText=sysStatusBarText;
}
if(null != statusBarText){
transformer.setParameter("status.bar.text", statusBarText);
}
transformer.setParameter("branding", branding);
//transformer.setParameter("docbook.infile",sourceDocBook.getAbsolutePath());
String srcFilename = sourceDocBook.getName();
getLog().info("SOURCE FOR COVER PAGE: "+this.projectBuildDirectory+"/docbkx/"+srcFilename);
transformer.setParameter("docbook.infile", this.projectBuildDirectory+"/docbkx/"+srcFilename);
transformer.transform (new StreamSource(coverImageTemplate), new StreamResult(coverImage));
}
catch (TransformerConfigurationException e)
{
throw new MojoExecutionException("Failed to load JAXP configuration", e);
}
catch (TransformerException e)
{
throw new MojoExecutionException("Failed to transform to cover", e);
}
}
@Override
protected Source createSource(String inputFilename, File sourceFile, PreprocessingFilter filter)
throws MojoExecutionException {
String pathToPipelineFile = "classpath:/pdf.xpl"; //use "classpath:/path" for this to work
Source source = super.createSource(inputFilename, sourceFile, filter);
Map map=new HashMap<String, String>();
String sysSecurity=System.getProperty("security");
getLog().info("adjustTransformer():sysSecurity="+sysSecurity);
if(null!=sysSecurity && !sysSecurity.isEmpty()){
security=sysSecurity;
}
map.put("security", security);
map.put("canonicalUrlBase", canonicalUrlBase);
map.put("replacementsFile", replacementsFile);
map.put("failOnValidationError", failOnValidationError);
map.put("project.build.directory", this.projectBuildDirectory);
map.put("inputSrcFile", inputFilename);
map.put("outputType", "pdf");
map.put("strictImageValidation", String.valueOf(this.strictImageValidation));
map.put("status.bar.text", getProperty("statusBarText"));
map.put("draft.status", getProperty("draftStatus"));
// Profiling attrs:
map.put("profile.os", getProperty("profileOs"));
map.put("profile.arch", getProperty("profileArch"));
map.put("profile.condition", getProperty("profileCondition"));
map.put("profile.audience", getProperty("profileAudience"));
map.put("profile.conformance", getProperty("profileConformance"));
map.put("profile.revision", getProperty("profileRevision"));
map.put("profile.userlevel", getProperty("profileUserlevel"));
map.put("profile.vendor", getProperty("profileVendor"));
//String outputDir=System.getProperty("project.build.outputDirectory ");
return CalabashHelper.createSource(source, pathToPipelineFile, map);
}
}
| Fix bug where PdfMojo tries to write temp file to /
| src/main/java/com/rackspace/cloud/api/docs/PDFMojo.java | Fix bug where PdfMojo tries to write temp file to / | <ide><path>rc/main/java/com/rackspace/cloud/api/docs/PDFMojo.java
<ide> if(null!=sysSecurity && !sysSecurity.isEmpty()){
<ide> security=sysSecurity;
<ide> }
<add> map.put("targetDirectory", this.getTargetDirectory().getParentFile().getAbsolutePath());
<ide> map.put("security", security);
<ide> map.put("canonicalUrlBase", canonicalUrlBase);
<ide> map.put("replacementsFile", replacementsFile); |
|
Java | lgpl-2.1 | 70df9cbd060c285f6b5eb564f021fcccd8599d3c | 0 | sewe/spotbugs,spotbugs/spotbugs,johnscancella/spotbugs,KengoTODA/spotbugs,spotbugs/spotbugs,johnscancella/spotbugs,KengoTODA/spotbugs,johnscancella/spotbugs,KengoTODA/spotbugs,spotbugs/spotbugs,spotbugs/spotbugs,spotbugs/spotbugs,sewe/spotbugs,johnscancella/spotbugs,KengoTODA/spotbugs,sewe/spotbugs,sewe/spotbugs | /*
* FindBugs - Find bugs in Java programs
* Copyright (C) 2003,2004 University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs.detect;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.Attribute;
import org.apache.bcel.classfile.Code;
import org.apache.bcel.classfile.Deprecated;
import org.apache.bcel.classfile.Field;
import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Method;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.Detector;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.ba.AnalysisContext;
import edu.umd.cs.findbugs.ba.ClassContext;
import edu.umd.cs.findbugs.ba.SignatureParser;
import edu.umd.cs.findbugs.ba.XClass;
import edu.umd.cs.findbugs.ba.XFactory;
import edu.umd.cs.findbugs.ba.XMethod;
import edu.umd.cs.findbugs.classfile.CheckedAnalysisException;
import edu.umd.cs.findbugs.classfile.ClassDescriptor;
import edu.umd.cs.findbugs.classfile.DescriptorFactory;
import edu.umd.cs.findbugs.classfile.Global;
import edu.umd.cs.findbugs.props.AbstractWarningProperty;
import edu.umd.cs.findbugs.props.PriorityAdjustment;
import edu.umd.cs.findbugs.props.WarningPropertySet;
import edu.umd.cs.findbugs.visitclass.PreorderVisitor;
public class Naming extends PreorderVisitor implements Detector {
public static class NamingProperty extends AbstractWarningProperty {
private NamingProperty(String name, PriorityAdjustment priorityAdjustment) {
super(name, priorityAdjustment);
}
public static final NamingProperty METHOD_IS_CALLED = new NamingProperty("CONFUSING_METHOD_IS_CALLED",
PriorityAdjustment.LOWER_PRIORITY);
public static final NamingProperty METHOD_IS_DEPRECATED = new NamingProperty("CONFUSING_METHOD_IS_DEPRECATED",
PriorityAdjustment.LOWER_PRIORITY);
}
String baseClassName;
boolean classIsPublicOrProtected;
public static @CheckForNull
XMethod definedIn(JavaClass clazz, XMethod m) {
for (Method m2 : clazz.getMethods())
if (m.getName().equals(m2.getName()) && m.getSignature().equals(m2.getSignature()) && m.isStatic() == m2.isStatic())
return XFactory.createXMethod(clazz, m2);
return null;
}
public static boolean confusingMethodNamesWrongCapitalization(XMethod m1, XMethod m2) {
if (m1.isStatic() != m2.isStatic())
return false;
if (m1.getClassName().equals(m2.getClassName()))
return false;
if (m1.getName().equals(m2.getName())) return false;
if (m1.getName().equalsIgnoreCase(m2.getName())
&& removePackageNamesFromSignature(m1.getSignature()).equals(removePackageNamesFromSignature(m2.getSignature())))
return true;
return false;
}
public static boolean confusingMethodNamesWrongPackage(XMethod m1, XMethod m2) {
if (m1.isStatic() != m2.isStatic())
return false;
if (m1.getClassName().equals(m2.getClassName()))
return false;
if (!m1.getName().equals(m2.getName()))
return false;
if (m1.getSignature().equals(m2.getSignature()))
return false;
if (removePackageNamesFromSignature(m1.getSignature()).equals(removePackageNamesFromSignature(m2.getSignature())))
return true;
return false;
}
// map of canonicalName -> trueMethodName
HashMap<String, HashSet<String>> canonicalToTrueMapping = new HashMap<String, HashSet<String>>();
// map of canonicalName -> Set<XMethod>
HashMap<String, HashSet<XMethod>> canonicalToXMethod = new HashMap<String, HashSet<XMethod>>();
HashSet<String> visited = new HashSet<String>();
private BugReporter bugReporter;
public Naming(BugReporter bugReporter) {
this.bugReporter = bugReporter;
}
public void visitClassContext(ClassContext classContext) {
classContext.getJavaClass().accept(this);
}
private boolean checkSuper(XMethod m, HashSet<XMethod> others) {
if (m.isStatic())
return false;
if (m.getName().equals("<init>") || m.getName().equals("<clinit>"))
return false;
for (XMethod m2 : others) {
try {
if ((confusingMethodNamesWrongCapitalization(m, m2) || confusingMethodNamesWrongPackage(m,m2))
&& Repository.instanceOf(m.getClassName(), m2.getClassName())) {
WarningPropertySet<NamingProperty> propertySet = new WarningPropertySet<NamingProperty>();
int priority = HIGH_PRIORITY;
XMethod m3 = null;
try {
JavaClass clazz = Repository.lookupClass(m.getClassName());
if ((m3 = definedIn(clazz, m2)) == null) {
// the method we don't override is also defined in our class
priority = NORMAL_PRIORITY;
}
if (m3 == null)
for (JavaClass s : clazz.getSuperClasses())
if ((m3 = definedIn(s, m)) != null) {
// the method we define is also defined in our superclass
priority = NORMAL_PRIORITY;
break;
}
if (m3 == null)
for (JavaClass i : clazz.getAllInterfaces())
if ((m3 = definedIn(i, m)) != null) {
priority = NORMAL_PRIORITY;
// the method we define is also defined in an interface
break;
}
} catch (ClassNotFoundException e) {
priority++;
AnalysisContext.reportMissingClass(e);
}
XFactory xFactory = AnalysisContext.currentXFactory();
if (m3 == null && xFactory.isCalled(m))
propertySet.addProperty(NamingProperty.METHOD_IS_CALLED);
else if (m.isDeprecated() || m2.isDeprecated())
propertySet.addProperty(NamingProperty.METHOD_IS_DEPRECATED);
priority = propertySet.computePriority(priority);
if (!m.getName().equals(m2.getName()) && m.getName().equalsIgnoreCase(m2.getName())) {
String pattern = m3 != null ? "NM_VERY_CONFUSING_INTENTIONAL" : "NM_VERY_CONFUSING";
BugInstance bug = new BugInstance(this, pattern, priority).addClass(m.getClassName()).addMethod(m)
.addClass(m2.getClassName()).addMethod(m2);
if (m3 != null)
bug.addMethod(m3);
propertySet.decorateBugInstance(bug);
bugReporter.reportBug(bug);
}
if (!m.getSignature().equals(m2.getSignature())
&& removePackageNamesFromSignature(m.getSignature()).equals(
removePackageNamesFromSignature(m2.getSignature()))) {
String pattern = m3 != null ? "NM_WRONG_PACKAGE_INTENTIONAL" : "NM_WRONG_PACKAGE";
Iterator<String> s = new SignatureParser(m.getSignature()).parameterSignatureIterator();
Iterator<String> s2 = new SignatureParser(m2.getSignature()).parameterSignatureIterator();
while (s.hasNext()) {
String p = s.next();
String p2 = s2.next();
if (!p.equals(p2)) {
BugInstance bug = new BugInstance(this, pattern, priority).addClass(m.getClassName())
.addMethod(m).addClass(m2.getClassName()).addMethod(m2).addFoundAndExpectedType(p, p2);
if (m3 != null)
bug.addMethod(m3);
propertySet.decorateBugInstance(bug);
bugReporter.reportBug(bug);
}
}
//
}
return true;
}
} catch (ClassNotFoundException e) {
AnalysisContext.reportMissingClass(e);
}
}
return false;
}
@SuppressWarnings("unchecked")
private boolean checkNonSuper(XMethod m, HashSet<XMethod> others) {
if (m.isStatic())
return false;
if (m.getName().startsWith("<init>") || m.getName().startsWith("<clinit>"))
return false;
for (XMethod m2 : others) {
if (confusingMethodNamesWrongCapitalization(m, m2)) {
XMethod mm1 = m;
XMethod mm2 = m2;
if (m.compareTo(m2) < 0) {
mm1 = m;
mm2 = m2;
} else {
mm1 = m2;
mm2 = m;
}
bugReporter.reportBug(new BugInstance(this, "NM_CONFUSING", LOW_PRIORITY).addClass(mm1.getClassName()).addMethod(
mm1).addClass(mm2.getClassName()).addMethod(mm2));
return true;
}
}
return false;
}
public void report() {
canonicalNameIterator: for (String allSmall : canonicalToTrueMapping.keySet()) {
HashSet<String> s = canonicalToTrueMapping.get(allSmall);
if (s.size() <= 1)
continue;
HashSet<XMethod> conflictingMethods = canonicalToXMethod.get(allSmall);
for (Iterator<XMethod> j = conflictingMethods.iterator(); j.hasNext();) {
if (checkSuper(j.next(), conflictingMethods))
j.remove();
}
for (XMethod conflictingMethod : conflictingMethods) {
if (checkNonSuper(conflictingMethod, conflictingMethods))
continue canonicalNameIterator;
}
}
}
public String stripPackageName(String className) {
if (className.indexOf('.') >= 0)
return className.substring(className.lastIndexOf('.') + 1);
else if (className.indexOf('/') >= 0)
return className.substring(className.lastIndexOf('/') + 1);
else
return className;
}
public boolean sameSimpleName(String class1, String class2) {
return class1 != null && class2 != null && stripPackageName(class1).equals(stripPackageName(class2));
}
@Override
public void visitJavaClass(JavaClass obj) {
String name = obj.getClassName();
if (!visited.add(name))
return;
String superClassName = obj.getSuperclassName();
if (!name.equals("java.lang.Object")) {
if (sameSimpleName(superClassName, name)) {
bugReporter.reportBug(new BugInstance(this, "NM_SAME_SIMPLE_NAME_AS_SUPERCLASS", HIGH_PRIORITY).addClass(name)
.addClass(superClassName));
}
for (String interfaceName : obj.getInterfaceNames())
if (sameSimpleName(interfaceName, name)) {
bugReporter.reportBug(new BugInstance(this, "NM_SAME_SIMPLE_NAME_AS_INTERFACE", NORMAL_PRIORITY).addClass(
name).addClass(interfaceName));
}
}
if (obj.isInterface())
return;
if (superClassName.equals("java.lang.Object") && !visited.contains(superClassName)) try {
visitJavaClass(obj.getSuperClass());
} catch (ClassNotFoundException e) {
// ignore it
}
super.visitJavaClass(obj);
}
/**
* Determine whether the class descriptor ultimately inherits from
* java.lang.Exception
* @param d class descriptor we want to check
* @return true iff the descriptor ultimately inherits from Exception
*/
private static boolean mightInheritFromException(ClassDescriptor d) {
while(d != null) {
try {
if("java.lang.Exception".equals(d.getDottedClassName())) {
return true;
}
XClass classNameAndInfo =
Global.getAnalysisCache().
getClassAnalysis(XClass.class, d);
d = classNameAndInfo.getSuperclassDescriptor();
} catch (CheckedAnalysisException e) {
return true; // don't know
}
}
return false;
}
boolean hasBadMethodNames;
boolean hasBadFieldNames;
@Override
public void visit(JavaClass obj) {
String name = obj.getClassName();
String[] parts = name.split("[$+.]");
baseClassName = parts[parts.length - 1];
for(String p : obj.getClassName().split("[.]")) if (p.length() == 1) return;
classIsPublicOrProtected = obj.isPublic() || obj.isProtected();
if (Character.isLetter(baseClassName.charAt(0)) && !Character.isUpperCase(baseClassName.charAt(0))
&& baseClassName.indexOf("_") == -1)
bugReporter.reportBug(new BugInstance(this, "NM_CLASS_NAMING_CONVENTION", classIsPublicOrProtected ? NORMAL_PRIORITY
: LOW_PRIORITY).addClass(this));
if (name.endsWith("Exception")) {
// Does it ultimately inherit from Throwable?
if(!mightInheritFromException(DescriptorFactory.createClassDescriptor(obj))) {
// It doens't, so the name is misleading
bugReporter.reportBug(new BugInstance(this, "NM_CLASS_NOT_EXCEPTION", NORMAL_PRIORITY).addClass(this));
}
}
int badFieldNames = 0;
for(Field f : obj.getFields())
if (f.getName().length() >= 2 && badFieldName(f)) badFieldNames++;
hasBadFieldNames = badFieldNames > 5 && badFieldNames > obj.getFields().length/2;
int badNames = 0;
for(Method m : obj.getMethods())
if (badMethodName(m.getName())) badNames++;
hasBadMethodNames = badNames > 5 && badNames > obj.getMethods().length/2;
super.visit(obj);
}
@Override
public void visit(Field obj) {
if (getFieldName().length() == 1)
return;
if (badFieldName(obj)) {
bugReporter.reportBug(new BugInstance(this, "NM_FIELD_NAMING_CONVENTION", classIsPublicOrProtected
&& (obj.isPublic() || obj.isProtected()) && !hasBadFieldNames ? NORMAL_PRIORITY : LOW_PRIORITY).addClass(this).addVisitedField(
this));
}
}
/**
* @param obj
* @return
*/
private boolean badFieldName(Field obj) {
return !obj.isFinal() && Character.isLetter(getFieldName().charAt(0)) && !Character.isLowerCase(getFieldName().charAt(0))
&& getFieldName().indexOf("_") == -1 && Character.isLetter(getFieldName().charAt(1))
&& Character.isLowerCase(getFieldName().charAt(1));
}
private final static Pattern sigType = Pattern.compile("L([^;]*/)?([^/]+;)");
private boolean isInnerClass(JavaClass obj) {
for (Field f : obj.getFields())
if (f.getName().startsWith("this$"))
return true;
return false;
}
private boolean markedAsNotUsable(Method obj) {
for (Attribute a : obj.getAttributes())
if (a instanceof Deprecated)
return true;
Code code = obj.getCode();
if (code == null)
return false;
byte[] codeBytes = code.getCode();
if (codeBytes.length > 1 && codeBytes.length < 10) {
int lastOpcode = codeBytes[codeBytes.length - 1] & 0xff;
if (lastOpcode != ATHROW)
return false;
for (int b : codeBytes)
if ((b & 0xff) == RETURN)
return false;
return true;
}
return false;
}
private static @CheckForNull
Method findVoidConstructor(JavaClass clazz) {
for (Method m : clazz.getMethods())
if (m.getName().equals("<init>") && m.getSignature().equals("()V"))
return m;
return null;
}
@Override
public void visit(Method obj) {
String mName = getMethodName();
if (mName.length() == 1)
return;
if (mName.equals("isRequestedSessionIdFromURL") || mName.equals("isRequestedSessionIdFromUrl"))
return;
if (badMethodName(mName))
bugReporter.reportBug(new BugInstance(this, "NM_METHOD_NAMING_CONVENTION", classIsPublicOrProtected
&& (obj.isPublic() || obj.isProtected()) && !hasBadMethodNames ? NORMAL_PRIORITY : LOW_PRIORITY).addClassAndMethod(this));
String sig = getMethodSig();
if (mName.equals(baseClassName) && sig.equals("()V")) {
Code code = obj.getCode();
Method realVoidConstructor = findVoidConstructor(getThisClass());
if (code != null && !markedAsNotUsable(obj)) {
int priority = NORMAL_PRIORITY;
if (codeDoesSomething(code))
priority--;
else if (!obj.isPublic() && getThisClass().isPublic())
priority--;
if (realVoidConstructor == null)
priority++;
bugReporter.reportBug(new BugInstance(this, "NM_METHOD_CONSTRUCTOR_CONFUSION", priority).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
}
if (obj.isAbstract())
return;
if (obj.isPrivate())
return;
if (mName.equals("equal") && sig.equals("(Ljava/lang/Object;)Z")) {
bugReporter.reportBug(new BugInstance(this, "NM_BAD_EQUAL", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (mName.equals("hashcode") && sig.equals("()I")) {
bugReporter.reportBug(new BugInstance(this, "NM_LCASE_HASHCODE", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (mName.equals("tostring") && sig.equals("()Ljava/lang/String;")) {
bugReporter.reportBug(new BugInstance(this, "NM_LCASE_TOSTRING", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (obj.isPrivate() || obj.isStatic() || mName.equals("<init>"))
return;
String trueName = mName + sig;
String sig2 = removePackageNamesFromSignature(sig);
String allSmall = mName.toLowerCase() + sig2;
XMethod xm = getXMethod();
{
HashSet<String> s = canonicalToTrueMapping.get(allSmall);
if (s == null) {
s = new HashSet<String>();
canonicalToTrueMapping.put(allSmall, s);
}
s.add(trueName);
}
{
HashSet<XMethod> s = canonicalToXMethod.get(allSmall);
if (s == null) {
s = new HashSet<XMethod>();
canonicalToXMethod.put(allSmall, s);
}
s.add(xm);
}
}
/**
* @param mName
* @return
*/
private boolean badMethodName(String mName) {
return mName.length() >= 2 && Character.isLetter(mName.charAt(0)) && !Character.isLowerCase(mName.charAt(0)) && Character.isLetter(mName.charAt(1))
&& Character.isLowerCase(mName.charAt(1)) && mName.indexOf("_") == -1;
}
private boolean codeDoesSomething(Code code) {
byte[] codeBytes = code.getCode();
return codeBytes.length > 1;
}
private static String removePackageNamesFromSignature(String sig) {
int end = sig.indexOf(")");
Matcher m = sigType.matcher(sig.substring(0, end));
return m.replaceAll("L$2") + sig.substring(end);
}
}
| findbugs/src/java/edu/umd/cs/findbugs/detect/Naming.java | /*
* FindBugs - Find bugs in Java programs
* Copyright (C) 2003,2004 University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs.detect;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.bcel.Repository;
import org.apache.bcel.classfile.Attribute;
import org.apache.bcel.classfile.Code;
import org.apache.bcel.classfile.Deprecated;
import org.apache.bcel.classfile.Field;
import org.apache.bcel.classfile.JavaClass;
import org.apache.bcel.classfile.Method;
import edu.umd.cs.findbugs.BugInstance;
import edu.umd.cs.findbugs.BugReporter;
import edu.umd.cs.findbugs.Detector;
import edu.umd.cs.findbugs.annotations.CheckForNull;
import edu.umd.cs.findbugs.ba.AnalysisContext;
import edu.umd.cs.findbugs.ba.ClassContext;
import edu.umd.cs.findbugs.ba.SignatureParser;
import edu.umd.cs.findbugs.ba.XClass;
import edu.umd.cs.findbugs.ba.XFactory;
import edu.umd.cs.findbugs.ba.XMethod;
import edu.umd.cs.findbugs.classfile.CheckedAnalysisException;
import edu.umd.cs.findbugs.classfile.ClassDescriptor;
import edu.umd.cs.findbugs.classfile.DescriptorFactory;
import edu.umd.cs.findbugs.classfile.Global;
import edu.umd.cs.findbugs.props.AbstractWarningProperty;
import edu.umd.cs.findbugs.props.PriorityAdjustment;
import edu.umd.cs.findbugs.props.WarningPropertySet;
import edu.umd.cs.findbugs.visitclass.PreorderVisitor;
public class Naming extends PreorderVisitor implements Detector {
public static class NamingProperty extends AbstractWarningProperty {
private NamingProperty(String name, PriorityAdjustment priorityAdjustment) {
super(name, priorityAdjustment);
}
public static final NamingProperty METHOD_IS_CALLED = new NamingProperty("CONFUSING_METHOD_IS_CALLED",
PriorityAdjustment.LOWER_PRIORITY);
public static final NamingProperty METHOD_IS_DEPRECATED = new NamingProperty("CONFUSING_METHOD_IS_DEPRECATED",
PriorityAdjustment.LOWER_PRIORITY);
}
String baseClassName;
boolean classIsPublicOrProtected;
public static @CheckForNull
XMethod definedIn(JavaClass clazz, XMethod m) {
for (Method m2 : clazz.getMethods())
if (m.getName().equals(m2.getName()) && m.getSignature().equals(m2.getSignature()) && m.isStatic() == m2.isStatic())
return XFactory.createXMethod(clazz, m2);
return null;
}
public static boolean confusingMethodNamesWrongCapitalization(XMethod m1, XMethod m2) {
if (m1.isStatic() != m2.isStatic())
return false;
if (m1.getClassName().equals(m2.getClassName()))
return false;
if (m1.getName().equals(m2.getName())) return false;
if (m1.getName().equalsIgnoreCase(m2.getName())
&& removePackageNamesFromSignature(m1.getSignature()).equals(removePackageNamesFromSignature(m2.getSignature())))
return true;
return false;
}
public static boolean confusingMethodNamesWrongPackage(XMethod m1, XMethod m2) {
if (m1.isStatic() != m2.isStatic())
return false;
if (m1.getClassName().equals(m2.getClassName()))
return false;
if (!m1.getName().equals(m2.getName()))
return false;
if (m1.getSignature().equals(m2.getSignature()))
return false;
if (removePackageNamesFromSignature(m1.getSignature()).equals(removePackageNamesFromSignature(m2.getSignature())))
return true;
return false;
}
// map of canonicalName -> trueMethodName
HashMap<String, HashSet<String>> canonicalToTrueMapping = new HashMap<String, HashSet<String>>();
// map of canonicalName -> Set<XMethod>
HashMap<String, HashSet<XMethod>> canonicalToXMethod = new HashMap<String, HashSet<XMethod>>();
HashSet<String> visited = new HashSet<String>();
private BugReporter bugReporter;
public Naming(BugReporter bugReporter) {
this.bugReporter = bugReporter;
}
public void visitClassContext(ClassContext classContext) {
classContext.getJavaClass().accept(this);
}
private boolean checkSuper(XMethod m, HashSet<XMethod> others) {
if (m.isStatic())
return false;
if (m.getName().equals("<init>") || m.getName().equals("<clinit>"))
return false;
for (XMethod m2 : others) {
try {
if ((confusingMethodNamesWrongCapitalization(m, m2) || confusingMethodNamesWrongPackage(m,m2))
&& Repository.instanceOf(m.getClassName(), m2.getClassName())) {
WarningPropertySet<NamingProperty> propertySet = new WarningPropertySet<NamingProperty>();
int priority = HIGH_PRIORITY;
XMethod m3 = null;
try {
JavaClass clazz = Repository.lookupClass(m.getClassName());
if ((m3 = definedIn(clazz, m2)) == null) {
// the method we don't override is also defined in our class
priority = NORMAL_PRIORITY;
}
if (m3 == null)
for (JavaClass s : clazz.getSuperClasses())
if ((m3 = definedIn(s, m)) != null) {
// the method we define is also defined in our superclass
priority = NORMAL_PRIORITY;
break;
}
if (m3 == null)
for (JavaClass i : clazz.getAllInterfaces())
if ((m3 = definedIn(i, m)) != null) {
priority = NORMAL_PRIORITY;
// the method we define is also defined in an interface
break;
}
} catch (ClassNotFoundException e) {
priority++;
AnalysisContext.reportMissingClass(e);
}
XFactory xFactory = AnalysisContext.currentXFactory();
if (m3 == null && xFactory.isCalled(m))
propertySet.addProperty(NamingProperty.METHOD_IS_CALLED);
else if (m.isDeprecated() || m2.isDeprecated())
propertySet.addProperty(NamingProperty.METHOD_IS_DEPRECATED);
priority = propertySet.computePriority(priority);
if (!m.getName().equals(m2.getName()) && m.getName().equalsIgnoreCase(m2.getName())) {
String pattern = m3 != null ? "NM_VERY_CONFUSING_INTENTIONAL" : "NM_VERY_CONFUSING";
BugInstance bug = new BugInstance(this, pattern, priority).addClass(m.getClassName()).addMethod(m)
.addClass(m2.getClassName()).addMethod(m2);
if (m3 != null)
bug.addMethod(m3);
propertySet.decorateBugInstance(bug);
bugReporter.reportBug(bug);
}
if (!m.getSignature().equals(m2.getSignature())
&& removePackageNamesFromSignature(m.getSignature()).equals(
removePackageNamesFromSignature(m2.getSignature()))) {
String pattern = m3 != null ? "NM_WRONG_PACKAGE_INTENTIONAL" : "NM_WRONG_PACKAGE";
Iterator<String> s = new SignatureParser(m.getSignature()).parameterSignatureIterator();
Iterator<String> s2 = new SignatureParser(m2.getSignature()).parameterSignatureIterator();
while (s.hasNext()) {
String p = s.next();
String p2 = s2.next();
if (!p.equals(p2)) {
BugInstance bug = new BugInstance(this, pattern, priority).addClass(m.getClassName())
.addMethod(m).addClass(m2.getClassName()).addMethod(m2).addFoundAndExpectedType(p, p2);
if (m3 != null)
bug.addMethod(m3);
propertySet.decorateBugInstance(bug);
bugReporter.reportBug(bug);
}
}
//
}
return true;
}
} catch (ClassNotFoundException e) {
AnalysisContext.reportMissingClass(e);
}
}
return false;
}
@SuppressWarnings("unchecked")
private boolean checkNonSuper(XMethod m, HashSet<XMethod> others) {
if (m.isStatic())
return false;
if (m.getName().startsWith("<init>") || m.getName().startsWith("<clinit>"))
return false;
for (XMethod m2 : others) {
if (confusingMethodNamesWrongCapitalization(m, m2)) {
XMethod mm1 = m;
XMethod mm2 = m2;
if (m.compareTo(m2) < 0) {
mm1 = m;
mm2 = m2;
} else {
mm1 = m2;
mm2 = m;
}
bugReporter.reportBug(new BugInstance(this, "NM_CONFUSING", LOW_PRIORITY).addClass(mm1.getClassName()).addMethod(
mm1).addClass(mm2.getClassName()).addMethod(mm2));
return true;
}
}
return false;
}
public void report() {
canonicalNameIterator: for (String allSmall : canonicalToTrueMapping.keySet()) {
HashSet<String> s = canonicalToTrueMapping.get(allSmall);
if (s.size() <= 1)
continue;
HashSet<XMethod> conflictingMethods = canonicalToXMethod.get(allSmall);
for (Iterator<XMethod> j = conflictingMethods.iterator(); j.hasNext();) {
if (checkSuper(j.next(), conflictingMethods))
j.remove();
}
for (XMethod conflictingMethod : conflictingMethods) {
if (checkNonSuper(conflictingMethod, conflictingMethods))
continue canonicalNameIterator;
}
}
}
public String stripPackageName(String className) {
if (className.indexOf('.') >= 0)
return className.substring(className.lastIndexOf('.') + 1);
else if (className.indexOf('/') >= 0)
return className.substring(className.lastIndexOf('/') + 1);
else
return className;
}
public boolean sameSimpleName(String class1, String class2) {
return class1 != null && class2 != null && stripPackageName(class1).equals(stripPackageName(class2));
}
@Override
public void visitJavaClass(JavaClass obj) {
String name = obj.getClassName();
if (!visited.add(name))
return;
String superClassName = obj.getSuperclassName();
if (!name.equals("java.lang.Object")) {
if (sameSimpleName(superClassName, name)) {
bugReporter.reportBug(new BugInstance(this, "NM_SAME_SIMPLE_NAME_AS_SUPERCLASS", HIGH_PRIORITY).addClass(name)
.addClass(superClassName));
}
for (String interfaceName : obj.getInterfaceNames())
if (sameSimpleName(interfaceName, name)) {
bugReporter.reportBug(new BugInstance(this, "NM_SAME_SIMPLE_NAME_AS_INTERFACE", NORMAL_PRIORITY).addClass(
name).addClass(interfaceName));
}
}
if (obj.isInterface())
return;
if (superClassName.equals("java.lang.Object") && !visited.contains(superClassName)) try {
visitJavaClass(obj.getSuperClass());
} catch (ClassNotFoundException e) {
// ignore it
}
super.visitJavaClass(obj);
}
/**
* Determine whether the class descriptor ultimately inherits from
* java.lang.Exception
* @param d class descriptor we want to check
* @return true iff the descriptor ultimately inherits from Exception
*/
private static boolean mightInheritFromException(ClassDescriptor d) {
while(d != null) {
try {
if("java.lang.Exception".equals(d.getDottedClassName())) {
return true;
}
XClass classNameAndInfo =
Global.getAnalysisCache().
getClassAnalysis(XClass.class, d);
d = classNameAndInfo.getSuperclassDescriptor();
} catch (CheckedAnalysisException e) {
return true; // don't know
}
}
return false;
}
boolean hasBadMethodNames;
@Override
public void visit(JavaClass obj) {
String name = obj.getClassName();
String[] parts = name.split("[$+.]");
baseClassName = parts[parts.length - 1];
for(String p : obj.getClassName().split("[.]")) if (p.length() == 1) return;
classIsPublicOrProtected = obj.isPublic() || obj.isProtected();
if (Character.isLetter(baseClassName.charAt(0)) && !Character.isUpperCase(baseClassName.charAt(0))
&& baseClassName.indexOf("_") == -1)
bugReporter.reportBug(new BugInstance(this, "NM_CLASS_NAMING_CONVENTION", classIsPublicOrProtected ? NORMAL_PRIORITY
: LOW_PRIORITY).addClass(this));
if (name.endsWith("Exception")) {
// Does it ultimately inherit from Throwable?
if(!mightInheritFromException(DescriptorFactory.createClassDescriptor(obj))) {
// It doens't, so the name is misleading
bugReporter.reportBug(new BugInstance(this, "NM_CLASS_NOT_EXCEPTION", NORMAL_PRIORITY).addClass(this));
}
}
int badNames = 0;
for(Method m : obj.getMethods())
if (badMethodName(m.getName())) badNames++;
hasBadMethodNames = badNames > 5 && badNames > obj.getMethods().length/2;
super.visit(obj);
}
@Override
public void visit(Field obj) {
if (getFieldName().length() == 1)
return;
if (!obj.isFinal() && Character.isLetter(getFieldName().charAt(0)) && !Character.isLowerCase(getFieldName().charAt(0))
&& getFieldName().indexOf("_") == -1 && Character.isLetter(getFieldName().charAt(1))
&& Character.isLowerCase(getFieldName().charAt(1))) {
bugReporter.reportBug(new BugInstance(this, "NM_FIELD_NAMING_CONVENTION", classIsPublicOrProtected
&& (obj.isPublic() || obj.isProtected()) ? NORMAL_PRIORITY : LOW_PRIORITY).addClass(this).addVisitedField(
this));
}
}
private final static Pattern sigType = Pattern.compile("L([^;]*/)?([^/]+;)");
private boolean isInnerClass(JavaClass obj) {
for (Field f : obj.getFields())
if (f.getName().startsWith("this$"))
return true;
return false;
}
private boolean markedAsNotUsable(Method obj) {
for (Attribute a : obj.getAttributes())
if (a instanceof Deprecated)
return true;
Code code = obj.getCode();
if (code == null)
return false;
byte[] codeBytes = code.getCode();
if (codeBytes.length > 1 && codeBytes.length < 10) {
int lastOpcode = codeBytes[codeBytes.length - 1] & 0xff;
if (lastOpcode != ATHROW)
return false;
for (int b : codeBytes)
if ((b & 0xff) == RETURN)
return false;
return true;
}
return false;
}
private static @CheckForNull
Method findVoidConstructor(JavaClass clazz) {
for (Method m : clazz.getMethods())
if (m.getName().equals("<init>") && m.getSignature().equals("()V"))
return m;
return null;
}
@Override
public void visit(Method obj) {
String mName = getMethodName();
if (mName.length() == 1)
return;
if (mName.equals("isRequestedSessionIdFromURL") || mName.equals("isRequestedSessionIdFromUrl"))
return;
if (badMethodName(mName))
bugReporter.reportBug(new BugInstance(this, "NM_METHOD_NAMING_CONVENTION", classIsPublicOrProtected
&& (obj.isPublic() || obj.isProtected()) && !hasBadMethodNames ? NORMAL_PRIORITY : LOW_PRIORITY).addClassAndMethod(this));
String sig = getMethodSig();
if (mName.equals(baseClassName) && sig.equals("()V")) {
Code code = obj.getCode();
Method realVoidConstructor = findVoidConstructor(getThisClass());
if (code != null && !markedAsNotUsable(obj)) {
int priority = NORMAL_PRIORITY;
if (codeDoesSomething(code))
priority--;
else if (!obj.isPublic() && getThisClass().isPublic())
priority--;
if (realVoidConstructor == null)
priority++;
bugReporter.reportBug(new BugInstance(this, "NM_METHOD_CONSTRUCTOR_CONFUSION", priority).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
}
if (obj.isAbstract())
return;
if (obj.isPrivate())
return;
if (mName.equals("equal") && sig.equals("(Ljava/lang/Object;)Z")) {
bugReporter.reportBug(new BugInstance(this, "NM_BAD_EQUAL", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (mName.equals("hashcode") && sig.equals("()I")) {
bugReporter.reportBug(new BugInstance(this, "NM_LCASE_HASHCODE", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (mName.equals("tostring") && sig.equals("()Ljava/lang/String;")) {
bugReporter.reportBug(new BugInstance(this, "NM_LCASE_TOSTRING", HIGH_PRIORITY).addClassAndMethod(this)
.lowerPriorityIfDeprecated());
return;
}
if (obj.isPrivate() || obj.isStatic() || mName.equals("<init>"))
return;
String trueName = mName + sig;
String sig2 = removePackageNamesFromSignature(sig);
String allSmall = mName.toLowerCase() + sig2;
XMethod xm = getXMethod();
{
HashSet<String> s = canonicalToTrueMapping.get(allSmall);
if (s == null) {
s = new HashSet<String>();
canonicalToTrueMapping.put(allSmall, s);
}
s.add(trueName);
}
{
HashSet<XMethod> s = canonicalToXMethod.get(allSmall);
if (s == null) {
s = new HashSet<XMethod>();
canonicalToXMethod.put(allSmall, s);
}
s.add(xm);
}
}
/**
* @param mName
* @return
*/
private boolean badMethodName(String mName) {
return Character.isLetter(mName.charAt(0)) && !Character.isLowerCase(mName.charAt(0)) && Character.isLetter(mName.charAt(1))
&& Character.isLowerCase(mName.charAt(1)) && mName.indexOf("_") == -1;
}
private boolean codeDoesSomething(Code code) {
byte[] codeBytes = code.getCode();
return codeBytes.length > 1;
}
private static String removePackageNamesFromSignature(String sig) {
int end = sig.indexOf(")");
Matcher m = sigType.matcher(sig.substring(0, end));
return m.replaceAll("L$2") + sig.substring(end);
}
}
| fix error on one character method names
also check for field naming weirdness
git-svn-id: e7d6bde23f017c9ff4efd468d79d66def666766b@10089 eae3c2d3-9b19-0410-a86e-396b6ccb6ab3
| findbugs/src/java/edu/umd/cs/findbugs/detect/Naming.java | fix error on one character method names also check for field naming weirdness | <ide><path>indbugs/src/java/edu/umd/cs/findbugs/detect/Naming.java
<ide>
<ide>
<ide> boolean hasBadMethodNames;
<add> boolean hasBadFieldNames;
<ide>
<ide> @Override
<ide> public void visit(JavaClass obj) {
<ide> }
<ide> }
<ide>
<add> int badFieldNames = 0;
<add> for(Field f : obj.getFields())
<add> if (f.getName().length() >= 2 && badFieldName(f)) badFieldNames++;
<add> hasBadFieldNames = badFieldNames > 5 && badFieldNames > obj.getFields().length/2;
<ide> int badNames = 0;
<ide> for(Method m : obj.getMethods())
<ide> if (badMethodName(m.getName())) badNames++;
<ide> if (getFieldName().length() == 1)
<ide> return;
<ide>
<del> if (!obj.isFinal() && Character.isLetter(getFieldName().charAt(0)) && !Character.isLowerCase(getFieldName().charAt(0))
<add> if (badFieldName(obj)) {
<add> bugReporter.reportBug(new BugInstance(this, "NM_FIELD_NAMING_CONVENTION", classIsPublicOrProtected
<add> && (obj.isPublic() || obj.isProtected()) && !hasBadFieldNames ? NORMAL_PRIORITY : LOW_PRIORITY).addClass(this).addVisitedField(
<add> this));
<add> }
<add> }
<add>
<add> /**
<add> * @param obj
<add> * @return
<add> */
<add> private boolean badFieldName(Field obj) {
<add> return !obj.isFinal() && Character.isLetter(getFieldName().charAt(0)) && !Character.isLowerCase(getFieldName().charAt(0))
<ide> && getFieldName().indexOf("_") == -1 && Character.isLetter(getFieldName().charAt(1))
<del> && Character.isLowerCase(getFieldName().charAt(1))) {
<del> bugReporter.reportBug(new BugInstance(this, "NM_FIELD_NAMING_CONVENTION", classIsPublicOrProtected
<del> && (obj.isPublic() || obj.isProtected()) ? NORMAL_PRIORITY : LOW_PRIORITY).addClass(this).addVisitedField(
<del> this));
<del> }
<del> }
<add> && Character.isLowerCase(getFieldName().charAt(1));
<add> }
<ide>
<ide> private final static Pattern sigType = Pattern.compile("L([^;]*/)?([^/]+;)");
<ide>
<ide> * @return
<ide> */
<ide> private boolean badMethodName(String mName) {
<del> return Character.isLetter(mName.charAt(0)) && !Character.isLowerCase(mName.charAt(0)) && Character.isLetter(mName.charAt(1))
<add> return mName.length() >= 2 && Character.isLetter(mName.charAt(0)) && !Character.isLowerCase(mName.charAt(0)) && Character.isLetter(mName.charAt(1))
<ide> && Character.isLowerCase(mName.charAt(1)) && mName.indexOf("_") == -1;
<ide> }
<ide> |
|
Java | mit | 62452ec38c15f3a6da85a7d702dc1261afe39397 | 0 | university-information-system/uis,university-information-system/uis,university-information-system/uis,university-information-system/uis | package at.ac.tuwien.inso.initializer;
import at.ac.tuwien.inso.entity.*;
import at.ac.tuwien.inso.repository.*;
import at.ac.tuwien.inso.service.student_subject_prefs.StudentSubjectPreferenceStore;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
import static java.util.Arrays.asList;
@Component
public class DataInitializer {
@Autowired
private CourseRepository courseRepository;
@Autowired
private UserAccountRepository userAccountRepository;
@Autowired
private UisUserRepository uisUserRepository;
@Autowired
private SubjectRepository subjectRepository;
@Autowired
private SemesterRepository semesterRepository;
@Autowired
private StudyPlanRepository studyPlanRepository;
@Autowired
private SubjectForStudyPlanRepository subjectForStudyPlanRepository;
@Autowired
private TagRepository tagRepository;
@Autowired
private PendingAccountActivationRepository pendingAccountActivationRepository;
@Autowired
private GradeRepository gradeRepository;
@Autowired
private StudentRepository studentRepository;
@Autowired
private FeedbackRepository feedbackRepository;
@Autowired
private StudentSubjectPreferenceStore studentSubjectPreferenceStore;
private List<StudyPlan> studyplans;
private List<Semester> semesters;
private List<Subject> subjects;
private List<Course> courses;
private List<Student> students;
private List<Lecturer> lecturers;
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1 = new HashMap<String, Subject>() {
{
put("VU Programmkonstruktion", new Subject("VU Programmkonstruktion", new BigDecimal(8.8)));
put("UE Studieneingangsgespräch", new Subject("UE Studieneingangsgespräch", new BigDecimal(0.2)));
put("VU Technische Grundlagen der Informatik", new Subject("VU Technische Grundlagen der Informatik", new BigDecimal(6.0)));
put("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new Subject("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new BigDecimal(4.0)));
put("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new Subject("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new BigDecimal(5.0)));
put("VU Formale Modellierung", new Subject("VU Formale Modellierung", new BigDecimal(3.0)));
put("VU Datenmodellierung", new Subject("VU Datenmodellierung", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2 = new HashMap<String, Subject>() {
{
put("VU Algorithmen und Datenstrukturen 1", new Subject("VU Algorithmen und Datenstrukturen 1", new BigDecimal(6.0)));
put("VU Algorithmen und Datenstrukturen 2", new Subject("VU Algorithmen und Datenstrukturen 2", new BigDecimal(3.0)));
put("VU Einführung in Visual Computing", new Subject("VU Einführung in Visual Computing", new BigDecimal(6.0)));
put("VU Gesellschaftliche Spannungsfelder der Informatik", new Subject("VU Gesellschaftliche Spannungsfelder der Informatik", new BigDecimal(3.0)));
put("VU Basics of Human Computer Interaction", new Subject("VU Basics of Human Computer Interaction", new BigDecimal(3.0)));
put("VO Analysis für Informatik und Wirtschaftsinformatik", new Subject("VO Analysis für Informatik und Wirtschaftsinformatik", new BigDecimal(2.0)));
put("UE Analysis für Informatik und Wirtschaftsinformatik", new Subject("UE Analysis für Informatik und Wirtschaftsinformatik", new BigDecimal(4.0)));
put("VU Objektorientierte Modellierung", new Subject("VU Objektorientierte Modellierung", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3 = new HashMap<String, Subject>() {
{
put("VU Objektorientierte Programmiertechniken", new Subject("VU Objektorientierte Programmiertechniken", new BigDecimal(3.0)));
put("VU Funktionale Programmierung", new Subject("VU Funktionale Programmierung", new BigDecimal(3.0)));
put("VO Betriebssysteme", new Subject("VO Betriebssysteme", new BigDecimal(2.0)));
put("UE Betriebssysteme", new Subject("UE Betriebssysteme", new BigDecimal(4.0)));
put("VU Introduction to Security", new Subject("VU Introduction to Security", new BigDecimal(3.0)));
put("VU Daten- und Informatikrecht", new Subject("VU Daten- und Informatikrecht", new BigDecimal(3.0)));
put("VU Datenbanksysteme", new Subject("VU Datenbanksysteme", new BigDecimal(6.0)));
put("VO Statistik und Wahrscheinlichkeitstheorie", new Subject("VO Statistik und Wahrscheinlichkeitstheorie", new BigDecimal(3.0)));
put("UE Statistik und Wahrscheinlichkeitstheorie", new Subject("UE Statistik und Wahrscheinlichkeitstheorie", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4 = new HashMap<String, Subject>() {
{
put("VU Einführung in die Künstliche Intelligenz", new Subject("VU Einführung in die Künstliche Intelligenz", new BigDecimal(3.0)));
put("VU Theoretische Informatik und Logik", new Subject("VU Theoretische Informatik und Logik", new BigDecimal(6.0)));
put("VO Software Engineering und Projektmanagement", new Subject("VO Software Engineering und Projektmanagement", new BigDecimal(3.0)));
put("PR Software Engineering und Projektmanagement", new Subject("PR Software Engineering und Projektmanagement", new BigDecimal(6.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5 = new HashMap<String, Subject>() {
{
put("VO Verteilte Systeme", new Subject("VO Verteilte Systeme", new BigDecimal(3.0)));
put("UE Verteilte Systeme", new Subject("UE Verteilte Systeme", new BigDecimal(3.0)));
put("VU Gesellschaftswissenschaftliche Grundlagen der Informatik", new Subject("VU Gesellschaftswissenschaftliche Grundlagen der Informatik", new BigDecimal(3.0)));
put("VU Interface and Interaction Design", new Subject("VU Interface and Interaction Design", new BigDecimal(3.0)));
put("VU Einführung in wissensbasierte Systeme", new Subject("VU Einführung in wissensbasierte Systeme", new BigDecimal(3.0)));
put("SE Wissenschaftliches Arbeiten", new Subject("SE Wissenschaftliches Arbeiten", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6 = new HashMap<String, Subject>() {
{
put("PR Bachelorarbeit für Informatik und Wirtschaftsinformatik", new Subject("PR Bachelorarbeit für Informatik und Wirtschaftsinformatik", new BigDecimal(10.0)));
}
};
private Map<String, Subject> subjectsOptionalBachelorSoftwareAndInformationEngineering = new HashMap<String, Subject>() {
{
put("VU Propädeutikum für Informatik", new Subject("VU Propädeutikum für Informatik", new BigDecimal(6.0)));
put("VO Deklaratives Problemlösen", new Subject("VO Deklaratives Problemlösen", new BigDecimal(3.0)));
put("UE Deklaratives Problemlösen", new Subject("UE Deklaratives Problemlösen", new BigDecimal(3.0)));
put("VU Logikprogrammierung und Constraints", new Subject("VU Logikprogrammierung und Constraints", new BigDecimal(6.0)));
put("VO Abstrakte Maschinen", new Subject("VO Abstrakte Maschinen", new BigDecimal(3.0)));
put("UE Abstrakte Maschinen", new Subject("UE Abstrakte Maschinen", new BigDecimal(3.0)));
put("VU Microcontroller", new Subject("VU Microcontroller", new BigDecimal(7.0)));
put("UE Programmierung von Betriebssystemen", new Subject("UE Programmierung von Betriebssystemen", new BigDecimal(3.0)));
put("VU Übersetzerbau", new Subject("VU Übersetzerbau", new BigDecimal(6.0)));
put("VO Echtzeitsysteme", new Subject("VO Echtzeitsysteme", new BigDecimal(2.0)));
put("VU Dependable Systems", new Subject("VU Dependable Systems", new BigDecimal(4.0)));
put("VU Internet Security", new Subject("VU Internet Security", new BigDecimal(3.0)));
put("VU Internet Security", new Subject("VU Internet Security", new BigDecimal(3.0)));
put("VU Privacy Enhancing Technology", new Subject("VU Privacy Enhancing Technology", new BigDecimal(3.0)));
put("UE Daten- und Informatikrecht", new Subject("UE Daten- und Informatikrecht", new BigDecimal(3.0)));
put("VU Vertrags- und Haftungsrecht", new Subject("VU Vertrags- und Haftungsrecht", new BigDecimal(3.0)));
put("VU Semistrukturierte Daten", new Subject("VU Semistrukturierte Daten", new BigDecimal(3.0)));
put("VU Web Engineering", new Subject("VU Web Engineering", new BigDecimal(4.5)));
put("VU Computerstatistik", new Subject("VU Computerstatistik", new BigDecimal(3.0)));
put("VU Datenanalyse", new Subject("VU Datenanalyse", new BigDecimal(3.0)));
put("VU Statistical Computing", new Subject("VU Statistical Computing", new BigDecimal(3.0)));
put("VO Logik für Wissensrepräsentation", new Subject("VO Logik für Wissensrepräsentation", new BigDecimal(3.0)));
put("UE Logik für Wissensrepräsentation", new Subject("UE Logik für Wissensrepräsentation", new BigDecimal(3.0)));
put("VO Computernumerik", new Subject("VO Computernumerik", new BigDecimal(3.0)));
put("UE Computernumerik", new Subject("UE Computernumerik", new BigDecimal(1.5)));
put("VO Multivariate Statistik", new Subject("VO Multivariate Statistik", new BigDecimal(4.5)));
put("UE Multivariate Statistik", new Subject("UE Multivariate Statistik", new BigDecimal(1.5)));
put("VU Statistische Simulation und computerintensive Methoden", new Subject("VU Statistische Simulation und computerintensive Methoden", new BigDecimal(3.0)));
put("VU Argumentieren und Beweisen", new Subject("VU Argumentieren und Beweisen", new BigDecimal(6.0)));
put("VU Programm- und Systemverifikation", new Subject("VU Programm- und Systemverifikation", new BigDecimal(6.0)));
put("VU Softwareprojekt-Beobachtung und -Controlling", new Subject("VU Softwareprojekt-Beobachtung und -Controlling", new BigDecimal(6.0)));
put("VU Software-Qualitätssicherung", new Subject("VU Software-Qualitätssicherung", new BigDecimal(6.0)));
put("VU Usability Engineering", new Subject("VU Usability Engineering", new BigDecimal(3.0)));
put("SE Coaching als Führungsinstrument 2", new Subject("SE Coaching als Führungsinstrument 2", new BigDecimal(3.0)));
put("SE Didaktik in der Informatik", new Subject("SE Didaktik in der Informatik", new BigDecimal(3.0)));
put("VO EDV-Vertragsrecht", new Subject("VO EDV-Vertragsrecht", new BigDecimal(1.5)));
put("VO Einführung in Technik und Gesellschaft", new Subject("VO Einführung in Technik und Gesellschaft", new BigDecimal(3.0)));
put("SE Folgenabschätzung von Informationstechnologien", new Subject("SE Folgenabschätzung von Informationstechnologien", new BigDecimal(3.0)));
put("VU Forschungsmethoden", new Subject("VU Forschungsmethoden", new BigDecimal(3.0)));
put("VU Kommunikation und Moderation", new Subject("VU Kommunikation und Moderation", new BigDecimal(3.0)));
put("VU Kooperatives Arbeiten", new Subject("VU Kooperatives Arbeiten", new BigDecimal(3.0)));
put("SE Rechtsinformationsrecherche im Internet", new Subject("SE Rechtsinformationsrecherche im Internet", new BigDecimal(3.0)));
put("VU Softskills für TechnikerInnen", new Subject("VU Softskills für TechnikerInnen", new BigDecimal(3.0)));
put("VU Techniksoziologie und Technikpsychologie", new Subject("VU Techniksoziologie und Technikpsychologie", new BigDecimal(3.0)));
put("VO Theorie und Praxis der Gruppenarbeit", new Subject("VO Theorie und Praxis der Gruppenarbeit", new BigDecimal(3.0)));
put("SE Wissenschaftliche Methodik", new Subject("SE Wissenschaftliche Methodik", new BigDecimal(3.0)));
put("SE Scientific Presentation and Communication", new Subject("SE Scientific Presentation and Communication", new BigDecimal(3.0)));
put("PV Privatissimum aus Fachdidaktik Informatik", new Subject("PV Privatissimum aus Fachdidaktik Informatik", new BigDecimal(4.0)));
put("VU Präsentation und Moderation", new Subject("VU Präsentation und Moderation", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsFreeChoiceInformatics = new HashMap<String, Subject>() {{
put("VU Pilots in Mobile Interaction: User-centered Interaction Research and Evaluation", new Subject("VU Pilots in Mobile Interaction: User-centered Interaction Research and Evaluation", new BigDecimal(3.0)));
put("VU Robotik für RoboCup", new Subject("VU Robotik für RoboCup", new BigDecimal(6.0)));
put("KO Reflections on ICTs and Society", new Subject("KO Reflections on ICTs and Society", new BigDecimal(6.0)));
put("VU Science of Information 1: Transdisciplinary Foundations of Informatics", new Subject("VU Science of Information 1: Transdisciplinary Foundations of Informatics", new BigDecimal(3.0)));
put("VU Parallel Computing", new Subject("VU Parallel Computing", new BigDecimal(6.0)));
put("PR Praktikum aus IT-Security", new Subject("PR Praktikum aus IT-Security", new BigDecimal(6.0)));
put("SE Formale Semantik natürlicher Sprache", new Subject("SE Formale Semantik natürlicher Sprache", new BigDecimal(3.0)));
put("VO Ausgewählte Kapitel der Technischen Informatik", new Subject("VO Ausgewählte Kapitel der Technischen Informatik", new BigDecimal(3.0)));
put("SE Seminar für DiplomandInnen", new Subject("SE Seminar für DiplomandInnen", new BigDecimal(2.0)));
put("SE Computer Vision Seminar für DiplomandInnen", new Subject("SE Computer Vision Seminar für DiplomandInnen", new BigDecimal(2.0)));
put("VU Softwaretechische Konzepte und Infrastrukturtechnologien zur Identifikation von Objekten und Geräten: RFID, Smartcards, NFC und Mobile Phones", new Subject("VU Softwaretechische Konzepte und Infrastrukturtechnologien zur Identifikation von Objekten und Geräten: RFID, Smartcards, NFC und Mobile Phones", new BigDecimal(3.0)));
put("VU Advanced Services Engineering", new Subject("VU Advanced Services Engineering", new BigDecimal(3.0)));
put("SE Forschungsseminar für DiplomandInnen", new Subject("SE Forschungsseminar für DiplomandInnen", new BigDecimal(3.0)));
put("VO Finanzmärkte, Finanzintermediation und Kapitalanlage", new Subject("VO Finanzmärkte, Finanzintermediation und Kapitalanlage", new BigDecimal(3.5)));
put("VU Methodisches, industrielles Software-Engineering mit Funktionalen Sprachen am Fallbeispiel Haskell", new Subject("VU Methodisches, industrielles Software-Engineering mit Funktionalen Sprachen am Fallbeispiel Haskell", new BigDecimal(3.0)));
put("VU IT Governance", new Subject("VU IT Governance", new BigDecimal(3.0)));
put("VU Current Trends in Computer Science", new Subject("VU Current Trends in Computer Science", new BigDecimal(3.0)));
put("VU Programmierung von Strategie-Spielen", new Subject("VU Programmierung von Strategie-Spielen", new BigDecimal(3.0)));
put("VU Medienanalyse und Medienreflexion", new Subject("VU Medienanalyse und Medienreflexion", new BigDecimal(3.0)));
put("EX Exkursion", new Subject("EX Exkursion", new BigDecimal(3.0)));
put("VU Privacy Enhancing Technologies", new Subject("VU Privacy Enhancing Technologies", new BigDecimal(3.0)));
put("VU Theoretische Informatik und Logik für CI", new Subject("VU Theoretische Informatik und Logik für CI", new BigDecimal(6.0)));
put("SE Theorie und Praxis der Evaluierung von innovativen User Interfaces", new Subject("SE Theorie und Praxis der Evaluierung von innovativen User Interfaces", new BigDecimal(3.0)));
put("VU Brückenkurs Programmierung für Studienanfängerinnen", new Subject("VU Brückenkurs Programmierung für Studienanfängerinnen", new BigDecimal(3.0)));
put("VU Mobile (App) Software Engineering", new Subject("VU Mobile (App) Software Engineering", new BigDecimal(3.0)));
put("VU Runtime Verification", new Subject("VU Runtime Verification", new BigDecimal(3.0)));
put("VU 2D and 3D Image Registration", new Subject("VU 2D and 3D Image Registration", new BigDecimal(3.0)));
put("VU Mobile Robotik", new Subject("VU Mobile Robotik", new BigDecimal(4.5)));
put("SE Critical Algorithm Studies", new Subject("SE Critical Algorithm Studies", new BigDecimal(3.0)));
put("VU Brückenkurs Programmierung für Studienanfänger", new Subject("", new BigDecimal(0.0)));
}};
private Map<String, Subject> subjectsBachelorSoftwareAndInformationEngineering;
private Map<String, Course> coursesBachelorSoftwareAndInformationEngineering;
private Map<String, Tag> tags = new HashMap<String, Tag>() {{
put("Programmieren", new Tag("Programmieren"));
put("Java", new Tag("Java"));
put("Debug", new Tag("Debug"));
put("Rekursion", new Tag("Rekursion"));
put("Boolsche Algebra", new Tag("Boolsche Algebra"));
put("RISC", new Tag("RISC"));
put("CISC", new Tag("CISC"));
put("Pipelining", new Tag("Pipelining"));
put("ROM", new Tag("ROM"));
put("PROM/EPROM", new Tag("PROM/EPROM"));
put("2 Complement", new Tag("2 Complement"));
put("1 Complement", new Tag("1 Complement"));
put("Gatterschaltungen", new Tag("Gatterschaltungen"));
put("Befehlssatz", new Tag("Befehlssatz"));
put("Digital", new Tag("Digital"));
put("Zahlentheorie", new Tag("Zahlentheorie"));
put("Aussagenlogik", new Tag("Aussagenlogik"));
put("Mengenlehre", new Tag("Mengenlehre"));
put("Kombinatorik,", new Tag("Kombinatorik,"));
put("Differenzengleichungen", new Tag("Differenzengleichungen"));
put("Graphentheorie", new Tag("Graphentheorie"));
put("Algebraische Strukturen", new Tag("Algebraische Strukturen"));
put("Lineare Algebra", new Tag("Lineare Algebra"));
put("Codierungstheorie", new Tag("Codierungstheorie"));
put("UE", new Tag("UE"));
put("VU", new Tag("VU"));
put("VO", new Tag("VO"));
put("Automaten", new Tag("Automaten"));
put("reguläre Ausdrücke", new Tag("reguläre Ausdrücke"));
put("Grammatiken", new Tag("Grammatiken"));
put("Petri-Netze", new Tag("Petri-Netze"));
put("Prädikatenlogik", new Tag("Prädikatenlogik"));
put("EER", new Tag("EER"));
put("Relationenmodel", new Tag("Relationenmodel"));
put("Domänenkalkül", new Tag("Domänenkalkül"));
put("Datenbanksprachen", new Tag("Datenbanksprachen"));
put("Relationale Entwurfstheorie", new Tag("Relationale Entwurfstheorie"));
put("Normalformen", new Tag("Normalformen"));
put("Datenintegrität", new Tag("Datenintegrität"));
put("SQL", new Tag("SQL"));
put("JDBC", new Tag("JDBC"));
put("DBMS", new Tag("DBMS"));
put("Algorithmen", new Tag("Algorithmen"));
put("Datenstrukturen", new Tag("Datenstrukturen"));
put("Visual Computing", new Tag("Visual Computing"));
put("MATLAB", new Tag("MATLAB"));
put("Fourier", new Tag("Fourier"));
put("Analysis", new Tag("Analysis"));
put("Langweilig", new Tag("Langweilig"));
put("Theorie", new Tag("Theorie"));
put("Praxis", new Tag("Praxis"));
put("Gesellschaft", new Tag("Gesellschaft"));
put("Human Computer Interaction", new Tag("Human Computer Interaction"));
put("Laplace", new Tag("Laplace"));
put("Laplace", new Tag("Laplace"));
put("Folgen", new Tag("Folgen"));
put("Reihen", new Tag("Reihen"));
put("Stetigkeit", new Tag("Stetigkeit"));
put("Grenzwerte", new Tag("Grenzwerte"));
put("Nullstellen", new Tag("Nullstellen"));
put("Differentialrechnung", new Tag("Differentialrechnung"));
put("Funktionen", new Tag("Funktionen"));
put("Integralrechnung", new Tag("Integralrechnung"));
put("Objektorientiert", new Tag("Objektorientiert"));
put("UML", new Tag("UML"));
put("Grundlagen", new Tag("Grundlagen"));
put("Hardware", new Tag("Hardware"));
put("Software", new Tag("Software"));
put("Computer Science", new Tag("Computer Science"));
put("Mathe", new Tag("Mathe"));
put("Spaß", new Tag("Spaß"));
put("Einfach", new Tag("Einfach"));
put("Diffizil", new Tag("Diffizil"));
put("Programmiersprachen", new Tag("Programmiersprachen"));
put("Gruppenarbeit", new Tag("Gruppenarbeit"));
put("Abstraktion", new Tag("Abstraktion"));
put("Teamfaehigkeit", new Tag("Teamfaehigkeit"));
put("Generizität", new Tag("Generizität"));
put("Haskell", new Tag("Haskell"));
put("Funktional", new Tag("Funktional"));
put("Lambda-Kalkuel", new Tag("Lambda-Kalkuel"));
put("Thread", new Tag("Thread"));
put("Prozes", new Tag("Prozes"));
put("Synchronisation", new Tag("Synchronisation"));
put("Betriebssystem", new Tag("Betriebssystem"));
put("C", new Tag("C"));
put("Scheduling", new Tag("Scheduling"));
put("Multithreading", new Tag("Multithreading"));
put("Deadlock", new Tag("Deadlock"));
put("Semaphore", new Tag("Semaphore"));
put("Sequencer", new Tag("Sequencer"));
put("Eventcounts", new Tag("Eventcounts"));
put("Producer-Consumer", new Tag("Producer-Consumer"));
put("Speicherverwaltung", new Tag("Speicherverwaltung"));
put("Filesysteme", new Tag("Filesysteme"));
put("Netzwerke", new Tag("Netzwerke"));
put("Security", new Tag("Security"));
put("Eventcounts", new Tag("Eventcounts"));
put("Social engineering", new Tag("Social engineering"));
put("Physical Break-Ins", new Tag("Physical Break-Ins"));
put("Dumpster Diving", new Tag("Dumpster Diving"));
put("Password Cracking", new Tag("Password Cracking"));
put("Session Hijacking", new Tag("Session Hijacking"));
put("Spoofing", new Tag("Spoofing"));
put("Viruses", new Tag("Viruses"));
put("Worms", new Tag("Worms"));
put("Trojan Horses", new Tag("Trojan Horses"));
put("Phishing", new Tag("Phishing"));
put("Encryption", new Tag("Encryption"));
put("Spyware", new Tag("Spyware"));
put("Phishing", new Tag("Phishing"));
put("Spyware", new Tag("Spyware"));
put("Adware", new Tag("Adware"));
put("Cryptography", new Tag("Cryptography"));
put("Risk Analysis", new Tag("Risk Analysis"));
put("Recht", new Tag("Recht"));
put("Wirtschaft", new Tag("Wirtschaft"));
put("Technik", new Tag("Technik"));
put("Statistik", new Tag("Statistik"));
put("Wahrscheinlichkeitstheorie", new Tag("Wahrscheinlichkeitstheorie"));
put("Verteilung", new Tag("Verteilung"));
put("Histogramm", new Tag("Histogramm"));
put("Grundlagen der Bayes'schen", new Tag("Grundlagen der Bayes'schen"));
put("Wahrscheinlichkeitsraeume", new Tag("Wahrscheinlichkeitsraeume"));
put("Stochastik", new Tag("Stochastik"));
put("Gesetz der großen Zahlen", new Tag("Gesetz der großen Zahlen"));
put("Künstliche Intelligenz", new Tag("Künstliche Intelligenz"));
put("Projektmanagement", new Tag("Projektmanagement"));
put("Planning", new Tag("Planning"));
put("Testing", new Tag("Testing"));
put("Softwarequalitätssicherung", new Tag("Softwarequalitätssicherung"));
put("Risikomanagement", new Tag("Risikomanagement"));
put("Qualitätsmanagement", new Tag("Qualitätsmanagement"));
put("Projektmarketing", new Tag("Projektmarketing"));
put("Risikomanagement", new Tag("Risikomanagement"));
put("Sprint", new Tag("Sprint"));
put("SCRUM", new Tag("SCRUM"));
put("PR", new Tag("PR"));
}};
private Map<String, Student> studentMap = new HashMap<String, Student>() {
{
put("Caroline Black", new Student("s1123960", "Caroline Black", "[email protected]", new UserAccount("student", "pass", Role.STUDENT)));
put("Emma Dowd", new Student("s1127157", "Emma Dowd", "[email protected]", new UserAccount("emma", "pass", Role.STUDENT)));
put("John Terry", new Student("s1126441", "John Terry", "[email protected]", new UserAccount("john", "pass", Role.STUDENT)));
put("Joan Watson", new Student("s0227157", "Joan Watson", "[email protected]"));
put("James Bond", new Student("s1527199", "James Bond", "[email protected]"));
put("Trevor Bond", new Student("s0445157", "Trevor Bond", "[email protected]"));
}
};
private Map<String, Lecturer> lecturerMap = new HashMap<String, Lecturer>() {
{
put("Carol Sanderson", new Lecturer("l0100010", "Carol Sanderson", "[email protected]"));
put("Una Walker", new Lecturer("l0100011", "Una Walker", "[email protected]", new UserAccount("lecturer", "pass", Role.LECTURER)));
put("Connor MacLeod", new Lecturer("l0203019", "Connor MacLeod", "[email protected]"));
put("Eric Wilkins", new Lecturer("l1100010", "Eric Wilkins", "[email protected]", new UserAccount("eric", "pass", Role.LECTURER)));
put("Benjamin Piper", new Lecturer("l9123410", "Benjamin Piper", "[email protected]", new UserAccount("ben", "pass", Role.LECTURER)));
}
};
@Transactional
public void initialize() {
userAccountRepository.save(new UserAccount("admin", "pass", Role.ADMIN));
createTags();
createSubjects();
createSemesters();
createCourses();
createStudyPlans();
createUsers();
registerStudentsToStudyPlans();
addPreconditionsToSubjects();
registerSubjectsToLecturers();
addTagsToCourses();
addSubjectsToStudyPlans();
registerCoursesToStudents();
giveGrades();
giveFeedback();
}
private void createTags() {
tagRepository.save(tags.values());
}
private void createSubjects() {
createSubjectsBachelorSoftwareAndInformationEngineering();
Iterable<Subject> subjects = subjectRepository.save(subjectsBachelorSoftwareAndInformationEngineering.values());
this.subjects = StreamSupport.stream(subjects.spliterator(), false).collect(Collectors.toList());
}
private void createSubjectsBachelorSoftwareAndInformationEngineering() {
subjectsBachelorSoftwareAndInformationEngineering = new HashMap<>();
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsOptionalBachelorSoftwareAndInformationEngineering);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsFreeChoiceInformatics);
}
private void createSemesters() {
Iterable<Semester> semesters = semesterRepository.save(asList(
new Semester(2016, SemesterType.SummerSemester),
new Semester(2016, SemesterType.WinterSemester)
));
this.semesters = StreamSupport.stream(semesters.spliterator(), false).collect(Collectors.toList());
}
private void createCourses() {
createCoursesBachelorSoftwareAndInformationEngineering();
Iterable<Course> courses = courseRepository.save(coursesBachelorSoftwareAndInformationEngineering.values());
this.courses = StreamSupport.stream(courses.spliterator(), false).collect(Collectors.toList());
}
private void createCoursesBachelorSoftwareAndInformationEngineering() {
coursesBachelorSoftwareAndInformationEngineering = new HashMap<>();
for (String subjectName : subjectsBachelorSoftwareAndInformationEngineering.keySet()) {
coursesBachelorSoftwareAndInformationEngineering.put(
subjectName,
new Course(subjectsBachelorSoftwareAndInformationEngineering.get(subjectName), semesters.get(1)).setStudentLimits(20)
);
}
}
private void createStudyPlans() {
Iterable<StudyPlan> studyplans = studyPlanRepository.save(asList(
new StudyPlan("Bachelor Software and Information Engineering", new EctsDistribution(new BigDecimal(90), new BigDecimal(60), new BigDecimal(30))),
new StudyPlan("Master Business Informatics", new EctsDistribution(new BigDecimal(30), new BigDecimal(70), new BigDecimal(20))),
new StudyPlan("Master Computational Intelligence", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30))),
new StudyPlan("Master Visual Computing", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30))),
new StudyPlan("Master Medical Informatics", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30)), false),
new StudyPlan("Master Computer Science", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30)))
));
this.studyplans = StreamSupport.stream(studyplans.spliterator(), false).collect(Collectors.toList());
}
private void createUsers() {
pendingAccountActivationRepository.save(
new PendingAccountActivation("test", new Student("test", "Test User", "[email protected]"))
);
List<UisUser> usersList = new ArrayList<>(studentMap.values());
usersList.addAll(lecturerMap.values());
Iterable<UisUser> users = uisUserRepository.save(usersList);
students = StreamSupport.stream(users.spliterator(), false)
.filter(it -> it instanceof Student)
.map(it -> (Student) it)
.collect(Collectors.toList());
lecturers = StreamSupport.stream(users.spliterator(), false)
.filter(it -> it instanceof Lecturer)
.map(it -> (Lecturer) it)
.collect(Collectors.toList());
}
private void registerStudentsToStudyPlans() {
studentMap.get("John Terry").addStudyplans(new StudyPlanRegistration(studyplans.get(0), semesters.get(1)));
studentMap.get("Caroline Black").addStudyplans(new StudyPlanRegistration(studyplans.get(1), semesters.get(1)));
studentMap.get("Emma Dowd").addStudyplans(new StudyPlanRegistration(studyplans.get(2), semesters.get(0)));
studentMap.get("Joan Watson").addStudyplans(new StudyPlanRegistration(studyplans.get(3), semesters.get(1)));
studentMap.get("James Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(4), semesters.get(1)));
studentMap.get("James Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(5), semesters.get(0)));
studentMap.get("Trevor Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(1), semesters.get(1)));
}
private void addPreconditionsToSubjects() {
subjects.get(2).addRequiredSubjects(subjects.get(1));
}
private void registerSubjectsToLecturers() {
subjectsBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch").addLecturers(
lecturerMap.get("Carol Sanderson")
);
subjects.get(0).addLecturers(lecturers.get(3));
subjects.get(1).addLecturers(lecturers.get(3));
subjects.get(2).addLecturers(lecturers.get(3), lecturers.get(4));
subjectRepository.save(subjects);
Subject s = subjectsBachelorSoftwareAndInformationEngineering
.get("VU Technische Grundlagen der Informatik");
s.addLecturers(lecturers.get(3));
subjectRepository.save(s);
s = subjectsBachelorSoftwareAndInformationEngineering
.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik");
s.addLecturers(lecturers.get(3));
subjectRepository.save(s);
}
private void addTagsToCourses() {
addTagsToBachelorSoftwareAndInformationEngineeringCourses();
courseRepository.save(coursesBachelorSoftwareAndInformationEngineering.values());
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCourses() {
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1();
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester2();
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester3();
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester4();
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Programmkonstruktion").addTags(
tags.get("VU"), tags.get("Programmieren"), tags.get("Java"), tags.get("Debug"),
tags.get("Rekursion"), tags.get("Software"), tags.get("Einfach"), tags.get("Grundlagen"),
tags.get("Objektorientiert"), tags.get("Generizität")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik").addTags(
tags.get("VU"), tags.get("Boolsche Algebra"), tags.get("RISC"), tags.get("CISC"), tags.get("Pipelining"),
tags.get("ROM"), tags.get("PROM/EPROM"), tags.get("2 Complement"), tags.get("1 Complement"),
tags.get("Gatterschaltungen"), tags.get("Befehlssatz"), tags.get("Digital"), tags.get("Diffizil"), tags.get("Grundlagen"),
tags.get("Hardware")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik").addTags(
tags.get("VO"), tags.get("Zahlentheorie"), tags.get("Aussagenlogik"), tags.get("Mengenlehre"),
tags.get("Mathe"), tags.get("Kombinatorik"), tags.get("Differenzengleichungen"),
tags.get("Graphentheorie"), tags.get("Algebraische Strukturen"), tags.get("Lineare Algebra"),
tags.get("Codierungstheorie"), tags.get("Einfach"), tags.get("Funktionen"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik").addTags(
tags.get("UE"), tags.get("Zahlentheorie"), tags.get("Aussagenlogik"), tags.get("Mengenlehre"),
tags.get("Mathe"), tags.get("Kombinatorik"), tags.get("Differenzengleichungen"),
tags.get("Graphentheorie"), tags.get("Algebraische Strukturen"), tags.get("Lineare Algebra"),
tags.get("Codierungstheorie"), tags.get("Einfach"), tags.get("Funktionen"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Formale Modellierung").addTags(
tags.get("VU"), tags.get("Automaten"), tags.get("reguläre Ausdrücke"), tags.get("formale Grammatiken"),
tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Einfach"), tags.get("Grundlagen"),
tags.get("Lambda-Kalkuel")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung").addTags(
tags.get("VU"), tags.get("EER"), tags.get("Relationenmodel"), tags.get("Domänenkalkül"),
tags.get("Datenbanksprachen"), tags.get("Normalformen"), tags.get("Relationale Entwurfstheorie"),
tags.get("Datenintegrität"), tags.get("Einfach"), tags.get("SQL"), tags.get("Grundlagen")
);
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester2() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Algorithmen und Datenstrukturen 1").addTags(
tags.get("VU"), tags.get("Datenstrukturen"), tags.get("Algorithmen"), tags.get("Java"),
tags.get("Programmieren"), tags.get("Debug"), tags.get("Rekursion"),
tags.get("Software"), tags.get("Graphentheorie"), tags.get("Einfach")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Algorithmen und Datenstrukturen 2").addTags(
tags.get("VU"), tags.get("Datenstrukturen"), tags.get("Algorithmen"), tags.get("Java"),
tags.get("Programmieren"), tags.get("Debug"), tags.get("Rekursion"),
tags.get("Software"), tags.get("Graphentheorie"), tags.get("Diffizil")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Einführung in Visual Computing").addTags(
tags.get("VU"), tags.get("Visual Computing"), tags.get("MATLAB"), tags.get("Mathe"),
tags.get("Fourier"), tags.get("Analysis"), tags.get("Diffizil"), tags.get("Programmieren"),
tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Gesellschaftliche Spannungsfelder der Informatik").addTags(
tags.get("VU"), tags.get("Langweilig"), tags.get("Theorie"), tags.get("Einfach"),
tags.get("Gesellschaft")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Basics of Human Computer Interaction").addTags(
tags.get("VU"), tags.get("Human Computer Interaction"), tags.get("Einfach"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Analysis für Informatik und Wirtschaftsinformatik").addTags(
tags.get("VU"), tags.get("Mathe"), tags.get("Analysis"), tags.get("Fourier"),
tags.get("Laplace"), tags.get("Diffizil"), tags.get("Folgen"),
tags.get("Reihen"), tags.get("Stetigkeit"), tags.get("Grenzwerte"),
tags.get("Nullstellen"), tags.get("Differentialrechnung"),
tags.get("Integralrechnung"), tags.get("Funktionen")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Analysis für Informatik und Wirtschaftsinformatik").addTags(
tags.get("UE"), tags.get("Mathe"), tags.get("Analysis"), tags.get("Fourier"),
tags.get("Laplace"), tags.get("Diffizil"), tags.get("Folgen"),
tags.get("Reihen"), tags.get("Stetigkeit"), tags.get("Grenzwerte"),
tags.get("Nullstellen"), tags.get("Differentialrechnung"),
tags.get("Integralrechnung"), tags.get("Funktionen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Objektorientierte Modellierung").addTags(
tags.get("VU"), tags.get("Objektorientiert"), tags.get("UML"), tags.get("Grundlagen"),
tags.get("Einfach")
);
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester3() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Objektorientierte Programmiertechniken").addTags(
tags.get("VU"), tags.get("Objektorientiert"), tags.get("Programmiersprachen"),
tags.get("Programmieren"), tags.get("Java"),
tags.get("Debug"), tags.get("Software"), tags.get("Teamfaehigkeit"),
tags.get("Gruppenarbeit"), tags.get("Abstraktion"), tags.get("Diffizil"),
tags.get("Generizität"), tags.get("Theorie"), tags.get("Praxis")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Funktionale Programmierung").addTags(
tags.get("VU"), tags.get("Programmiersprachen"), tags.get("Programmieren"),
tags.get("Diffizil"), tags.get("Haskell"), tags.get("Debug"),
tags.get("Software"), tags.get("Teamfaehigkeit"),
tags.get("Gruppenarbeit"), tags.get("Haskell"), tags.get("Diffizil"),
tags.get("Funktional"), tags.get("Theorie"), tags.get("Praxis"),
tags.get("Grundlagen"), tags.get("Rekursion"), tags.get("Funktionen"),
tags.get("Lambda-Kalkuel")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Betriebssysteme").addTags(
tags.get("V0"), tags.get("Theorie"), tags.get("Thread"), tags.get("Prozess"),
tags.get("Synchronisation"), tags.get("Grundlagen"), tags.get("Betriebssystem"),
tags.get("Scheduling"), tags.get("Multithreading"), tags.get("Deadlock"),
tags.get("Datenstrukturen"), tags.get("Semaphore"), tags.get("Diffizil"),
tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("C"), tags.get("Client-Server")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Betriebssysteme").addTags(
tags.get("UE"), tags.get("Programmieren"), tags.get("Thread"), tags.get("Prozess"),
tags.get("Synchronisation"), tags.get("Grundlagen"), tags.get("Betriebssystem"),
tags.get("Scheduling"), tags.get("Multithreading"), tags.get("Deadlock"),
tags.get("Datenstrukturen"), tags.get("Semaphore"),
tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("Diffizil"), tags.get("C"),
tags.get("Client-Server")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Introduction to Security").addTags(
tags.get("VU"), tags.get("Programmieren"), tags.get("Social engineering"), tags.get("Physical Break-Ins"),
tags.get("Dumpster Diving"), tags.get("Grundlagen"), tags.get("Password Cracking"),
tags.get("Session Hijacking"), tags.get("Network"), tags.get("Spoofing"),
tags.get("Viruses"), tags.get("Worms"), tags.get("Trojan Horses"),
tags.get("Phishing"), tags.get("Encryption"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("Diffizil"),
tags.get("Spyware"), tags.get("Adware"), tags.get("Cryptography"),
tags.get("Risk Analysis")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Daten- und Informatikrecht").addTags(
tags.get("VU"), tags.get("Theorie"), tags.get("Recht"), tags.get("Einfach"),
tags.get("Grundlagen"), tags.get("Wirtschaft"), tags.get("Technik")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenbanksysteme").addTags(
tags.get("VU"), tags.get("EER"), tags.get("Relationenmodel"), tags.get("Domänenkalkül"),
tags.get("Datenbanksprachen"), tags.get("Normalformen"), tags.get("SQL"),
tags.get("Datenintegrität"), tags.get("Diffizil"), tags.get("JDBC"), tags.get("DBMS")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Statistik und Wahrscheinlichkeitstheorie").addTags(
tags.get("VO"), tags.get("Mathe"), tags.get("Statistik"), tags.get("Wahrscheinlichkeitstheorie"),
tags.get("Verteilung"), tags.get("Histogramm"), tags.get("Wahrscheinlichkeitsräume"),
tags.get("Stochastik"), tags.get("Grundlagen"), tags.get("Gesetz der großen Zahlen"),
tags.get("Grundlagen der Bayes'schen"), tags.get("Diffizil"), tags.get("Zahlentheorie"),
tags.get("Mengenlehre"), tags.get("Kombinatorik")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Statistik und Wahrscheinlichkeitstheorie").addTags(
tags.get("UE"), tags.get("Mathe"), tags.get("Statistik"), tags.get("Wahrscheinlichkeitstheorie"),
tags.get("Verteilung"), tags.get("Histogramm"), tags.get("Wahrscheinlichkeitsräume"),
tags.get("Stochastik"), tags.get("Grundlagen"), tags.get("Gesetz der großen Zahlen"),
tags.get("Grundlagen der Bayes'schen"), tags.get("Diffizil"), tags.get("Zahlentheorie"),
tags.get("Mengenlehre"), tags.get("Kombinatorik")
);
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester4() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Einführung in die Künstliche Intelligenz").addTags(
tags.get("VU"), tags.get("Künstliche Intelligenz"), tags.get("Grundlagen"),
tags.get("Programmieren"), tags.get("Theorie"), tags.get("Diffizil")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Theoretische Informatik und Logik").addTags(
tags.get("VU"), tags.get("Automaten"), tags.get("reguläre Ausdrücke"), tags.get("formale Grammatiken"),
tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Diffizil"),
tags.get("Lambda-Kalkuel"), tags.get("Logik")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Software Engineering und Projektmanagement").addTags(
tags.get("VO"), tags.get("Theorie"), tags.get("Software"), tags.get("Projektmanagement"),
tags.get("Planning"), tags.get("UML"), tags.get("Objektorientiert"), tags.get("Softwarequalitätssicherung"),
tags.get("Risikomanagement"), tags.get("Qualitätsmanagement"), tags.get("Projektmarketing"),
tags.get("Einfach"), tags.get("Sprint"), tags.get("SCRUM"), tags.get("SQL")
);
coursesBachelorSoftwareAndInformationEngineering.get("PR Software Engineering und Projektmanagement").addTags(
tags.get("PR"), tags.get("Programmieren"), tags.get("Testing"), tags.get("Software"),
tags.get("Projektmanagement"), tags.get("Gruppenarbeit"), tags.get("Teamfaehigkeit"),
tags.get("Debug"), tags.get("Planning"), tags.get("UML"), tags.get("Objektorientiert"),
tags.get("Softwarequalitätssicherung"), tags.get("Risikomanagement"), tags.get("Qualitätsmanagement"),
tags.get("Projektmarketing"), tags.get("Diffizil"), tags.get("Praxis"),
tags.get("Sprint"), tags.get("SCRUM"), tags.get("CRUD"), tags.get("SQL"), tags.get("UML")
);
}
private void addSubjectsToStudyPlans() {
addBachelorSoftwareAndInformationEngineeringSubjectsToStudyPlan();
}
private void addBachelorSoftwareAndInformationEngineeringSubjectsToStudyPlan() {
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1.get(subjectName), studyplans.get(0), true, 1)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2.get(subjectName), studyplans.get(0), true, 2)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3.get(subjectName), studyplans.get(0), true, 3)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4.get(subjectName), studyplans.get(0), true, 4)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5.get(subjectName), studyplans.get(0), true, 5)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6.get(subjectName), studyplans.get(0), true, 6)
);
}
for (String subjectName : subjectsOptionalBachelorSoftwareAndInformationEngineering.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsOptionalBachelorSoftwareAndInformationEngineering.get(subjectName), studyplans.get(0), false)
);
}
}
private void registerCoursesToStudents() {
// Joan Watson
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch"));
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
// Emma Dowd
register(studentMap.get("Emma Dowd"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
register(studentMap.get("Emma Dowd"), coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
// Caroline Black
register(studentMap.get("Caroline Black"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
// John Terry
Student john = studentMap.get("John Terry");
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung"));
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VU Programmkonstruktion"));
}
private void register(Student student, Course course) {
course.addStudents(student);
studentSubjectPreferenceStore.studentRegisteredCourse(student, course);
}
private void giveGrades() {
Course course = coursesBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch");
Student student = course.getStudents().get(0);
Lecturer lecturer = course.getSubject().getLecturers().get(0);
Grade grade = new Grade(course, lecturer, student, Mark.EXCELLENT);
gradeRepository.save(grade);
course = coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik");
student = studentMap.get("Emma Dowd");
lecturer = course.getSubject().getLecturers().get(0);
grade = new Grade(course, lecturer, student, Mark.EXCELLENT);
gradeRepository.save(grade);
course = coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik");
student = studentMap.get("Emma Dowd");
lecturer = course.getSubject().getLecturers().get(0);
grade = new Grade(course, lecturer, student, Mark.FAILED);
gradeRepository.save(grade);
grade = new Grade(
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung"),
lecturer,
studentMap.get("John Terry"),
Mark.EXCELLENT);
gradeRepository.save(grade);
}
private void giveFeedback() {
Course course = coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung");
Student johnTerry = studentMap.get("John Terry");
Feedback feedback = new Feedback(johnTerry, course);
course = coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik");
Student joanWatson = studentMap.get("Joan Watson");
Student emmaDowd = studentMap.get("Emma Dowd");
Student carolineBlack = studentMap.get("Caroline Black");
Feedback feedback1 = new Feedback(
joanWatson,
course,
Feedback.Type.LIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
Feedback feedback2 = new Feedback(
emmaDowd,
course,
Feedback.Type.DISLIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
Feedback feedback3 = new Feedback(
carolineBlack,
course,
Feedback.Type.LIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
giveFeedback(feedback, feedback1, feedback2, feedback3);
}
private void giveFeedback(Feedback... feedbacks) {
for (Feedback feedback : feedbacks) {
feedbackRepository.save(feedback);
studentSubjectPreferenceStore.studentGaveCourseFeedback(feedback.getStudent(), feedback);
}
}
}
| src/main/java/at/ac/tuwien/inso/initializer/DataInitializer.java | package at.ac.tuwien.inso.initializer;
import at.ac.tuwien.inso.entity.*;
import at.ac.tuwien.inso.repository.*;
import at.ac.tuwien.inso.service.student_subject_prefs.StudentSubjectPreferenceStore;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
import static java.util.Arrays.asList;
@Component
public class DataInitializer {
@Autowired
private CourseRepository courseRepository;
@Autowired
private UserAccountRepository userAccountRepository;
@Autowired
private UisUserRepository uisUserRepository;
@Autowired
private SubjectRepository subjectRepository;
@Autowired
private SemesterRepository semesterRepository;
@Autowired
private StudyPlanRepository studyPlanRepository;
@Autowired
private SubjectForStudyPlanRepository subjectForStudyPlanRepository;
@Autowired
private TagRepository tagRepository;
@Autowired
private PendingAccountActivationRepository pendingAccountActivationRepository;
@Autowired
private GradeRepository gradeRepository;
@Autowired
private StudentRepository studentRepository;
@Autowired
private FeedbackRepository feedbackRepository;
@Autowired
private StudentSubjectPreferenceStore studentSubjectPreferenceStore;
private List<StudyPlan> studyplans;
private List<Semester> semesters;
private List<Subject> subjects;
private List<Course> courses;
private List<Student> students;
private List<Lecturer> lecturers;
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1 = new HashMap<String, Subject>() {
{
put("VU Programmkonstruktion", new Subject("VU Programmkonstruktion", new BigDecimal(8.8)));
put("UE Studieneingangsgespräch", new Subject("UE Studieneingangsgespräch", new BigDecimal(0.2)));
put("VU Technische Grundlagen der Informatik", new Subject("VU Technische Grundlagen der Informatik", new BigDecimal(6.0)));
put("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new Subject("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new BigDecimal(4.0)));
put("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new Subject("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik", new BigDecimal(5.0)));
put("VU Formale Modellierung", new Subject("VU Formale Modellierung", new BigDecimal(3.0)));
put("VU Datenmodellierung", new Subject("VU Datenmodellierung", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2 = new HashMap<String, Subject>() {
{
put("VU Algorithmen und Datenstrukturen 1", new Subject("VU Algorithmen und Datenstrukturen 1", new BigDecimal(6.0)));
put("VU Algorithmen und Datenstrukturen 2", new Subject("VU Algorithmen und Datenstrukturen 2", new BigDecimal(3.0)));
put("VU Einführung in Visual Computing", new Subject("VU Einführung in Visual Computing", new BigDecimal(6.0)));
put("VU Gesellschaftliche Spannungsfelder der Informatik", new Subject("VU Gesellschaftliche Spannungsfelder der Informatik", new BigDecimal(3.0)));
put("VU Basics of Human Computer Interaction", new Subject("VU Basics of Human Computer Interaction", new BigDecimal(3.0)));
put("VO Analysis für Informatik und Wirtschaftsinformatik", new Subject("VO Analysis für Informatik und Wirtschaftsinformatik", new BigDecimal(2.0)));
put("UE Analysis für Informatik und Wirtschaftsinformatik", new Subject("UE Analysis für Informatik und Wirtschaftsinformatik", new BigDecimal(4.0)));
put("VU Objektorientierte Modellierung", new Subject("VU Objektorientierte Modellierung", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3 = new HashMap<String, Subject>() {
{
put("VU Objektorientierte Programmiertechniken", new Subject("VU Objektorientierte Programmiertechniken", new BigDecimal(3.0)));
put("VU Funktionale Programmierung", new Subject("VU Funktionale Programmierung", new BigDecimal(3.0)));
put("VO Betriebssysteme", new Subject("VO Betriebssysteme", new BigDecimal(2.0)));
put("UE Betriebssysteme", new Subject("UE Betriebssysteme", new BigDecimal(4.0)));
put("VU Introduction to Security", new Subject("VU Introduction to Security", new BigDecimal(3.0)));
put("VU Daten- und Informatikrecht", new Subject("VU Daten- und Informatikrecht", new BigDecimal(3.0)));
put("VU Datenbanksysteme", new Subject("VU Datenbanksysteme", new BigDecimal(6.0)));
put("VO Statistik und Wahrscheinlichkeitstheorie", new Subject("VO Statistik und Wahrscheinlichkeitstheorie", new BigDecimal(3.0)));
put("UE Statistik und Wahrscheinlichkeitstheorie", new Subject("UE Statistik und Wahrscheinlichkeitstheorie", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4 = new HashMap<String, Subject>() {
{
put("VU Einführung in die Künstliche Intelligenz", new Subject("VU Einführung in die Künstliche Intelligenz", new BigDecimal(3.0)));
put("VU Theoretische Informatik und Logik", new Subject("VU Theoretische Informatik und Logik", new BigDecimal(6.0)));
put("VO Software Engineering und Projektmanagement", new Subject("VO Software Engineering und Projektmanagement", new BigDecimal(3.0)));
put("PR Software Engineering und Projektmanagement", new Subject("PR Software Engineering und Projektmanagement", new BigDecimal(6.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5 = new HashMap<String, Subject>() {
{
put("VO Verteilte Systeme", new Subject("VO Verteilte Systeme", new BigDecimal(3.0)));
put("UE Verteilte Systeme", new Subject("UE Verteilte Systeme", new BigDecimal(3.0)));
put("VU Gesellschaftswissenschaftliche Grundlagen der Informatik", new Subject("VU Gesellschaftswissenschaftliche Grundlagen der Informatik", new BigDecimal(3.0)));
put("VU Interface and Interaction Design", new Subject("VU Interface and Interaction Design", new BigDecimal(3.0)));
put("VU Einführung in wissensbasierte Systeme", new Subject("VU Einführung in wissensbasierte Systeme", new BigDecimal(3.0)));
put("SE Wissenschaftliches Arbeiten", new Subject("SE Wissenschaftliches Arbeiten", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6 = new HashMap<String, Subject>() {
{
put("PR Bachelorarbeit für Informatik und Wirtschaftsinformatik", new Subject("PR Bachelorarbeit für Informatik und Wirtschaftsinformatik", new BigDecimal(10.0)));
}
};
private Map<String, Subject> subjectsOptionalBachelorSoftwareAndInformationEngineering = new HashMap<String, Subject>() {
{
put("VU Propädeutikum für Informatik", new Subject("VU Propädeutikum für Informatik", new BigDecimal(6.0)));
put("VO Deklaratives Problemlösen", new Subject("VO Deklaratives Problemlösen", new BigDecimal(3.0)));
put("UE Deklaratives Problemlösen", new Subject("UE Deklaratives Problemlösen", new BigDecimal(3.0)));
put("VU Logikprogrammierung und Constraints", new Subject("VU Logikprogrammierung und Constraints", new BigDecimal(6.0)));
put("VO Abstrakte Maschinen", new Subject("VO Abstrakte Maschinen", new BigDecimal(3.0)));
put("UE Abstrakte Maschinen", new Subject("UE Abstrakte Maschinen", new BigDecimal(3.0)));
put("VU Microcontroller", new Subject("VU Microcontroller", new BigDecimal(7.0)));
put("UE Programmierung von Betriebssystemen", new Subject("UE Programmierung von Betriebssystemen", new BigDecimal(3.0)));
put("VU Übersetzerbau", new Subject("VU Übersetzerbau", new BigDecimal(6.0)));
put("VO Echtzeitsysteme", new Subject("VO Echtzeitsysteme", new BigDecimal(2.0)));
put("VU Dependable Systems", new Subject("VU Dependable Systems", new BigDecimal(4.0)));
put("VU Internet Security", new Subject("VU Internet Security", new BigDecimal(3.0)));
put("VU Internet Security", new Subject("VU Internet Security", new BigDecimal(3.0)));
put("VU Privacy Enhancing Technology", new Subject("VU Privacy Enhancing Technology", new BigDecimal(3.0)));
put("UE Daten- und Informatikrecht", new Subject("UE Daten- und Informatikrecht", new BigDecimal(3.0)));
put("VU Vertrags- und Haftungsrecht", new Subject("VU Vertrags- und Haftungsrecht", new BigDecimal(3.0)));
put("VU Semistrukturierte Daten", new Subject("VU Semistrukturierte Daten", new BigDecimal(3.0)));
put("VU Web Engineering", new Subject("VU Web Engineering", new BigDecimal(4.5)));
put("VU Computerstatistik", new Subject("VU Computerstatistik", new BigDecimal(3.0)));
put("VU Datenanalyse", new Subject("VU Datenanalyse", new BigDecimal(3.0)));
put("VU Statistical Computing", new Subject("VU Statistical Computing", new BigDecimal(3.0)));
put("VO Logik für Wissensrepräsentation", new Subject("VO Logik für Wissensrepräsentation", new BigDecimal(3.0)));
put("UE Logik für Wissensrepräsentation", new Subject("UE Logik für Wissensrepräsentation", new BigDecimal(3.0)));
put("VO Computernumerik", new Subject("VO Computernumerik", new BigDecimal(3.0)));
put("UE Computernumerik", new Subject("UE Computernumerik", new BigDecimal(1.5)));
put("VO Multivariate Statistik", new Subject("VO Multivariate Statistik", new BigDecimal(4.5)));
put("UE Multivariate Statistik", new Subject("UE Multivariate Statistik", new BigDecimal(1.5)));
put("VU Statistische Simulation und computerintensive Methoden", new Subject("VU Statistische Simulation und computerintensive Methoden", new BigDecimal(3.0)));
put("VU Argumentieren und Beweisen", new Subject("VU Argumentieren und Beweisen", new BigDecimal(6.0)));
put("VU Programm- und Systemverifikation", new Subject("VU Programm- und Systemverifikation", new BigDecimal(6.0)));
put("VU Softwareprojekt-Beobachtung und -Controlling", new Subject("VU Softwareprojekt-Beobachtung und -Controlling", new BigDecimal(6.0)));
put("VU Software-Qualitätssicherung", new Subject("VU Software-Qualitätssicherung", new BigDecimal(6.0)));
put("VU Usability Engineering", new Subject("VU Usability Engineering", new BigDecimal(3.0)));
put("SE Coaching als Führungsinstrument 2", new Subject("SE Coaching als Führungsinstrument 2", new BigDecimal(3.0)));
put("SE Didaktik in der Informatik", new Subject("SE Didaktik in der Informatik", new BigDecimal(3.0)));
put("VO EDV-Vertragsrecht", new Subject("VO EDV-Vertragsrecht", new BigDecimal(1.5)));
put("VO Einführung in Technik und Gesellschaft", new Subject("VO Einführung in Technik und Gesellschaft", new BigDecimal(3.0)));
put("SE Folgenabschätzung von Informationstechnologien", new Subject("SE Folgenabschätzung von Informationstechnologien", new BigDecimal(3.0)));
put("VU Forschungsmethoden", new Subject("VU Forschungsmethoden", new BigDecimal(3.0)));
put("VU Kommunikation und Moderation", new Subject("VU Kommunikation und Moderation", new BigDecimal(3.0)));
put("VU Kooperatives Arbeiten", new Subject("VU Kooperatives Arbeiten", new BigDecimal(3.0)));
put("SE Rechtsinformationsrecherche im Internet", new Subject("SE Rechtsinformationsrecherche im Internet", new BigDecimal(3.0)));
put("VU Softskills für TechnikerInnen", new Subject("VU Softskills für TechnikerInnen", new BigDecimal(3.0)));
put("VU Techniksoziologie und Technikpsychologie", new Subject("VU Techniksoziologie und Technikpsychologie", new BigDecimal(3.0)));
put("VO Theorie und Praxis der Gruppenarbeit", new Subject("VO Theorie und Praxis der Gruppenarbeit", new BigDecimal(3.0)));
put("SE Wissenschaftliche Methodik", new Subject("SE Wissenschaftliche Methodik", new BigDecimal(3.0)));
put("SE Scientific Presentation and Communication", new Subject("SE Scientific Presentation and Communication", new BigDecimal(3.0)));
put("PV Privatissimum aus Fachdidaktik Informatik", new Subject("PV Privatissimum aus Fachdidaktik Informatik", new BigDecimal(4.0)));
put("VU Präsentation und Moderation", new Subject("VU Präsentation und Moderation", new BigDecimal(3.0)));
}
};
private Map<String, Subject> subjectsFreeChoiceInformatics = new HashMap<String, Subject>() {{
put("VU Pilots in Mobile Interaction: User-centered Interaction Research and Evaluation", new Subject("VU Pilots in Mobile Interaction: User-centered Interaction Research and Evaluation", new BigDecimal(3.0)));
put("VU Robotik für RoboCup", new Subject("VU Robotik für RoboCup", new BigDecimal(6.0)));
put("KO Reflections on ICTs and Society", new Subject("KO Reflections on ICTs and Society", new BigDecimal(6.0)));
put("VU Science of Information 1: Transdisciplinary Foundations of Informatics", new Subject("VU Science of Information 1: Transdisciplinary Foundations of Informatics", new BigDecimal(3.0)));
put("VU Parallel Computing", new Subject("VU Parallel Computing", new BigDecimal(6.0)));
put("PR Praktikum aus IT-Security", new Subject("PR Praktikum aus IT-Security", new BigDecimal(6.0)));
put("SE Formale Semantik natürlicher Sprache", new Subject("SE Formale Semantik natürlicher Sprache", new BigDecimal(3.0)));
put("VO Ausgewählte Kapitel der Technischen Informatik", new Subject("VO Ausgewählte Kapitel der Technischen Informatik", new BigDecimal(3.0)));
put("SE Seminar für DiplomandInnen", new Subject("SE Seminar für DiplomandInnen", new BigDecimal(2.0)));
put("SE Computer Vision Seminar für DiplomandInnen", new Subject("SE Computer Vision Seminar für DiplomandInnen", new BigDecimal(2.0)));
put("VU Softwaretechische Konzepte und Infrastrukturtechnologien zur Identifikation von Objekten und Geräten: RFID, Smartcards, NFC und Mobile Phones", new Subject("VU Softwaretechische Konzepte und Infrastrukturtechnologien zur Identifikation von Objekten und Geräten: RFID, Smartcards, NFC und Mobile Phones", new BigDecimal(3.0)));
put("VU Advanced Services Engineering", new Subject("VU Advanced Services Engineering", new BigDecimal(3.0)));
put("SE Forschungsseminar für DiplomandInnen", new Subject("SE Forschungsseminar für DiplomandInnen", new BigDecimal(3.0)));
put("VO Finanzmärkte, Finanzintermediation und Kapitalanlage", new Subject("VO Finanzmärkte, Finanzintermediation und Kapitalanlage", new BigDecimal(3.5)));
put("VU Methodisches, industrielles Software-Engineering mit Funktionalen Sprachen am Fallbeispiel Haskell", new Subject("VU Methodisches, industrielles Software-Engineering mit Funktionalen Sprachen am Fallbeispiel Haskell", new BigDecimal(3.0)));
put("VU IT Governance", new Subject("VU IT Governance", new BigDecimal(3.0)));
put("VU Current Trends in Computer Science", new Subject("VU Current Trends in Computer Science", new BigDecimal(3.0)));
put("VU Programmierung von Strategie-Spielen", new Subject("VU Programmierung von Strategie-Spielen", new BigDecimal(3.0)));
put("VU Medienanalyse und Medienreflexion", new Subject("VU Medienanalyse und Medienreflexion", new BigDecimal(3.0)));
put("EX Exkursion", new Subject("EX Exkursion", new BigDecimal(3.0)));
put("VU Privacy Enhancing Technologies", new Subject("VU Privacy Enhancing Technologies", new BigDecimal(3.0)));
put("VU Theoretische Informatik und Logik für CI", new Subject("VU Theoretische Informatik und Logik für CI", new BigDecimal(6.0)));
put("SE Theorie und Praxis der Evaluierung von innovativen User Interfaces", new Subject("SE Theorie und Praxis der Evaluierung von innovativen User Interfaces", new BigDecimal(3.0)));
put("VU Brückenkurs Programmierung für Studienanfängerinnen", new Subject("VU Brückenkurs Programmierung für Studienanfängerinnen", new BigDecimal(3.0)));
put("VU Mobile (App) Software Engineering", new Subject("VU Mobile (App) Software Engineering", new BigDecimal(3.0)));
put("VU Runtime Verification", new Subject("VU Runtime Verification", new BigDecimal(3.0)));
put("VU 2D and 3D Image Registration", new Subject("VU 2D and 3D Image Registration", new BigDecimal(3.0)));
put("VU Mobile Robotik", new Subject("VU Mobile Robotik", new BigDecimal(4.5)));
put("SE Critical Algorithm Studies", new Subject("SE Critical Algorithm Studies", new BigDecimal(3.0)));
put("VU Brückenkurs Programmierung für Studienanfänger", new Subject("", new BigDecimal(0.0)));
}};
private Map<String, Subject> subjectsBachelorSoftwareAndInformationEngineering;
private Map<String, Course> coursesBachelorSoftwareAndInformationEngineering;
private Map<String, Tag> tags = new HashMap<String, Tag>() {{
put("Programmieren", new Tag("Programmieren"));
put("Java", new Tag("Java"));
put("Debug", new Tag("Debug"));
put("Rekursion", new Tag("Rekursion"));
put("Boolsche Algebra", new Tag("Boolsche Algebra"));
put("RISC", new Tag("RISC"));
put("CISC", new Tag("CISC"));
put("Pipelining", new Tag("Pipelining"));
put("ROM", new Tag("ROM"));
put("PROM/EPROM", new Tag("PROM/EPROM"));
put("2 Complement", new Tag("2 Complement"));
put("1 Complement", new Tag("1 Complement"));
put("Gatterschaltungen", new Tag("Gatterschaltungen"));
put("Befehlssatz", new Tag("Befehlssatz"));
put("Digital", new Tag("Digital"));
put("Zahlentheorie", new Tag("Zahlentheorie"));
put("Aussagenlogik", new Tag("Aussagenlogik"));
put("Mengenlehre", new Tag("Mengenlehre"));
put("Kombinatorik,", new Tag("Kombinatorik,"));
put("Differenzengleichungen", new Tag("Differenzengleichungen"));
put("Graphentheorie", new Tag("Graphentheorie"));
put("Algebraische Strukturen", new Tag("Algebraische Strukturen"));
put("Lineare Algebra", new Tag("Lineare Algebra"));
put("Codierungstheorie", new Tag("Codierungstheorie"));
put("UE", new Tag("UE"));
put("VU", new Tag("VU"));
put("VO", new Tag("VO"));
put("Automaten", new Tag("Automaten"));
put("reguläre Ausdrücke", new Tag("reguläre Ausdrücke"));
put("Grammatiken", new Tag("Grammatiken"));
put("Petri-Netze", new Tag("Petri-Netze"));
put("Prädikatenlogik", new Tag("Prädikatenlogik"));
put("EER", new Tag("EER"));
put("Relationenmodel", new Tag("Relationenmodel"));
put("Domänenkalkül", new Tag("Domänenkalkül"));
put("Datenbanksprachen", new Tag("Datenbanksprachen"));
put("Relationale Entwurfstheorie", new Tag("Relationale Entwurfstheorie"));
put("Normalformen", new Tag("Normalformen"));
put("Datenintegrität", new Tag("Datenintegrität"));
put("SQL", new Tag("SQL"));
put("JDBC", new Tag("JDBC"));
put("DBMS", new Tag("DBMS"));
put("Algorithmen", new Tag("Algorithmen"));
put("Datenstrukturen", new Tag("Datenstrukturen"));
put("Visual Computing", new Tag("Visual Computing"));
put("MATLAB", new Tag("MATLAB"));
put("Fourier", new Tag("Fourier"));
put("Analysis", new Tag("Analysis"));
put("Langweilig", new Tag("Langweilig"));
put("Theorie", new Tag("Theorie"));
put("Praxis", new Tag("Praxis"));
put("Gesellschaft", new Tag("Gesellschaft"));
put("Human Computer Interaction", new Tag("Human Computer Interaction"));
put("Laplace", new Tag("Laplace"));
put("Laplace", new Tag("Laplace"));
put("Folgen", new Tag("Folgen"));
put("Reihen", new Tag("Reihen"));
put("Stetigkeit", new Tag("Stetigkeit"));
put("Grenzwerte", new Tag("Grenzwerte"));
put("Nullstellen", new Tag("Nullstellen"));
put("Differentialrechnung", new Tag("Differentialrechnung"));
put("Funktionen", new Tag("Funktionen"));
put("Integralrechnung", new Tag("Integralrechnung"));
put("Objektorientiert", new Tag("Objektorientiert"));
put("UML", new Tag("UML"));
put("Grundlagen", new Tag("Grundlagen"));
put("Hardware", new Tag("Hardware"));
put("Software", new Tag("Software"));
put("Computer Science", new Tag("Computer Science"));
put("Mathe", new Tag("Mathe"));
put("Spaß", new Tag("Spaß"));
put("Einfach", new Tag("Einfach"));
put("Diffizil", new Tag("Diffizil"));
put("Programmiersprachen", new Tag("Programmiersprachen"));
put("Gruppenarbeit", new Tag("Gruppenarbeit"));
put("Abstraktion", new Tag("Abstraktion"));
put("Teamfaehigkeit", new Tag("Teamfaehigkeit"));
put("Generizität", new Tag("Generizität"));
put("Haskell", new Tag("Haskell"));
put("Funktional", new Tag("Funktional"));
put("Lambda-Kalkuel", new Tag("Lambda-Kalkuel"));
put("Thread", new Tag("Thread"));
put("Prozes", new Tag("Prozes"));
put("Synchronisation", new Tag("Synchronisation"));
put("Betriebssystem", new Tag("Betriebssystem"));
put("C", new Tag("C"));
put("Scheduling", new Tag("Scheduling"));
put("Multithreading", new Tag("Multithreading"));
put("Deadlock", new Tag("Deadlock"));
put("Semaphore", new Tag("Semaphore"));
put("Sequencer", new Tag("Sequencer"));
put("Eventcounts", new Tag("Eventcounts"));
put("Producer-Consumer", new Tag("Producer-Consumer"));
put("Speicherverwaltung", new Tag("Speicherverwaltung"));
put("Filesysteme", new Tag("Filesysteme"));
put("Netzwerke", new Tag("Netzwerke"));
put("Security", new Tag("Security"));
put("Eventcounts", new Tag("Eventcounts"));
put("Social engineering", new Tag("Social engineering"));
put("Physical Break-Ins", new Tag("Physical Break-Ins"));
put("Dumpster Diving", new Tag("Dumpster Diving"));
put("Password Cracking", new Tag("Password Cracking"));
put("Session Hijacking", new Tag("Session Hijacking"));
put("Spoofing", new Tag("Spoofing"));
put("Viruses", new Tag("Viruses"));
put("Worms", new Tag("Worms"));
put("Trojan Horses", new Tag("Trojan Horses"));
put("Phishing", new Tag("Phishing"));
put("Encryption", new Tag("Encryption"));
put("Spyware", new Tag("Spyware"));
put("Phishing", new Tag("Phishing"));
put("Encryption", new Tag("Encryption"));
put("Spyware", new Tag("Spyware"));
put("Adware", new Tag("Adware"));
put("Cryptography", new Tag("Cryptography"));
put("Risk Analysis", new Tag("Risk Analysis"));
put("Recht", new Tag("Recht"));
put("Wirtschaft", new Tag("Wirtschaft"));
put("Technik", new Tag("Technik"));
put("Statistik", new Tag("Statistik"));
put("Wahrscheinlichkeitstheorie", new Tag("Wahrscheinlichkeitstheorie"));
put("Verteilung", new Tag("Verteilung"));
put("Histogramm", new Tag("Histogramm"));
put("Grundlagen der Bayes'schen", new Tag("Grundlagen der Bayes'schen"));
put("Wahrscheinlichkeitsraeume", new Tag("Wahrscheinlichkeitsraeume"));
put("Stochastik", new Tag("Stochastik"));
put("Gesetz der großen Zahlen", new Tag("Gesetz der großen Zahlen"));
}};
private Map<String, Student> studentMap = new HashMap<String, Student>() {
{
put("Caroline Black", new Student("s1123960", "Caroline Black", "[email protected]", new UserAccount("student", "pass", Role.STUDENT)));
put("Emma Dowd", new Student("s1127157", "Emma Dowd", "[email protected]", new UserAccount("emma", "pass", Role.STUDENT)));
put("John Terry", new Student("s1126441", "John Terry", "[email protected]", new UserAccount("john", "pass", Role.STUDENT)));
put("Joan Watson", new Student("s0227157", "Joan Watson", "[email protected]"));
put("James Bond", new Student("s1527199", "James Bond", "[email protected]"));
put("Trevor Bond", new Student("s0445157", "Trevor Bond", "[email protected]"));
}
};
private Map<String, Lecturer> lecturerMap = new HashMap<String, Lecturer>() {
{
put("Carol Sanderson", new Lecturer("l0100010", "Carol Sanderson", "[email protected]"));
put("Una Walker", new Lecturer("l0100011", "Una Walker", "[email protected]", new UserAccount("lecturer", "pass", Role.LECTURER)));
put("Connor MacLeod", new Lecturer("l0203019", "Connor MacLeod", "[email protected]"));
put("Eric Wilkins", new Lecturer("l1100010", "Eric Wilkins", "[email protected]", new UserAccount("eric", "pass", Role.LECTURER)));
put("Benjamin Piper", new Lecturer("l9123410", "Benjamin Piper", "[email protected]", new UserAccount("ben", "pass", Role.LECTURER)));
}
};
@Transactional
public void initialize() {
userAccountRepository.save(new UserAccount("admin", "pass", Role.ADMIN));
createTags();
createSubjects();
createSemesters();
createCourses();
createStudyPlans();
createUsers();
registerStudentsToStudyPlans();
addPreconditionsToSubjects();
registerSubjectsToLecturers();
addTagsToCourses();
addSubjectsToStudyPlans();
registerCoursesToStudents();
giveGrades();
giveFeedback();
}
private void createTags() {
tagRepository.save(tags.values());
}
private void createSubjects() {
createSubjectsBachelorSoftwareAndInformationEngineering();
Iterable<Subject> subjects = subjectRepository.save(subjectsBachelorSoftwareAndInformationEngineering.values());
this.subjects = StreamSupport.stream(subjects.spliterator(), false).collect(Collectors.toList());
}
private void createSubjectsBachelorSoftwareAndInformationEngineering() {
subjectsBachelorSoftwareAndInformationEngineering = new HashMap<>();
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsOptionalBachelorSoftwareAndInformationEngineering);
subjectsBachelorSoftwareAndInformationEngineering.putAll(subjectsFreeChoiceInformatics);
}
private void createSemesters() {
Iterable<Semester> semesters = semesterRepository.save(asList(
new Semester(2016, SemesterType.SummerSemester),
new Semester(2016, SemesterType.WinterSemester)
));
this.semesters = StreamSupport.stream(semesters.spliterator(), false).collect(Collectors.toList());
}
private void createCourses() {
createCoursesBachelorSoftwareAndInformationEngineering();
Iterable<Course> courses = courseRepository.save(coursesBachelorSoftwareAndInformationEngineering.values());
this.courses = StreamSupport.stream(courses.spliterator(), false).collect(Collectors.toList());
}
private void createCoursesBachelorSoftwareAndInformationEngineering() {
coursesBachelorSoftwareAndInformationEngineering = new HashMap<>();
for (String subjectName : subjectsBachelorSoftwareAndInformationEngineering.keySet()) {
coursesBachelorSoftwareAndInformationEngineering.put(
subjectName,
new Course(subjectsBachelorSoftwareAndInformationEngineering.get(subjectName), semesters.get(1)).setStudentLimits(20)
);
}
}
private void createStudyPlans() {
Iterable<StudyPlan> studyplans = studyPlanRepository.save(asList(
new StudyPlan("Bachelor Software and Information Engineering", new EctsDistribution(new BigDecimal(90), new BigDecimal(60), new BigDecimal(30))),
new StudyPlan("Master Business Informatics", new EctsDistribution(new BigDecimal(30), new BigDecimal(70), new BigDecimal(20))),
new StudyPlan("Master Computational Intelligence", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30))),
new StudyPlan("Master Visual Computing", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30))),
new StudyPlan("Master Medical Informatics", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30)), false),
new StudyPlan("Master Computer Science", new EctsDistribution(new BigDecimal(60), new BigDecimal(30), new BigDecimal(30)))
));
this.studyplans = StreamSupport.stream(studyplans.spliterator(), false).collect(Collectors.toList());
}
private void createUsers() {
pendingAccountActivationRepository.save(
new PendingAccountActivation("test", new Student("test", "Test User", "[email protected]"))
);
List<UisUser> usersList = new ArrayList<>(studentMap.values());
usersList.addAll(lecturerMap.values());
Iterable<UisUser> users = uisUserRepository.save(usersList);
students = StreamSupport.stream(users.spliterator(), false)
.filter(it -> it instanceof Student)
.map(it -> (Student) it)
.collect(Collectors.toList());
lecturers = StreamSupport.stream(users.spliterator(), false)
.filter(it -> it instanceof Lecturer)
.map(it -> (Lecturer) it)
.collect(Collectors.toList());
}
private void registerStudentsToStudyPlans() {
studentMap.get("John Terry").addStudyplans(new StudyPlanRegistration(studyplans.get(0), semesters.get(1)));
studentMap.get("Caroline Black").addStudyplans(new StudyPlanRegistration(studyplans.get(1), semesters.get(1)));
studentMap.get("Emma Dowd").addStudyplans(new StudyPlanRegistration(studyplans.get(2), semesters.get(0)));
studentMap.get("Joan Watson").addStudyplans(new StudyPlanRegistration(studyplans.get(3), semesters.get(1)));
studentMap.get("James Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(4), semesters.get(1)));
studentMap.get("James Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(5), semesters.get(0)));
studentMap.get("Trevor Bond").addStudyplans(new StudyPlanRegistration(studyplans.get(1), semesters.get(1)));
}
private void addPreconditionsToSubjects() {
subjects.get(2).addRequiredSubjects(subjects.get(1));
}
private void registerSubjectsToLecturers() {
subjectsBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch").addLecturers(
lecturerMap.get("Carol Sanderson")
);
subjects.get(0).addLecturers(lecturers.get(3));
subjects.get(1).addLecturers(lecturers.get(3));
subjects.get(2).addLecturers(lecturers.get(3), lecturers.get(4));
subjectRepository.save(subjects);
Subject s = subjectsBachelorSoftwareAndInformationEngineering
.get("VU Technische Grundlagen der Informatik");
s.addLecturers(lecturers.get(3));
subjectRepository.save(s);
s = subjectsBachelorSoftwareAndInformationEngineering
.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik");
s.addLecturers(lecturers.get(3));
subjectRepository.save(s);
}
private void addTagsToCourses() {
addTagsToBachelorSoftwareAndInformationEngineeringCourses();
courseRepository.save(coursesBachelorSoftwareAndInformationEngineering.values());
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCourses() {
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1();
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester2();
addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester3();
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Programmkonstruktion").addTags(
tags.get("VU"), tags.get("Programmieren"), tags.get("Java"), tags.get("Debug"),
tags.get("Rekursion"), tags.get("Software"), tags.get("Einfach"), tags.get("Grundlagen"),
tags.get("Objektorientiert"), tags.get("Generizität")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik").addTags(
tags.get("VU"), tags.get("Boolsche Algebra"), tags.get("RISC"), tags.get("CISC"), tags.get("Pipelining"),
tags.get("ROM"), tags.get("PROM/EPROM"), tags.get("2 Complement"), tags.get("1 Complement"),
tags.get("Gatterschaltungen"), tags.get("Befehlssatz"), tags.get("Digital"), tags.get("Diffizil"), tags.get("Grundlagen"),
tags.get("Hardware")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik").addTags(
tags.get("VO"), tags.get("Zahlentheorie"), tags.get("Aussagenlogik"), tags.get("Mengenlehre"),
tags.get("Mathe"), tags.get("Kombinatorik"), tags.get("Differenzengleichungen"),
tags.get("Graphentheorie"), tags.get("Algebraische Strukturen"), tags.get("Lineare Algebra"),
tags.get("Codierungstheorie"), tags.get("Einfach"), tags.get("Funktionen"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik").addTags(
tags.get("UE"), tags.get("Zahlentheorie"), tags.get("Aussagenlogik"), tags.get("Mengenlehre"),
tags.get("Mathe"), tags.get("Kombinatorik"), tags.get("Differenzengleichungen"),
tags.get("Graphentheorie"), tags.get("Algebraische Strukturen"), tags.get("Lineare Algebra"),
tags.get("Codierungstheorie"), tags.get("Einfach"), tags.get("Funktionen"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Formale Modellierung").addTags(
tags.get("VU"), tags.get("Automaten"), tags.get("reguläre Ausdrücke"), tags.get("formale Grammatiken"),
tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Diffizil"), tags.get("Grundlagen"),
tags.get("Lambda-Kalkuel")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung").addTags(
tags.get("VU"), tags.get("EER"), tags.get("Relationenmodel"), tags.get("Domänenkalkül"),
tags.get("Datenbanksprachen"), tags.get("Normalformen"), tags.get("Relationale Entwurfstheorie"),
tags.get("Datenintegrität"), tags.get("Einfach"), tags.get("SQL"), tags.get("Grundlagen")
);
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester2() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Algorithmen und Datenstrukturen 1").addTags(
tags.get("VU"), tags.get("Datenstrukturen"), tags.get("Algorithmen"), tags.get("Java"),
tags.get("Programmieren"), tags.get("Debug"), tags.get("Rekursion"),
tags.get("Software"), tags.get("Graphentheorie"), tags.get("Einfach")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Algorithmen und Datenstrukturen 2").addTags(
tags.get("VU"), tags.get("Datenstrukturen"), tags.get("Algorithmen"), tags.get("Java"),
tags.get("Programmieren"), tags.get("Debug"), tags.get("Rekursion"),
tags.get("Software"), tags.get("Graphentheorie"), tags.get("Diffizil")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Einführung in Visual Computing").addTags(
tags.get("VU"), tags.get("Visual Computing"), tags.get("MATLAB"), tags.get("Mathe"),
tags.get("Fourier"), tags.get("Analysis"), tags.get("Diffizil"), tags.get("Programmieren"),
tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Gesellschaftliche Spannungsfelder der Informatik").addTags(
tags.get("VU"), tags.get("Langweilig"), tags.get("Theorie"), tags.get("Einfach"),
tags.get("Gesellschaft")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Basics of Human Computer Interaction").addTags(
tags.get("VU"), tags.get("Human Computer Interaction"), tags.get("Einfach"), tags.get("Grundlagen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Analysis für Informatik und Wirtschaftsinformatik").addTags(
tags.get("VU"), tags.get("Mathe"), tags.get("Analysis"), tags.get("Fourier"),
tags.get("Laplace"), tags.get("Diffizil"), tags.get("Folgen"),
tags.get("Reihen"), tags.get("Stetigkeit"), tags.get("Grenzwerte"),
tags.get("Nullstellen"), tags.get("Differentialrechnung"),
tags.get("Integralrechnung"), tags.get("Funktionen")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Analysis für Informatik und Wirtschaftsinformatik").addTags(
tags.get("UE"), tags.get("Mathe"), tags.get("Analysis"), tags.get("Fourier"),
tags.get("Laplace"), tags.get("Diffizil"), tags.get("Folgen"),
tags.get("Reihen"), tags.get("Stetigkeit"), tags.get("Grenzwerte"),
tags.get("Nullstellen"), tags.get("Differentialrechnung"),
tags.get("Integralrechnung"), tags.get("Funktionen")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Objektorientierte Modellierung").addTags(
tags.get("VU"), tags.get("Objektorientiert"), tags.get("UML"), tags.get("Grundlagen"),
tags.get("Einfach")
);
}
private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester3() {
coursesBachelorSoftwareAndInformationEngineering.get("VU Objektorientierte Programmiertechniken").addTags(
tags.get("VU"), tags.get("Objektorientiert"), tags.get("Programmiersprachen"),
tags.get("Programmieren"), tags.get("Java"),
tags.get("Debug"), tags.get("Software"), tags.get("Teamfaehigkeit"),
tags.get("Gruppenarbeit"), tags.get("Abstraktion"), tags.get("Diffizil"),
tags.get("Generizität"), tags.get("Theorie"), tags.get("Praxis")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Funktionale Programmierung").addTags(
tags.get("VU"), tags.get("Programmiersprachen"), tags.get("Programmieren"),
tags.get("Diffizil"), tags.get("Haskell"), tags.get("Debug"),
tags.get("Software"), tags.get("Teamfaehigkeit"),
tags.get("Gruppenarbeit"), tags.get("Haskell"), tags.get("Diffizil"),
tags.get("Funktional"), tags.get("Theorie"), tags.get("Praxis"),
tags.get("Grundlagen"), tags.get("Rekursion"), tags.get("Funktionen"),
tags.get("Lambda-Kalkuel")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Betriebssysteme").addTags(
tags.get("V0"), tags.get("Theorie"), tags.get("Thread"), tags.get("Prozess"),
tags.get("Synchronisation"), tags.get("Grundlagen"), tags.get("Betriebssystem"),
tags.get("Scheduling"), tags.get("Multithreading"), tags.get("Deadlock"),
tags.get("Datenstrukturen"), tags.get("Semaphore"),
tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("C")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Betriebssysteme").addTags(
tags.get("UE"), tags.get("Programmieren"), tags.get("Thread"), tags.get("Prozess"),
tags.get("Synchronisation"), tags.get("Grundlagen"), tags.get("Betriebssystem"),
tags.get("Scheduling"), tags.get("Multithreading"), tags.get("Deadlock"),
tags.get("Datenstrukturen"), tags.get("Semaphore"),
tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("Diffizil"), tags.get("C")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Introduction to Security").addTags(
tags.get("VU"), tags.get("Programmieren"), tags.get("Social engineering"), tags.get("Physical Break-Ins"),
tags.get("Dumpster Diving"), tags.get("Grundlagen"), tags.get("Password Cracking"),
tags.get("Session Hijacking"), tags.get("Network"), tags.get("Spoofing"),
tags.get("Viruses"), tags.get("Worms"), tags.get("Trojan Horses"),
tags.get("Phishing"), tags.get("Encryption"), tags.get("Netzwerk"),
tags.get("Security"), tags.get("Software"), tags.get("Diffizil"),
tags.get("Spyware"), tags.get("Adware"), tags.get("Cryptography"),
tags.get("Risk Analysis")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Daten- und Informatikrecht").addTags(
tags.get("VU"), tags.get("Theorie"), tags.get("Recht"), tags.get("Einfach"),
tags.get("Grundlagen"), tags.get("Wirtschaft"), tags.get("Technik")
);
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenbanksysteme").addTags(
tags.get("VU"), tags.get("EER"), tags.get("Relationenmodel"), tags.get("Domänenkalkül"),
tags.get("Datenbanksprachen"), tags.get("Normalformen"), tags.get("SQL"),
tags.get("Datenintegrität"), tags.get("Diffizil"), tags.get("JDBC"), tags.get("DBMS")
);
coursesBachelorSoftwareAndInformationEngineering.get("VO Statistik und Wahrscheinlichkeitstheorie").addTags(
tags.get("VO"), tags.get("Mathe"), tags.get("Statistik"), tags.get("Wahrscheinlichkeitstheorie"),
tags.get("Verteilung"), tags.get("Histogramm"), tags.get("Wahrscheinlichkeitsräume"),
tags.get("Stochastik"), tags.get("Grundlagen"), tags.get("Gesetz der großen Zahlen"),
tags.get("Grundlagen der Bayes'schen"), tags.get("Diffizil"), tags.get("Zahlentheorie"),
tags.get("Mengenlehre"), tags.get("Kombinatorik")
);
coursesBachelorSoftwareAndInformationEngineering.get("UE Statistik und Wahrscheinlichkeitstheorie").addTags(
tags.get("UE"), tags.get("Mathe"), tags.get("Statistik"), tags.get("Wahrscheinlichkeitstheorie"),
tags.get("Verteilung"), tags.get("Histogramm"), tags.get("Wahrscheinlichkeitsräume"),
tags.get("Stochastik"), tags.get("Grundlagen"), tags.get("Gesetz der großen Zahlen"),
tags.get("Grundlagen der Bayes'schen"), tags.get("Diffizil"), tags.get("Zahlentheorie"),
tags.get("Mengenlehre"), tags.get("Kombinatorik")
);
}
private void addSubjectsToStudyPlans() {
addBachelorSoftwareAndInformationEngineeringSubjectsToStudyPlan();
}
private void addBachelorSoftwareAndInformationEngineeringSubjectsToStudyPlan() {
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester1.get(subjectName), studyplans.get(0), true, 1)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester2.get(subjectName), studyplans.get(0), true, 2)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester3.get(subjectName), studyplans.get(0), true, 3)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester4.get(subjectName), studyplans.get(0), true, 4)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester5.get(subjectName), studyplans.get(0), true, 5)
);
}
for (String subjectName : subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsMandatoryBachelorSoftwareAndInformationEngineeringSemester6.get(subjectName), studyplans.get(0), true, 6)
);
}
for (String subjectName : subjectsOptionalBachelorSoftwareAndInformationEngineering.keySet()) {
subjectForStudyPlanRepository.save(new SubjectForStudyPlan(
subjectsOptionalBachelorSoftwareAndInformationEngineering.get(subjectName), studyplans.get(0), false)
);
}
}
private void registerCoursesToStudents() {
// Joan Watson
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch"));
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
register(studentMap.get("Joan Watson"), coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
// Emma Dowd
register(studentMap.get("Emma Dowd"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
register(studentMap.get("Emma Dowd"), coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
// Caroline Black
register(studentMap.get("Caroline Black"), coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik"));
// John Terry
Student john = studentMap.get("John Terry");
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung"));
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik"));
register(john, coursesBachelorSoftwareAndInformationEngineering.get("VU Programmkonstruktion"));
}
private void register(Student student, Course course) {
course.addStudents(student);
studentSubjectPreferenceStore.studentRegisteredCourse(student, course);
}
private void giveGrades() {
Course course = coursesBachelorSoftwareAndInformationEngineering.get("UE Studieneingangsgespräch");
Student student = course.getStudents().get(0);
Lecturer lecturer = course.getSubject().getLecturers().get(0);
Grade grade = new Grade(course, lecturer, student, Mark.EXCELLENT);
gradeRepository.save(grade);
course = coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik");
student = studentMap.get("Emma Dowd");
lecturer = course.getSubject().getLecturers().get(0);
grade = new Grade(course, lecturer, student, Mark.EXCELLENT);
gradeRepository.save(grade);
course = coursesBachelorSoftwareAndInformationEngineering.get("VO Algebra und Diskrete Mathematik für Informatik und Wirtschaftsinformatik");
student = studentMap.get("Emma Dowd");
lecturer = course.getSubject().getLecturers().get(0);
grade = new Grade(course, lecturer, student, Mark.FAILED);
gradeRepository.save(grade);
grade = new Grade(
coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung"),
lecturer,
studentMap.get("John Terry"),
Mark.EXCELLENT);
gradeRepository.save(grade);
}
private void giveFeedback() {
Course course = coursesBachelorSoftwareAndInformationEngineering.get("VU Datenmodellierung");
Student johnTerry = studentMap.get("John Terry");
Feedback feedback = new Feedback(johnTerry, course);
course = coursesBachelorSoftwareAndInformationEngineering.get("VU Technische Grundlagen der Informatik");
Student joanWatson = studentMap.get("Joan Watson");
Student emmaDowd = studentMap.get("Emma Dowd");
Student carolineBlack = studentMap.get("Caroline Black");
Feedback feedback1 = new Feedback(
joanWatson,
course,
Feedback.Type.LIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
Feedback feedback2 = new Feedback(
emmaDowd,
course,
Feedback.Type.DISLIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
Feedback feedback3 = new Feedback(
carolineBlack,
course,
Feedback.Type.LIKE, "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec enim ligula. " +
"Sed eget posuere tellus. Aenean fermentum maximus tempor. Ut ultricies dapibus nulla vitae mollis. " +
"Suspendisse a nunc nisi. Sed ut sapien eu odio sodales laoreet eu ac turpis. " +
"In id sapien id ante sollicitudin consectetur at laoreet mi. Lorem ipsum dolor sit amet, consectetur adipiscing elit. " +
"Suspendisse quam sem, ornare eget pellentesque sit amet, tincidunt id metus. Sed scelerisque neque sed laoreet elementum. " +
"Integer eros neque, vulputate a hendrerit at, ullamcorper in orci. Donec sit amet risus hendrerit, hendrerit magna non, dapibus nibh. " +
"Suspendisse sed est feugiat, dapibus ante non, aliquet neque. Cras magna sapien, pharetra ut ante ut, malesuada hendrerit erat. " +
"Mauris fringilla mattis dapibus. Nullam iaculis nunc in tortor gravida, id tempor justo elementum.");
giveFeedback(feedback, feedback1, feedback2, feedback3);
}
private void giveFeedback(Feedback... feedbacks) {
for (Feedback feedback : feedbacks) {
feedbackRepository.save(feedback);
studentSubjectPreferenceStore.studentGaveCourseFeedback(feedback.getStudent(), feedback);
}
}
}
| Adds Tags for Software Engineering Courses Semester 4
| src/main/java/at/ac/tuwien/inso/initializer/DataInitializer.java | Adds Tags for Software Engineering Courses Semester 4 | <ide><path>rc/main/java/at/ac/tuwien/inso/initializer/DataInitializer.java
<ide> put("Encryption", new Tag("Encryption"));
<ide> put("Spyware", new Tag("Spyware"));
<ide> put("Phishing", new Tag("Phishing"));
<del> put("Encryption", new Tag("Encryption"));
<ide> put("Spyware", new Tag("Spyware"));
<ide> put("Adware", new Tag("Adware"));
<ide> put("Cryptography", new Tag("Cryptography"));
<ide> put("Wahrscheinlichkeitsraeume", new Tag("Wahrscheinlichkeitsraeume"));
<ide> put("Stochastik", new Tag("Stochastik"));
<ide> put("Gesetz der großen Zahlen", new Tag("Gesetz der großen Zahlen"));
<add> put("Künstliche Intelligenz", new Tag("Künstliche Intelligenz"));
<add> put("Projektmanagement", new Tag("Projektmanagement"));
<add> put("Planning", new Tag("Planning"));
<add> put("Testing", new Tag("Testing"));
<add> put("Softwarequalitätssicherung", new Tag("Softwarequalitätssicherung"));
<add> put("Risikomanagement", new Tag("Risikomanagement"));
<add> put("Qualitätsmanagement", new Tag("Qualitätsmanagement"));
<add> put("Projektmarketing", new Tag("Projektmarketing"));
<add> put("Risikomanagement", new Tag("Risikomanagement"));
<add> put("Sprint", new Tag("Sprint"));
<add> put("SCRUM", new Tag("SCRUM"));
<add> put("PR", new Tag("PR"));
<ide> }};
<ide>
<ide> private Map<String, Student> studentMap = new HashMap<String, Student>() {
<ide> addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1();
<ide> addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester2();
<ide> addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester3();
<add> addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester4();
<ide> }
<ide>
<ide> private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester1() {
<ide>
<ide> coursesBachelorSoftwareAndInformationEngineering.get("VU Formale Modellierung").addTags(
<ide> tags.get("VU"), tags.get("Automaten"), tags.get("reguläre Ausdrücke"), tags.get("formale Grammatiken"),
<del> tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Diffizil"), tags.get("Grundlagen"),
<add> tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Einfach"), tags.get("Grundlagen"),
<ide> tags.get("Lambda-Kalkuel")
<ide> );
<ide>
<ide> tags.get("V0"), tags.get("Theorie"), tags.get("Thread"), tags.get("Prozess"),
<ide> tags.get("Synchronisation"), tags.get("Grundlagen"), tags.get("Betriebssystem"),
<ide> tags.get("Scheduling"), tags.get("Multithreading"), tags.get("Deadlock"),
<del> tags.get("Datenstrukturen"), tags.get("Semaphore"),
<add> tags.get("Datenstrukturen"), tags.get("Semaphore"), tags.get("Diffizil"),
<ide> tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
<ide> tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
<del> tags.get("Security"), tags.get("Software"), tags.get("C")
<add> tags.get("Security"), tags.get("Software"), tags.get("C"), tags.get("Client-Server")
<ide> );
<ide>
<ide> coursesBachelorSoftwareAndInformationEngineering.get("UE Betriebssysteme").addTags(
<ide> tags.get("Datenstrukturen"), tags.get("Semaphore"),
<ide> tags.get("Sequencer"), tags.get("Eventcounts"), tags.get("Producer-Consumer"),
<ide> tags.get("Speicherverwaltung"), tags.get("Filesysteme"), tags.get("Netzwerk"),
<del> tags.get("Security"), tags.get("Software"), tags.get("Diffizil"), tags.get("C")
<add> tags.get("Security"), tags.get("Software"), tags.get("Diffizil"), tags.get("C"),
<add> tags.get("Client-Server")
<ide> );
<ide>
<ide> coursesBachelorSoftwareAndInformationEngineering.get("VU Introduction to Security").addTags(
<ide> tags.get("Grundlagen der Bayes'schen"), tags.get("Diffizil"), tags.get("Zahlentheorie"),
<ide> tags.get("Mengenlehre"), tags.get("Kombinatorik")
<ide>
<add> );
<add> }
<add>
<add> private void addTagsToBachelorSoftwareAndInformationEngineeringCoursesSemester4() {
<add> coursesBachelorSoftwareAndInformationEngineering.get("VU Einführung in die Künstliche Intelligenz").addTags(
<add> tags.get("VU"), tags.get("Künstliche Intelligenz"), tags.get("Grundlagen"),
<add> tags.get("Programmieren"), tags.get("Theorie"), tags.get("Diffizil")
<add> );
<add>
<add> coursesBachelorSoftwareAndInformationEngineering.get("VU Theoretische Informatik und Logik").addTags(
<add> tags.get("VU"), tags.get("Automaten"), tags.get("reguläre Ausdrücke"), tags.get("formale Grammatiken"),
<add> tags.get("Aussagenlogik"), tags.get("Petri-Netze"), tags.get("Prädikatenlogik"), tags.get("Diffizil"),
<add> tags.get("Lambda-Kalkuel"), tags.get("Logik")
<add> );
<add>
<add> coursesBachelorSoftwareAndInformationEngineering.get("VO Software Engineering und Projektmanagement").addTags(
<add> tags.get("VO"), tags.get("Theorie"), tags.get("Software"), tags.get("Projektmanagement"),
<add> tags.get("Planning"), tags.get("UML"), tags.get("Objektorientiert"), tags.get("Softwarequalitätssicherung"),
<add> tags.get("Risikomanagement"), tags.get("Qualitätsmanagement"), tags.get("Projektmarketing"),
<add> tags.get("Einfach"), tags.get("Sprint"), tags.get("SCRUM"), tags.get("SQL")
<add> );
<add>
<add> coursesBachelorSoftwareAndInformationEngineering.get("PR Software Engineering und Projektmanagement").addTags(
<add> tags.get("PR"), tags.get("Programmieren"), tags.get("Testing"), tags.get("Software"),
<add> tags.get("Projektmanagement"), tags.get("Gruppenarbeit"), tags.get("Teamfaehigkeit"),
<add> tags.get("Debug"), tags.get("Planning"), tags.get("UML"), tags.get("Objektorientiert"),
<add> tags.get("Softwarequalitätssicherung"), tags.get("Risikomanagement"), tags.get("Qualitätsmanagement"),
<add> tags.get("Projektmarketing"), tags.get("Diffizil"), tags.get("Praxis"),
<add> tags.get("Sprint"), tags.get("SCRUM"), tags.get("CRUD"), tags.get("SQL"), tags.get("UML")
<ide> );
<ide> }
<ide> |
|
Java | lgpl-2.1 | a482d9d661ee9748c16c9a701acde85214dd67ce | 0 | languagetool-org/languagetool,lopescan/languagetool,janissl/languagetool,jimregan/languagetool,jimregan/languagetool,janissl/languagetool,languagetool-org/languagetool,languagetool-org/languagetool,lopescan/languagetool,languagetool-org/languagetool,lopescan/languagetool,jimregan/languagetool,languagetool-org/languagetool,jimregan/languagetool,jimregan/languagetool,lopescan/languagetool,janissl/languagetool,janissl/languagetool,lopescan/languagetool,janissl/languagetool,janissl/languagetool | /* LanguageTool, a natural language style checker
* Copyright (C) 2007 Daniel Naber (http://www.danielnaber.de)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
package org.languagetool.language;
import org.languagetool.Language;
import org.languagetool.LanguageMaintainedState;
import org.languagetool.rules.*;
import org.languagetool.rules.pt.*;
import org.languagetool.synthesis.Synthesizer;
import org.languagetool.synthesis.pt.PortugueseSynthesizer;
import org.languagetool.rules.spelling.hunspell.HunspellRule;
import org.languagetool.tagging.Tagger;
import org.languagetool.tagging.disambiguation.Disambiguator;
import org.languagetool.tagging.disambiguation.pt.PortugueseHybridDisambiguator;
import org.languagetool.tagging.pt.PortugueseTagger;
import org.languagetool.tokenizers.SRXSentenceTokenizer;
import org.languagetool.tokenizers.SentenceTokenizer;
import org.languagetool.tokenizers.Tokenizer;
import org.languagetool.tokenizers.pt.PortugueseWordTokenizer;
import org.languagetool.languagemodel.LanguageModel;
import org.languagetool.languagemodel.LuceneLanguageModel;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.ResourceBundle;
import java.io.File;
/**
* Post-spelling-reform Portuguese.
*/
public class Portuguese extends Language implements AutoCloseable {
private static final Language PORTUGAL_PORTUGUESE = new PortugalPortuguese();
private Tagger tagger;
private Disambiguator disambiguator;
private Tokenizer wordTokenizer;
private Synthesizer synthesizer;
private SentenceTokenizer sentenceTokenizer;
private LuceneLanguageModel languageModel;
@Override
public String getName() {
return "Portuguese";
}
@Override
public String getShortCode() {
return "pt";
}
@Override
public String[] getCountries() {
return new String[]{"", "CV", "GW", "MO", "ST", "TL"};
}
@Override
public Language getDefaultLanguageVariant() {
return PORTUGAL_PORTUGUESE;
}
@Override
public Contributor[] getMaintainers() {
return new Contributor[] {
new Contributor("Marco A.G. Pinto", "http://www.marcoagpinto.com/"),
new Contributor("Matheus Poletto", "https://github.com/MatheusPoletto"),
new Contributor("Tiago F. Santos (3.6+)", "https://github.com/TiagoSantos81")
};
}
@Override
public Tagger getTagger() {
if (tagger == null) {
tagger = new PortugueseTagger();
}
return tagger;
}
/**
* @since 3.6
*/
@Override
public Disambiguator getDisambiguator() {
if (disambiguator == null) {
disambiguator = new PortugueseHybridDisambiguator();
}
return disambiguator;
}
/**
* @since 3.6
*/
@Override
public Tokenizer getWordTokenizer() {
if (wordTokenizer == null) {
wordTokenizer = new PortugueseWordTokenizer();
}
return wordTokenizer;
}
@Override
public Synthesizer getSynthesizer() {
if (synthesizer == null) {
synthesizer = new PortugueseSynthesizer();
}
return synthesizer;
}
@Override
public SentenceTokenizer getSentenceTokenizer() {
if (sentenceTokenizer == null) {
sentenceTokenizer = new SRXSentenceTokenizer(this);
}
return sentenceTokenizer;
}
@Override
public List<Rule> getRelevantRules(ResourceBundle messages) throws IOException {
return Arrays.asList(
new CommaWhitespaceRule(messages,
Example.wrong("Tomamos café<marker> ,</marker> queijo, bolachas e uvas."),
Example.fixed("Tomamos café<marker>,</marker> queijo, bolachas e uvas")),
new GenericUnpairedBracketsRule(messages),
new HunspellRule(messages, this),
new LongSentenceRule(messages, 45, true),
new UppercaseSentenceStartRule(messages, this,
Example.wrong("Esta casa é velha. <marker>foi</marker> construida em 1950."),
Example.fixed("Esta casa é velha. <marker>Foi</marker> construida em 1950.")),
new MultipleWhitespaceRule(messages, this),
new SentenceWhitespaceRule(messages),
//Specific to Portuguese:
new PostReformPortugueseCompoundRule(messages),
new PortugueseReplaceRule(messages),
new PortugueseReplaceRule2(messages),
new PortugueseClicheRule(messages),
new PortugueseRedundancyRule(messages),
new PortugueseWordynessRule(messages),
new PortugueseWikipediaRule(messages),
new PortugueseWordRepeatRule(messages, this),
new PortugueseWordRepeatBeginningRule(messages, this),
new PortugueseAccentuationCheckRule(messages),
new PortugueseWrongWordInContextRule(messages),
new PortugueseWordCoherencyRule(messages)
);
}
@Override
public LanguageMaintainedState getMaintainedState() {
return LanguageMaintainedState.ActivelyMaintained;
}
/** @since 3.6 */
@Override
public synchronized LanguageModel getLanguageModel(File indexDir) throws IOException {
if (languageModel == null) {
languageModel = new LuceneLanguageModel(new File(indexDir, getShortCode()));
}
return languageModel;
}
/** @since 3.6 */
@Override
public List<Rule> getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel) throws IOException {
return Arrays.<Rule>asList(
new PortugueseConfusionProbabilityRule(messages, languageModel, this)
);
}
/** @since 3.6 */
@Override
public void close() throws Exception {
if (languageModel != null) {
languageModel.close();
}
}
@Override
public int getPriorityForId(String id) {
switch (id) {
case "FRAGMENT_TWO_ARTICLES": return 50;
case "INTERJECTIONS_PUNTUATION": return 5;
case "PROFANITY": return -1;
case "PT_MULTI_REPLACE": return -10;
case "PT_PT_SIMPLE_REPLACE": return -11;
case "PT_REDUNDANCY_REPLACE": return -12;
case "PT_WORDYNESS_REPLACE": return -13;
case "PT_CLICHE_REPLACE": return -17;
case "CHILDISH_LANGUAGE": return -25;
case "ARCHAISMS": return -26;
case "INFORMALITIES": return -27;
case "HUNSPELL_RULE": return -40;
case "CRASE_CONFUSION": return -45;
case "FINAL_STOPS": return -55;
case "T-V_DISTINCTION": return -70;
case "T-V_DISTINCTION_ALL": return -71;
case "REPEATED_WORDS": return -110;
case "REPEATED_WORDS_3X": return -111;
case "WIKIPEDIA_COMMON_ERRORS": return -200;
case "TOO_LONG_SENTENCE": return -1000;
}
return 0;
}
}
| languagetool-language-modules/pt/src/main/java/org/languagetool/language/Portuguese.java | /* LanguageTool, a natural language style checker
* Copyright (C) 2007 Daniel Naber (http://www.danielnaber.de)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
package org.languagetool.language;
import org.languagetool.Language;
import org.languagetool.LanguageMaintainedState;
import org.languagetool.rules.*;
import org.languagetool.rules.pt.*;
import org.languagetool.synthesis.Synthesizer;
import org.languagetool.synthesis.pt.PortugueseSynthesizer;
import org.languagetool.rules.spelling.hunspell.HunspellRule;
import org.languagetool.tagging.Tagger;
import org.languagetool.tagging.disambiguation.Disambiguator;
import org.languagetool.tagging.disambiguation.pt.PortugueseHybridDisambiguator;
import org.languagetool.tagging.pt.PortugueseTagger;
import org.languagetool.tokenizers.SRXSentenceTokenizer;
import org.languagetool.tokenizers.SentenceTokenizer;
import org.languagetool.tokenizers.Tokenizer;
import org.languagetool.tokenizers.pt.PortugueseWordTokenizer;
import org.languagetool.languagemodel.LanguageModel;
import org.languagetool.languagemodel.LuceneLanguageModel;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.ResourceBundle;
import java.io.File;
/**
* Post-spelling-reform Portuguese.
*/
public class Portuguese extends Language implements AutoCloseable {
private static final Language PORTUGAL_PORTUGUESE = new PortugalPortuguese();
private Tagger tagger;
private Disambiguator disambiguator;
private Tokenizer wordTokenizer;
private Synthesizer synthesizer;
private SentenceTokenizer sentenceTokenizer;
private LuceneLanguageModel languageModel;
@Override
public String getName() {
return "Portuguese";
}
@Override
public String getShortCode() {
return "pt";
}
@Override
public String[] getCountries() {
return new String[]{"", "CV", "GW", "MO", "ST", "TL"};
}
@Override
public Language getDefaultLanguageVariant() {
return PORTUGAL_PORTUGUESE;
}
@Override
public Contributor[] getMaintainers() {
return new Contributor[] {
new Contributor("Marco A.G. Pinto", "http://www.marcoagpinto.com/"),
new Contributor("Matheus Poletto", "https://github.com/MatheusPoletto"),
new Contributor("Tiago F. Santos (3.6+)", "https://github.com/TiagoSantos81")
};
}
@Override
public Tagger getTagger() {
if (tagger == null) {
tagger = new PortugueseTagger();
}
return tagger;
}
/**
* @since 3.6
*/
@Override
public Disambiguator getDisambiguator() {
if (disambiguator == null) {
disambiguator = new PortugueseHybridDisambiguator();
}
return disambiguator;
}
/**
* @since 3.6
*/
@Override
public Tokenizer getWordTokenizer() {
if (wordTokenizer == null) {
wordTokenizer = new PortugueseWordTokenizer();
}
return wordTokenizer;
}
@Override
public Synthesizer getSynthesizer() {
if (synthesizer == null) {
synthesizer = new PortugueseSynthesizer();
}
return synthesizer;
}
@Override
public SentenceTokenizer getSentenceTokenizer() {
if (sentenceTokenizer == null) {
sentenceTokenizer = new SRXSentenceTokenizer(this);
}
return sentenceTokenizer;
}
@Override
public List<Rule> getRelevantRules(ResourceBundle messages) throws IOException {
return Arrays.asList(
new CommaWhitespaceRule(messages,
Example.wrong("Tomamos café<marker> ,</marker> queijo, bolachas e uvas."),
Example.fixed("Tomamos café<marker>,</marker> queijo, bolachas e uvas")),
new GenericUnpairedBracketsRule(messages),
new HunspellRule(messages, this),
new LongSentenceRule(messages, 45, true),
new UppercaseSentenceStartRule(messages, this,
Example.wrong("Esta casa é velha. <marker>foi</marker> construida em 1950."),
Example.fixed("Esta casa é velha. <marker>Foi</marker> construida em 1950.")),
new MultipleWhitespaceRule(messages, this),
new SentenceWhitespaceRule(messages),
//Specific to Portuguese:
new PostReformPortugueseCompoundRule(messages),
new PortugueseReplaceRule(messages),
new PortugueseReplaceRule2(messages),
new PortugueseClicheRule(messages),
new PortugueseRedundancyRule(messages),
new PortugueseWordynessRule(messages),
new PortugueseWikipediaRule(messages),
new PortugueseWordRepeatRule(messages, this),
new PortugueseWordRepeatBeginningRule(messages, this),
new PortugueseAccentuationCheckRule(messages),
new PortugueseWrongWordInContextRule(messages),
new PortugueseWordCoherencyRule(messages)
);
}
@Override
public LanguageMaintainedState getMaintainedState() {
return LanguageMaintainedState.ActivelyMaintained;
}
/** @since 3.6 */
@Override
public synchronized LanguageModel getLanguageModel(File indexDir) throws IOException {
if (languageModel == null) {
languageModel = new LuceneLanguageModel(new File(indexDir, getShortCode()));
}
return languageModel;
}
/** @since 3.6 */
@Override
public List<Rule> getRelevantLanguageModelRules(ResourceBundle messages, LanguageModel languageModel) throws IOException {
return Arrays.<Rule>asList(
new PortugueseConfusionProbabilityRule(messages, languageModel, this)
);
}
/** @since 3.6 */
@Override
public void close() throws Exception {
if (languageModel != null) {
languageModel.close();
}
}
@Override
public int getPriorityForId(String id) {
switch (id) {
case "FRAGMENT_TWO_ARTICLES": return 50;
case "INTERJECTIONS_PUNTUATION": return 5;
case "PT_MULTI_REPLACE": return -10;
case "PT_PT_SIMPLE_REPLACE": return -11;
case "PT_REDUNDANCY_REPLACE": return -12;
case "PT_WORDYNESS_REPLACE": return -13;
case "PT_CLICHE_REPLACE": return -17;
case "HUNSPELL_RULE": return -20;
case "CRASE_CONFUSION": return -25;
case "FINAL_STOPS": return -35;
case "T-V_DISTINCTION": return -50;
case "T-V_DISTINCTION_ALL": return -51;
case "REPEATED_WORDS": return -90;
case "REPEATED_WORDS_3X": return -91;
case "WIKIPEDIA_COMMON_ERRORS": return -100;
case "TOO_LONG_SENTENCE": return -1000;
}
return 0;
}
}
| [pt] rule priorities adjusted
| languagetool-language-modules/pt/src/main/java/org/languagetool/language/Portuguese.java | [pt] rule priorities adjusted | <ide><path>anguagetool-language-modules/pt/src/main/java/org/languagetool/language/Portuguese.java
<ide> switch (id) {
<ide> case "FRAGMENT_TWO_ARTICLES": return 50;
<ide> case "INTERJECTIONS_PUNTUATION": return 5;
<add> case "PROFANITY": return -1;
<ide> case "PT_MULTI_REPLACE": return -10;
<ide> case "PT_PT_SIMPLE_REPLACE": return -11;
<ide> case "PT_REDUNDANCY_REPLACE": return -12;
<ide> case "PT_WORDYNESS_REPLACE": return -13;
<ide> case "PT_CLICHE_REPLACE": return -17;
<del> case "HUNSPELL_RULE": return -20;
<del> case "CRASE_CONFUSION": return -25;
<del> case "FINAL_STOPS": return -35;
<del> case "T-V_DISTINCTION": return -50;
<del> case "T-V_DISTINCTION_ALL": return -51;
<del> case "REPEATED_WORDS": return -90;
<del> case "REPEATED_WORDS_3X": return -91;
<del> case "WIKIPEDIA_COMMON_ERRORS": return -100;
<add> case "CHILDISH_LANGUAGE": return -25;
<add> case "ARCHAISMS": return -26;
<add> case "INFORMALITIES": return -27;
<add> case "HUNSPELL_RULE": return -40;
<add> case "CRASE_CONFUSION": return -45;
<add> case "FINAL_STOPS": return -55;
<add> case "T-V_DISTINCTION": return -70;
<add> case "T-V_DISTINCTION_ALL": return -71;
<add> case "REPEATED_WORDS": return -110;
<add> case "REPEATED_WORDS_3X": return -111;
<add> case "WIKIPEDIA_COMMON_ERRORS": return -200;
<ide> case "TOO_LONG_SENTENCE": return -1000;
<ide> }
<ide> return 0; |
|
Java | apache-2.0 | f9d413947f7b7b002407924d9d40a2ec5a40b7eb | 0 | ppavlidis/Gemma,ppavlidis/Gemma,ppavlidis/Gemma,ppavlidis/Gemma,ppavlidis/Gemma,ppavlidis/Gemma,ppavlidis/Gemma | /*
* The linkAnalysis project
*
* Copyright (c) 2006 University of British Columbia
*
* 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 ubic.gemma.analysis.expression.coexpression.links;
import java.util.Collection;
import ubic.basecode.dataStructure.matrix.CompressedSparseDoubleMatrix;
import ubic.basecode.math.CorrelationStats;
import ubic.gemma.datastructure.matrix.ExpressionDataDoubleMatrix;
import ubic.gemma.datastructure.matrix.ExpressionDataMatrixRowElement;
import ubic.gemma.model.common.quantitationtype.GeneralType;
import ubic.gemma.model.common.quantitationtype.PrimitiveType;
import ubic.gemma.model.common.quantitationtype.QuantitationType;
import ubic.gemma.model.common.quantitationtype.ScaleType;
import ubic.gemma.model.common.quantitationtype.StandardQuantitationType;
import ubic.gemma.model.genome.Gene;
import cern.colt.list.ObjectArrayList;
/**
* A correlation analysis for a given data set, designed for selection of values based on critera set by the user.
* <p>
* On the first pass over the data, a histogram is filled in to hold the distribution of the values found. You can set
* criteria to have the correlations actually stored in a (sparse) matrix. This can take a lot of memory if you store
* everything!
* <p>
* The correlation is only calculated if it isn't stored in the matrix, and values can be tested against a threshold.
* <p>
* This class is used in reality by one pass over the data to fill in the histogram. This is used to help select a
* threshold. A second pass over the data is used to select correlations that meet the criteria.
* <p>
*
* @author Paul Pavlidis
* @version $Id$
*/
public class MatrixRowPairPearsonAnalysis extends AbstractMatrixRowPairAnalysis {
protected double[] rowMeans = null;
protected double[] rowSumSquaresSqrt = null;
protected MatrixRowPairPearsonAnalysis() {
}
/**
* @param
*/
public MatrixRowPairPearsonAnalysis( ExpressionDataDoubleMatrix dataMatrix ) {
this( dataMatrix.rows() );
this.dataMatrix = dataMatrix;
this.numMissing = this.fillUsed();
}
/**
* @param dataMatrix DenseDoubleMatrix2DNamed
* @param tmts Values of the correlation that are deemed too small to store in the matrix. Setting this as high as
* possible can greatly reduce memory requirements, but can slow things down.
*/
public MatrixRowPairPearsonAnalysis( ExpressionDataDoubleMatrix dataMatrix, double tmts ) {
this( dataMatrix );
this.setStorageThresholdValue( tmts );
}
/**
* @param size Dimensions of the required (square) matrix.
*/
private MatrixRowPairPearsonAnalysis( int size ) {
if ( size > 0 ) {
results = new CompressedSparseDoubleMatrix<ExpressionDataMatrixRowElement, ExpressionDataMatrixRowElement>(
size, size );
}
keepers = new ObjectArrayList();
}
/**
* Calculate the linear correlation matrix of a matrix, allowing missing values. If there are no missing values,
* this calls PearsonFast.
*/
public void calculateMetrics() {
if ( this.numMissing == 0 ) {
calculateMetricsFast();
return;
}
int numused;
int numrows = this.dataMatrix.rows();
int numcols = this.dataMatrix.columns();
boolean docalcs = this.needToCalculateMetrics();
boolean[][] usedB = new boolean[][] {};
double[][] data = new double[][] {};
if ( docalcs ) {
// Temporarily copy the data in this matrix, for performance.
usedB = new boolean[numrows][numcols];
data = new double[numrows][numcols];
for ( int i = 0; i < numrows; i++ ) { // first vector
for ( int j = 0; j < numcols; j++ ) { // second vector
usedB[i][j] = used.get( i, j ); // this is only needed if we use it below, speeds things up
// slightly.
data[i][j] = this.dataMatrix.get( i, j );
}
}
rowStatistics();
}
/* for each vector, compare it to all other vectors */
ExpressionDataMatrixRowElement itemA = null;
double[] vectorA = new double[] {};
double syy, sxy, sxx, sx, sy, xj, yj;
int count = 0;
int numComputed = 0;
for ( int i = 0; i < numrows; i++ ) { // first vector
itemA = this.dataMatrix.getRowElement( i );
if ( !this.hasGene( itemA ) ) continue;
if ( docalcs ) {
vectorA = data[i];
}
boolean thisRowHasMissing = hasMissing[i];
for ( int j = i + 1; j < numrows; j++ ) { // second vector
ExpressionDataMatrixRowElement itemB = this.dataMatrix.getRowElement( j );
if ( !this.hasGene( itemB ) ) continue;
// second pass over matrix? Don't calculate it if we already have it. Just do the requisite checks.
if ( !docalcs || results.get( i, j ) != 0.0 ) {
keepCorrel( i, j, results.get( i, j ), numcols );
continue;
}
double[] vectorB = data[j];
/* if there are no missing values, use the faster method of calculation */
if ( !thisRowHasMissing && !hasMissing[j] ) {
setCorrel( i, j, correlFast( vectorA, vectorB, i, j ), numcols );
continue;
}
/* do it the old fashioned way */
numused = 0;
sxy = 0.0;
sxx = 0.0;
syy = 0.0;
sx = 0.0;
sy = 0.0;
for ( int k = 0; k < numcols; k++ ) {
xj = vectorA[k];
yj = vectorB[k];
if ( usedB[i][k] && usedB[j][k] ) { /* this is a bit faster than calling Double.isNan */
sx += xj;
sy += yj;
sxy += xj * yj;
sxx += xj * xj;
syy += yj * yj;
numused++;
}
}
// avoid -1 correlations or extremely noisy values (minNumUsed should be set high enough so that degrees
// of freedom isn't too low.
if ( numused < minNumUsed )
setCorrel( i, j, Double.NaN, 0 );
else {
double denom = correlationNorm( numused, sxx, sx, syy, sy );
if ( denom <= 0.0 ) { // means variance is zero for one of the vectors.
setCorrel( i, j, 0.0, numused );
} else {
double correl = ( sxy - sx * sy / numused ) / Math.sqrt( denom );
setCorrel( i, j, correl, numused );
}
}
++numComputed;
}
if ( ++count % 2000 == 0 ) {
log.info( count + " rows done, " + numComputed + " correlations computed, last row was " + itemA + " "
+ ( keepers.size() > 0 ? keepers.size() + " scores retained" : "" ) );
}
}
finishMetrics();
}
/*
* (non-Javadoc)
* @see ubic.gemma.analysis.linkAnalysis.MatrixRowPairAnalysis#getMetricType()
*/
public QuantitationType getMetricType() {
QuantitationType m = QuantitationType.Factory.newInstance();
m.setIsBackground( false );
m.setIsBackgroundSubtracted( false );
m.setIsNormalized( false );
m.setIsPreferred( false );
m.setIsMaskedPreferred( false );
m.setIsRatio( false );
m.setType( StandardQuantitationType.CORRELATION );
m.setName( "Pearson correlation" );
m.setGeneralType( GeneralType.QUANTITATIVE );
m.setRepresentation( PrimitiveType.DOUBLE );
m.setScale( ScaleType.LINEAR );
return m;
}
/**
* Calculate a linear correlation matrix for a matrix. Use this if you know there are no missing values, or don't
* care about NaNs.
*
* @param duplicates The map containing information about what items are the 'same' as other items; such are
* skipped.
*/
private void calculateMetricsFast() {
int numrows = this.dataMatrix.rows();
int numcols = this.dataMatrix.columns();
boolean docalcs = this.needToCalculateMetrics();
double[][] data = new double[][] {};
if ( docalcs ) {
rowStatistics();
// Temporarily put the data in this matrix (performance)
data = new double[numrows][numcols];
for ( int i = 0; i < numrows; i++ ) { // first vector
for ( int j = 0; j < numcols; j++ ) { // second vector
data[i][j] = this.dataMatrix.get( i, j );
}
}
}
/*
* For each vector, compare it to all other vectors, avoid repeating things; skip items that don't have genes
* mapped to them.
*/
ExpressionDataMatrixRowElement itemA = null;
ExpressionDataMatrixRowElement itemB = null;
double[] vectorA = null;
int count = 0;
int numComputed = 0;
for ( int i = 0; i < numrows; i++ ) {
itemA = this.dataMatrix.getRowElement( i );
if ( !this.hasGene( itemA ) ) continue;
if ( docalcs ) {
vectorA = data[i];
}
for ( int j = i + 1; j < numrows; j++ ) {
itemB = this.dataMatrix.getRowElement( j );
if ( !this.hasGene( itemB ) ) continue;
if ( !docalcs || results.get( i, j ) != 0.0 ) { // second pass over matrix. Don't calculate it
// if we
// already have it. Just do the requisite checks.
keepCorrel( i, j, results.get( i, j ), numcols );
continue;
}
double[] vectorB = data[j];
setCorrel( i, j, correlFast( vectorA, vectorB, i, j ), numcols );
++numComputed;
}
if ( ++count % 2000 == 0 ) {
log.info( count + " rows done, " + numComputed + " correlations computed, last row was " + itemA + " "
+ ( keepers.size() > 0 ? keepers.size() + " scores retained" : "" ) );
}
}
finishMetrics();
}
/*
* (non-Javadoc)
* @see ubic.gemma.analysis.linkAnalysis.MatrixRowPairAnalysis#correctedPvalue(int, int, double, int)
*/
public double correctedPvalue( int i, int j, double correl, int numused ) {
double p = CorrelationStats.pvalue( correl, numused );
double k = 1, m = 1;
Collection<Collection<Gene>> clusters = getGenesForRow( i );
if ( clusters != null ) {
for ( Collection<Gene> geneIdSet : clusters ) {
/*
* Note we break on the first iteration because the number of probes per gene in the same cluster is
* constant.
*/
for ( Gene geneId : geneIdSet ) {
int tmpK = this.geneToProbeMap.get( geneId ).size() + 1;
if ( k < tmpK ) k = tmpK;
break;
}
}
}
clusters = getGenesForRow( j );
if ( clusters != null ) {
for ( Collection<Gene> geneIdSet : clusters ) {
for ( Gene geneId : geneIdSet ) {
int tmpM = this.geneToProbeMap.get( geneId ).size() + 1;
if ( m < tmpM ) m = tmpM;
break;
}
}
}
return p * k * m;
}
/**
* @return double
* @param n int
* @param sxx double
* @param sx double
* @param syy double
* @param sy double
*/
protected double correlationNorm( int n, double sxx, double sx, double syy, double sy ) {
return ( sxx - sx * sx / n ) * ( syy - sy * sy / n );
}
/**
* @param ival double[]
* @param jval double[]
* @param i int
* @param j int
* @return double
*/
protected double correlFast( double[] ival, double[] jval, int i, int j ) {
double ssi = rowSumSquaresSqrt[i];
double ssj = rowSumSquaresSqrt[j];
double mi = rowMeans[i];
double mj = rowMeans[j];
return correlFast( ival, jval, ssi, ssj, mi, mj );
}
/**
* Compute a correlation. For Spearman, the values entered must be the ranks.
*
* @param ival
* @param jval
* @param ssi root sum squared deviation
* @param ssj root sum squared deviation
* @param mi row mean of the ranks
* @param mj row mean of the ranks
* @return
*/
protected double correlFast( double[] ival, double[] jval, double ssi, double ssj, double mi, double mj ) {
if ( ssi == 0 || ssj == 0 ) return Double.NaN;
double sxy = 0.0;
for ( int k = 0, n = ival.length; k < n; k++ ) {
sxy += ( ival[k] - mi ) * ( jval[k] - mj );
}
double c = sxy / ( ssi * ssj );
// should never have roundoff errors this large.
assert c > -1.0001 && c < 1.0001 : c;
// roundoff guard
if ( c < -1.0 ) {
c = -1.0;
} else if ( c > 1.0 ) {
c = 1.0;
}
return c;
}
/**
* Calculate mean and sumsqsqrt for each row
*/
protected void rowStatistics() {
int numrows = dataMatrix.rows();
this.rowMeans = new double[numrows];
this.rowSumSquaresSqrt = new double[numrows];
for ( int i = 0, numcols = dataMatrix.columns(); i < numrows; i++ ) {
double ax = 0.0;
double sxx = 0.0;
for ( int j = 0; j < numcols; j++ ) {
ax += this.dataMatrix.get( i, j );
}
rowMeans[i] = ( ax / numcols );
for ( int j = 0; j < numcols; j++ ) {
double xt = this.dataMatrix.get( i, j ) - rowMeans[i]; /* deviation from mean */
sxx += xt * xt; /* sum of squared error */
}
rowSumSquaresSqrt[i] = Math.sqrt( sxx );
}
}
}
| gemma-core/src/main/java/ubic/gemma/analysis/expression/coexpression/links/MatrixRowPairPearsonAnalysis.java | /*
* The linkAnalysis project
*
* Copyright (c) 2006 University of British Columbia
*
* 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 ubic.gemma.analysis.expression.coexpression.links;
import java.util.Collection;
import ubic.basecode.dataStructure.matrix.CompressedSparseDoubleMatrix;
import ubic.basecode.math.CorrelationStats;
import ubic.gemma.datastructure.matrix.ExpressionDataDoubleMatrix;
import ubic.gemma.datastructure.matrix.ExpressionDataMatrixRowElement;
import ubic.gemma.model.common.quantitationtype.GeneralType;
import ubic.gemma.model.common.quantitationtype.PrimitiveType;
import ubic.gemma.model.common.quantitationtype.QuantitationType;
import ubic.gemma.model.common.quantitationtype.ScaleType;
import ubic.gemma.model.common.quantitationtype.StandardQuantitationType;
import ubic.gemma.model.genome.Gene;
import cern.colt.list.ObjectArrayList;
/**
* A correlation analysis for a given data set, designed for selection of values based on critera set by the user.
* <p>
* On the first pass over the data, a histogram is filled in to hold the distribution of the values found. You can set
* criteria to have the correlations actually stored in a (sparse) matrix. This can take a lot of memory if you store
* everything!
* <p>
* The correlation is only calculated if it isn't stored in the matrix, and values can be tested against a threshold.
* <p>
* This class is used in reality by one pass over the data to fill in the histogram. This is used to help select a
* threshold. A second pass over the data is used to select correlations that meet the criteria.
* <p>
*
* @author Paul Pavlidis
* @version $Id$
*/
public class MatrixRowPairPearsonAnalysis extends AbstractMatrixRowPairAnalysis {
protected double[] rowMeans = null;
protected double[] rowSumSquaresSqrt = null;
protected MatrixRowPairPearsonAnalysis() {
}
/**
* @param
*/
public MatrixRowPairPearsonAnalysis( ExpressionDataDoubleMatrix dataMatrix ) {
this( dataMatrix.rows() );
this.dataMatrix = dataMatrix;
this.numMissing = this.fillUsed();
}
/**
* @param dataMatrix DenseDoubleMatrix2DNamed
* @param tmts Values of the correlation that are deemed too small to store in the matrix. Setting this as high as
* possible can greatly reduce memory requirements, but can slow things down.
*/
public MatrixRowPairPearsonAnalysis( ExpressionDataDoubleMatrix dataMatrix, double tmts ) {
this( dataMatrix );
this.setStorageThresholdValue( tmts );
}
/**
* @param size Dimensions of the required (square) matrix.
*/
private MatrixRowPairPearsonAnalysis( int size ) {
if ( size > 0 ) {
results = new CompressedSparseDoubleMatrix<ExpressionDataMatrixRowElement, ExpressionDataMatrixRowElement>(
size, size );
}
keepers = new ObjectArrayList();
}
/**
* Calculate the linear correlation matrix of a matrix, allowing missing values. If there are no missing values,
* this calls PearsonFast.
*/
public void calculateMetrics() {
if ( this.numMissing == 0 ) {
calculateMetricsFast();
return;
}
int numused;
int numrows = this.dataMatrix.rows();
int numcols = this.dataMatrix.columns();
boolean docalcs = this.needToCalculateMetrics();
boolean[][] usedB = new boolean[][] {};
double[][] data = new double[][] {};
if ( docalcs ) {
// Temporarily copy the data in this matrix, for performance.
usedB = new boolean[numrows][numcols];
data = new double[numrows][numcols];
for ( int i = 0; i < numrows; i++ ) { // first vector
for ( int j = 0; j < numcols; j++ ) { // second vector
usedB[i][j] = used.get( i, j ); // this is only needed if we use it below, speeds things up
// slightly.
data[i][j] = this.dataMatrix.get( i, j );
}
}
rowStatistics();
}
/* for each vector, compare it to all other vectors */
ExpressionDataMatrixRowElement itemA = null;
double[] vectorA = new double[] {};
double syy, sxy, sxx, sx, sy, xj, yj;
int count = 0;
int numComputed = 0;
for ( int i = 0; i < numrows; i++ ) { // first vector
itemA = this.dataMatrix.getRowElement( i );
if ( !this.hasGene( itemA ) ) continue;
if ( docalcs ) {
vectorA = data[i];
}
boolean thisRowHasMissing = hasMissing[i];
for ( int j = i + 1; j < numrows; j++ ) { // second vector
ExpressionDataMatrixRowElement itemB = this.dataMatrix.getRowElement( j );
if ( !this.hasGene( itemB ) ) continue;
// second pass over matrix? Don't calculate it if we already have it. Just do the requisite checks.
if ( !docalcs || results.get( i, j ) != 0.0 ) {
keepCorrel( i, j, results.get( i, j ), numcols );
continue;
}
double[] vectorB = data[j];
/* if there are no missing values, use the faster method of calculation */
if ( !thisRowHasMissing && !hasMissing[j] ) {
setCorrel( i, j, correlFast( vectorA, vectorB, i, j ), numcols );
continue;
}
/* do it the old fashioned way */
numused = 0;
sxy = 0.0;
sxx = 0.0;
syy = 0.0;
sx = 0.0;
sy = 0.0;
for ( int k = 0; k < numcols; k++ ) {
xj = vectorA[k];
yj = vectorB[k];
if ( usedB[i][k] && usedB[j][k] ) { /* this is a bit faster than calling Double.isNan */
sx += xj;
sy += yj;
sxy += xj * yj;
sxx += xj * xj;
syy += yj * yj;
numused++;
}
}
// avoid -1 correlations or extremely noisy values (minNumUsed should be set high enough so that degrees
// of freedom isn't too low.
if ( numused < minNumUsed )
setCorrel( i, j, Double.NaN, 0 );
else {
double denom = correlationNorm( numused, sxx, sx, syy, sy );
if ( denom <= 0.0 ) { // means variance is zero for one of the vectors.
setCorrel( i, j, 0.0, numused );
} else {
double correl = ( sxy - sx * sy / numused ) / Math.sqrt( denom );
setCorrel( i, j, correl, numused );
}
}
++numComputed;
}
if ( ++count % 2000 == 0 ) {
log.info( count + " rows done, " + numComputed + " correlations computed, last row was " + itemA + " "
+ ( keepers.size() > 0 ? keepers.size() + " scores retained" : "" ) );
}
}
finishMetrics();
}
/*
* (non-Javadoc)
* @see ubic.gemma.analysis.linkAnalysis.MatrixRowPairAnalysis#getMetricType()
*/
public QuantitationType getMetricType() {
QuantitationType m = QuantitationType.Factory.newInstance();
m.setIsBackground( false );
m.setIsBackgroundSubtracted( false );
m.setIsNormalized( false );
m.setIsPreferred( false );
m.setIsMaskedPreferred( false );
m.setIsRatio( false );
m.setType( StandardQuantitationType.CORRELATION );
m.setName( "Pearson correlation" );
m.setGeneralType( GeneralType.QUANTITATIVE );
m.setRepresentation( PrimitiveType.DOUBLE );
m.setScale( ScaleType.LINEAR );
return m;
}
/**
* Calculate a linear correlation matrix for a matrix. Use this if you know there are no missing values, or don't
* care about NaNs.
*
* @param duplicates The map containing information about what items are the 'same' as other items; such are
* skipped.
*/
private void calculateMetricsFast() {
int numrows = this.dataMatrix.rows();
int numcols = this.dataMatrix.columns();
boolean docalcs = this.needToCalculateMetrics();
double[][] data = new double[][] {};
if ( docalcs ) {
rowStatistics();
// Temporarily put the data in this matrix (performance)
data = new double[numrows][numcols];
for ( int i = 0; i < numrows; i++ ) { // first vector
for ( int j = 0; j < numcols; j++ ) { // second vector
data[i][j] = this.dataMatrix.get( i, j );
}
}
}
/*
* For each vector, compare it to all other vectors, avoid repeating things; skip items that don't have genes
* mapped to them.
*/
ExpressionDataMatrixRowElement itemA = null;
ExpressionDataMatrixRowElement itemB = null;
double[] vectorA = null;
int count = 0;
int numComputed = 0;
for ( int i = 0; i < numrows; i++ ) {
itemA = this.dataMatrix.getRowElement( i );
if ( !this.hasGene( itemA ) ) continue;
if ( docalcs ) {
vectorA = data[i];
}
for ( int j = i + 1; j < numrows; j++ ) {
itemB = this.dataMatrix.getRowElement( j );
if ( !this.hasGene( itemB ) ) continue;
if ( !docalcs || results.get( i, j ) != 0.0 ) { // second pass over matrix. Don't calculate it
// if we
// already have it. Just do the requisite checks.
keepCorrel( i, j, results.get( i, j ), numcols );
continue;
}
double[] vectorB = data[j];
setCorrel( i, j, correlFast( vectorA, vectorB, i, j ), numcols );
++numComputed;
}
if ( ++count % 2000 == 0 ) {
log.info( count + " rows done, " + numComputed + " correlations computed, last row was " + itemA + " "
+ ( keepers.size() > 0 ? keepers.size() + " scores retained" : "" ) );
}
}
finishMetrics();
}
/*
* (non-Javadoc)
* @see ubic.gemma.analysis.linkAnalysis.MatrixRowPairAnalysis#correctedPvalue(int, int, double, int)
*/
public double correctedPvalue( int i, int j, double correl, int numused ) {
double p = CorrelationStats.pvalue( correl, numused );
double k = 1, m = 1;
Collection<Collection<Gene>> clusters = getGenesForRow( i );
if ( clusters != null ) {
for ( Collection<Gene> geneIdSet : clusters ) {
/*
* Note we break on the first iteration because the number of probes per gene in the same cluster is
* constant.
*/
for ( Gene geneId : geneIdSet ) {
int tmpK = this.geneToProbeMap.get( geneId ).size() + 1;
if ( k < tmpK ) k = tmpK;
break;
}
}
}
clusters = getGenesForRow( j );
if ( clusters != null ) {
for ( Collection<Gene> geneIdSet : clusters ) {
for ( Gene geneId : geneIdSet ) {
int tmpM = this.geneToProbeMap.get( geneId ).size() + 1;
if ( m < tmpM ) m = tmpM;
break;
}
}
}
return p * k * m;
}
/**
* @return double
* @param n int
* @param sxx double
* @param sx double
* @param syy double
* @param sy double
*/
protected double correlationNorm( int n, double sxx, double sx, double syy, double sy ) {
return ( sxx - sx * sx / n ) * ( syy - sy * sy / n );
}
/**
* @param ival double[]
* @param jval double[]
* @param i int
* @param j int
* @return double
*/
protected double correlFast( double[] ival, double[] jval, int i, int j ) {
double ssi = rowSumSquaresSqrt[i];
double ssj = rowSumSquaresSqrt[j];
double mi = rowMeans[i];
double mj = rowMeans[j];
return correlFast( ival, jval, ssi, ssj, mi, mj );
}
/**
* Compute a correlation. For Spearman, the values entered must be the ranks.
*
* @param ival
* @param jval
* @param ssi root sum squared deviation
* @param ssj root sum squared deviation
* @param mi row mean of the ranks
* @param mj row mean of the ranks
* @return
*/
protected double correlFast( double[] ival, double[] jval, double ssi, double ssj, double mi, double mj ) {
if ( ssi == 0 || ssj == 0 ) return Double.NaN;
double sxy = 0.0;
for ( int k = 0, n = ival.length; k < n; k++ ) {
sxy += ( ival[k] - mi ) * ( jval[k] - mj );
}
double c = sxy / ( ssi * ssj );
assert c > -1.0001 && c < 1.0001 : c;
return c;
}
/**
* Calculate mean and sumsqsqrt for each row
*/
protected void rowStatistics() {
int numrows = dataMatrix.rows();
this.rowMeans = new double[numrows];
this.rowSumSquaresSqrt = new double[numrows];
for ( int i = 0, numcols = dataMatrix.columns(); i < numrows; i++ ) {
double ax = 0.0;
double sxx = 0.0;
for ( int j = 0; j < numcols; j++ ) {
ax += this.dataMatrix.get( i, j );
}
rowMeans[i] = ( ax / numcols );
for ( int j = 0; j < numcols; j++ ) {
double xt = this.dataMatrix.get( i, j ) - rowMeans[i]; /* deviation from mean */
sxx += xt * xt; /* sum of squared error */
}
rowSumSquaresSqrt[i] = Math.sqrt( sxx );
}
}
}
| bug 1616: put roundoff guard back in
| gemma-core/src/main/java/ubic/gemma/analysis/expression/coexpression/links/MatrixRowPairPearsonAnalysis.java | bug 1616: put roundoff guard back in | <ide><path>emma-core/src/main/java/ubic/gemma/analysis/expression/coexpression/links/MatrixRowPairPearsonAnalysis.java
<ide> }
<ide> double c = sxy / ( ssi * ssj );
<ide>
<add> // should never have roundoff errors this large.
<ide> assert c > -1.0001 && c < 1.0001 : c;
<add>
<add> // roundoff guard
<add> if ( c < -1.0 ) {
<add> c = -1.0;
<add> } else if ( c > 1.0 ) {
<add> c = 1.0;
<add> }
<ide>
<ide> return c;
<ide> } |
|
Java | epl-1.0 | ff0262ea6230a9f28ad2b5faf28540142bb5de84 | 0 | sguan-actuate/birt,rrimmana/birt-1,sguan-actuate/birt,Charling-Huang/birt,sguan-actuate/birt,rrimmana/birt-1,Charling-Huang/birt,rrimmana/birt-1,rrimmana/birt-1,rrimmana/birt-1,Charling-Huang/birt,sguan-actuate/birt,Charling-Huang/birt,sguan-actuate/birt,Charling-Huang/birt | /*******************************************************************************
* Copyright (c) 2004 Actuate Corporation .
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Actuate Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.birt.report.designer.ui.wizards;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.birt.report.designer.internal.ui.util.ExceptionHandler;
import org.eclipse.birt.report.designer.internal.ui.util.UIUtil;
import org.eclipse.birt.report.designer.nls.Messages;
import org.eclipse.birt.report.designer.ui.ReportPlugin;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceVisitor;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExecutableExtension;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.INewWizard;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.WizardNewFileCreationPage;
import org.eclipse.ui.ide.IDE;
import org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard;
/**
* BIRT Project Wizard.
*
*/
public class NewLibraryWizard extends Wizard implements INewWizard, IExecutableExtension
{
private static final String OPENING_FILE_FOR_EDITING = Messages.getString( "NewLibraryWizard.text.OpenFileForEditing" ); //$NON-NLS-1$
private static final String CREATING = Messages.getString( "NewLibraryWizard.text.Creating" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_NAME_PREFIX = Messages.getString( "NewLibraryWizard.displayName.NewReportFileNamePrefix" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_EXTENSION = Messages.getString( "NewLibraryWizard.displayName.NewReportFileExtension" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_NAME = NEW_REPORT_FILE_NAME_PREFIX
+ NEW_REPORT_FILE_EXTENSION;
private static final String CREATE_A_NEW_REPORT = Messages.getString( "NewLibraryWizard.text.CreateReport" ); //$NON-NLS-1$
private static final String REPORT = Messages.getString( "NewLibraryWizard.title.Report" ); //$NON-NLS-1$
private static final String WIZARDPAGE = Messages.getString( "NewLibraryWizard.title.WizardPage" ); //$NON-NLS-1$
private static final String NEW = Messages.getString( "NewLibraryWizard.title.New" ); //$NON-NLS-1$
// private static final String CHOOSE_FROM_TEMPLATE = Messages.getString(
// "NewReportWizard.title.Choose" ); //$NON-NLS-1$
/** Holds selected project resource for run method access */
private IStructuredSelection selection;
private WizardNewFileCreationPage newReportFileWizardPage;
private int UNIQUE_COUNTER = 0;
// private WizardChoicePage choicePage;
// private WizardCustomTemplatePage customTemplatePage;
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.Wizard#performFinish()
*/
public boolean performFinish( )
{
final IPath containerName = newReportFileWizardPage.getContainerFullPath( );
String fn = newReportFileWizardPage.getFileName( );
final String fileName;
if ( !fn.endsWith( ".rptlibrary" ) ) //$NON-NLS-1$
{
fileName = fn + ".rptlibrary"; //$NON-NLS-1$
}
else
{
fileName = fn;
}
InputStream streamFromPage = null;
URL url = Platform.find( Platform.getBundle( ReportPlugin.REPORT_UI ),
new Path( "/templates/blank_library.rptlibrary" ) );
if ( url != null )
{
try
{
streamFromPage = url.openStream( );
}
catch ( IOException e1 )
{
//ignore.
}
}
final InputStream stream = streamFromPage;
IRunnableWithProgress op = new IRunnableWithProgress( ) {
public void run( IProgressMonitor monitor )
throws InvocationTargetException
{
try
{
doFinish( containerName,
fileName,
stream,
monitor );
}
catch ( CoreException e )
{
throw new InvocationTargetException( e );
}
finally
{
monitor.done( );
}
}
};
try
{
getContainer( ).run( true, false, op );
}
catch ( InterruptedException e )
{
return false;
}
catch ( InvocationTargetException e )
{
Throwable realException = e.getTargetException( );
ExceptionHandler.handle( realException );
return false;
}
return true;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.IWorkbenchWizard#init(org.eclipse.ui.IWorkbench,
* org.eclipse.jface.viewers.IStructuredSelection)
*/
public void init( IWorkbench workbench, IStructuredSelection selection )
{
// check existing open project
IWorkspaceRoot root = ResourcesPlugin.getWorkspace( ).getRoot( );
IProject projects[] = root.getProjects( );
boolean foundOpenProject = false;
for ( int i = 0; i < projects.length; i++ )
{
if ( projects[i].isOpen( ) )
{
foundOpenProject = true;
break;
}
}
if ( !foundOpenProject )
{
MessageDialog.openError( getShell( ),
Messages.getString( "NewReportWizard.title.Error" ), //$NON-NLS-1$
Messages.getString( "NewReportWizard.error.NoProject" ) ); //$NON-NLS-1$
// abort wizard. There is no clean way to do it.
/**
* Remove the exception here 'cause It's safe since the wizard won't
* create any file without an open project.
*/
//throw new RuntimeException( );
}
// OK
this.selection = selection;
setWindowTitle( NEW );
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.IWizard#getDefaultPageImage()
*/
public Image getDefaultPageImage( )
{
return ReportPlugin.getImage( "/icons/wizban/create_report_wizard.gif" ); //$NON-NLS-1$
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.IWizard#addPages()
*/
public void addPages( )
{
newReportFileWizardPage = new WizardNewFileCreationPage( WIZARDPAGE,
selection );
addPage( newReportFileWizardPage );
// set titles
newReportFileWizardPage.setTitle( REPORT );
newReportFileWizardPage.setDescription( CREATE_A_NEW_REPORT );
resetUniqueCount( );
newReportFileWizardPage.setFileName( getUniqueReportName( ) );
newReportFileWizardPage.setContainerFullPath( getDefaultContainerPath( ) );
}
private void resetUniqueCount( )
{
UNIQUE_COUNTER = 0;
}
private IPath getDefaultContainerPath( )
{
IWorkbenchWindow benchWindow = PlatformUI.getWorkbench( )
.getActiveWorkbenchWindow( );
IWorkbenchPart part = benchWindow.getPartService( ).getActivePart( );
Object selection = null;
if ( part instanceof IEditorPart )
{
selection = ( (IEditorPart) part ).getEditorInput( );
}
else
{
ISelection sel = benchWindow.getSelectionService( ).getSelection( );
if ( ( sel != null ) && ( sel instanceof IStructuredSelection ) )
{
selection = ( (IStructuredSelection) sel ).getFirstElement( );
}
}
IContainer ct = getDefaultContainer( selection );
if ( ct == null )
{
IEditorPart editor = UIUtil.getActiveEditor( true );
if ( editor != null )
{
ct = getDefaultContainer( editor.getEditorInput( ) );
}
}
if ( ct != null )
{
return ct.getFullPath( );
}
return null;
}
private IContainer getDefaultContainer( Object selection )
{
IContainer ct = null;
if ( selection instanceof IAdaptable )
{
IResource resource = (IResource) ( (IAdaptable) selection ).getAdapter( IResource.class );
if ( resource instanceof IContainer && resource.isAccessible( ) )
{
ct = (IContainer) resource;
}
else if ( resource != null
&& resource.getParent( ) != null
&& resource.getParent( ).isAccessible( ) )
{
ct = resource.getParent( );
}
}
return ct;
}
private String getUniqueReportName( )
{
IProject[] pjs = ResourcesPlugin.getWorkspace( )
.getRoot( )
.getProjects( );
resetUniqueCount( );
boolean goon = true;
while ( goon )
{
goon = false;
for ( int i = 0; i < pjs.length; i++ )
{
if ( pjs[i].isAccessible( ) )
{
if ( !validDuplicate( NEW_REPORT_FILE_NAME_PREFIX,
NEW_REPORT_FILE_EXTENSION,
UNIQUE_COUNTER,
pjs[i] ) )
{
UNIQUE_COUNTER++;
goon = true;
break;
}
}
}
}
if ( UNIQUE_COUNTER == 0 )
{
return NEW_REPORT_FILE_NAME;
}
return NEW_REPORT_FILE_NAME_PREFIX + "_" //$NON-NLS-1$
+ UNIQUE_COUNTER + NEW_REPORT_FILE_EXTENSION; //$NON-NLS-1$
}
private static final List tmpList = new ArrayList( );
private IConfigurationElement configElement;
private boolean validDuplicate( String prefix, String ext, int count,
IResource res )
{
if ( res != null && res.isAccessible( ) )
{
final String name;
if ( count == 0 )
{
name = prefix + ext;
}
else
{
name = prefix + "_" + count + ext; //$NON-NLS-1$
}
try
{
tmpList.clear( );
res.accept( new IResourceVisitor( ) {
public boolean visit( IResource resource )
throws CoreException
{
if ( resource.getType( ) == IResource.FILE
&& name.equals( ( (IFile) resource ).getName( ) ) )
{
tmpList.add( Boolean.TRUE );
}
return true;
}
},
IResource.DEPTH_INFINITE,
true );
if ( tmpList.size( ) > 0 )
{
return false;
}
}
catch ( CoreException e )
{
ExceptionHandler.handle( e );
}
}
return true;
}
/**
* Creates a folder resource handle for the folder with the given workspace path.
* This method does not create the folder resource; this is the responsibility
* of <code>createFolder</code>.
*
* @param folderPath the path of the folder resource to create a handle for
* @return the new folder resource handle
*/
protected IFolder createFolderHandle( IPath folderPath )
{
IWorkspaceRoot workspaceRoot = ResourcesPlugin.getWorkspace( )
.getRoot( );
return workspaceRoot.getFolder( folderPath );
}
/**
* The worker method. It will find the container, create the file if missing
* or just replace its contents, and open the editor on the newly created
* file.
*
* @param cheatSheetId
*
* @param containerName
* @param fileName
* @param showCheatSheet
* @param monitor
*/
private void doFinish( IPath containerName, String fileName,
InputStream stream,
IProgressMonitor monitor ) throws CoreException
{
// create a sample file
monitor.beginTask( CREATING + fileName, 2 );
IResource resource = (IContainer) ResourcesPlugin.getWorkspace( )
.getRoot( )
.findMember( containerName );
IContainer container = null;
if ( resource == null
|| !resource.exists( ) || !( resource instanceof IContainer ) )
{
// create folder if not exist
IFolder folder = createFolderHandle( containerName );
UIUtil.createFolder( folder, monitor );
container = folder;
}
else
{
container = (IContainer) resource;
}
final IFile file = container.getFile( new Path( fileName ) );
try
{
if ( file.exists( ) )
{
file.setContents( stream, true, true, monitor );
}
else
{
file.create( stream, true, monitor );
}
stream.close( );
}
catch ( IOException e )
{
}
monitor.worked( 1 );
monitor.setTaskName( OPENING_FILE_FOR_EDITING );
getShell( ).getDisplay( ).asyncExec( new Runnable( ) {
public void run( )
{
IWorkbench workbench = PlatformUI.getWorkbench( );
IWorkbenchWindow window = workbench.getActiveWorkbenchWindow( );
IWorkbenchPage page = window.getActivePage( );
try
{
IDE.openEditor( page, file, true );
BasicNewProjectResourceWizard.updatePerspective( getConfigElement() );
}
catch ( Exception e )
{
ExceptionHandler.handle( e );
}
}
} );
monitor.worked( 1 );
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IExecutableExtension#setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)
*/
public void setInitializationData( IConfigurationElement config, String propertyName, Object data ) throws CoreException
{
this.configElement = config;
}
public IConfigurationElement getConfigElement( )
{
return configElement;
}
}
| UI/org.eclipse.birt.report.designer.ui.lib/src/org/eclipse/birt/report/designer/ui/wizards/NewLibraryWizard.java | /*******************************************************************************
* Copyright (c) 2004 Actuate Corporation .
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Actuate Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.birt.report.designer.ui.wizards;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.birt.report.designer.internal.ui.util.ExceptionHandler;
import org.eclipse.birt.report.designer.internal.ui.util.UIUtil;
import org.eclipse.birt.report.designer.nls.Messages;
import org.eclipse.birt.report.designer.ui.ReportPlugin;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IFolder;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceVisitor;
import org.eclipse.core.resources.IWorkspaceRoot;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExecutableExtension;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.jface.operation.IRunnableWithProgress;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.wizard.Wizard;
import org.eclipse.swt.graphics.Image;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.INewWizard;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchPart;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.WizardNewFileCreationPage;
import org.eclipse.ui.ide.IDE;
/**
* BIRT Project Wizard.
*
*/
public class NewLibraryWizard extends Wizard implements INewWizard, IExecutableExtension
{
private static final String OPENING_FILE_FOR_EDITING = Messages.getString( "NewLibraryWizard.text.OpenFileForEditing" ); //$NON-NLS-1$
private static final String CREATING = Messages.getString( "NewLibraryWizard.text.Creating" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_NAME_PREFIX = Messages.getString( "NewLibraryWizard.displayName.NewReportFileNamePrefix" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_EXTENSION = Messages.getString( "NewLibraryWizard.displayName.NewReportFileExtension" ); //$NON-NLS-1$
private static final String NEW_REPORT_FILE_NAME = NEW_REPORT_FILE_NAME_PREFIX
+ NEW_REPORT_FILE_EXTENSION;
private static final String CREATE_A_NEW_REPORT = Messages.getString( "NewLibraryWizard.text.CreateReport" ); //$NON-NLS-1$
private static final String REPORT = Messages.getString( "NewLibraryWizard.title.Report" ); //$NON-NLS-1$
private static final String WIZARDPAGE = Messages.getString( "NewLibraryWizard.title.WizardPage" ); //$NON-NLS-1$
private static final String NEW = Messages.getString( "NewLibraryWizard.title.New" ); //$NON-NLS-1$
// private static final String CHOOSE_FROM_TEMPLATE = Messages.getString(
// "NewReportWizard.title.Choose" ); //$NON-NLS-1$
/** Holds selected project resource for run method access */
private IStructuredSelection selection;
private WizardNewFileCreationPage newReportFileWizardPage;
private int UNIQUE_COUNTER = 0;
// private WizardChoicePage choicePage;
// private WizardCustomTemplatePage customTemplatePage;
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.Wizard#performFinish()
*/
public boolean performFinish( )
{
final IPath containerName = newReportFileWizardPage.getContainerFullPath( );
String fn = newReportFileWizardPage.getFileName( );
final String fileName;
if ( !fn.endsWith( ".rptlibrary" ) ) //$NON-NLS-1$
{
fileName = fn + ".rptlibrary"; //$NON-NLS-1$
}
else
{
fileName = fn;
}
InputStream streamFromPage = null;
URL url = Platform.find( Platform.getBundle( ReportPlugin.REPORT_UI ),
new Path( "/templates/blank_library.rptlibrary" ) );
if ( url != null )
{
try
{
streamFromPage = url.openStream( );
}
catch ( IOException e1 )
{
//ignore.
}
}
final InputStream stream = streamFromPage;
IRunnableWithProgress op = new IRunnableWithProgress( ) {
public void run( IProgressMonitor monitor )
throws InvocationTargetException
{
try
{
doFinish( containerName,
fileName,
stream,
monitor );
}
catch ( CoreException e )
{
throw new InvocationTargetException( e );
}
finally
{
monitor.done( );
}
}
};
try
{
getContainer( ).run( true, false, op );
}
catch ( InterruptedException e )
{
return false;
}
catch ( InvocationTargetException e )
{
Throwable realException = e.getTargetException( );
ExceptionHandler.handle( realException );
return false;
}
return true;
}
/*
* (non-Javadoc)
*
* @see org.eclipse.ui.IWorkbenchWizard#init(org.eclipse.ui.IWorkbench,
* org.eclipse.jface.viewers.IStructuredSelection)
*/
public void init( IWorkbench workbench, IStructuredSelection selection )
{
// check existing open project
IWorkspaceRoot root = ResourcesPlugin.getWorkspace( ).getRoot( );
IProject projects[] = root.getProjects( );
boolean foundOpenProject = false;
for ( int i = 0; i < projects.length; i++ )
{
if ( projects[i].isOpen( ) )
{
foundOpenProject = true;
break;
}
}
if ( !foundOpenProject )
{
MessageDialog.openError( getShell( ),
Messages.getString( "NewReportWizard.title.Error" ), //$NON-NLS-1$
Messages.getString( "NewReportWizard.error.NoProject" ) ); //$NON-NLS-1$
// abort wizard. There is no clean way to do it.
/**
* Remove the exception here 'cause It's safe since the wizard won't
* create any file without an open project.
*/
//throw new RuntimeException( );
}
// OK
this.selection = selection;
setWindowTitle( NEW );
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.IWizard#getDefaultPageImage()
*/
public Image getDefaultPageImage( )
{
return ReportPlugin.getImage( "/icons/wizban/create_report_wizard.gif" ); //$NON-NLS-1$
}
/*
* (non-Javadoc)
*
* @see org.eclipse.jface.wizard.IWizard#addPages()
*/
public void addPages( )
{
newReportFileWizardPage = new WizardNewFileCreationPage( WIZARDPAGE,
selection );
addPage( newReportFileWizardPage );
// set titles
newReportFileWizardPage.setTitle( REPORT );
newReportFileWizardPage.setDescription( CREATE_A_NEW_REPORT );
resetUniqueCount( );
newReportFileWizardPage.setFileName( getUniqueReportName( ) );
newReportFileWizardPage.setContainerFullPath( getDefaultContainerPath( ) );
}
private void resetUniqueCount( )
{
UNIQUE_COUNTER = 0;
}
private IPath getDefaultContainerPath( )
{
IWorkbenchWindow benchWindow = PlatformUI.getWorkbench( )
.getActiveWorkbenchWindow( );
IWorkbenchPart part = benchWindow.getPartService( ).getActivePart( );
Object selection = null;
if ( part instanceof IEditorPart )
{
selection = ( (IEditorPart) part ).getEditorInput( );
}
else
{
ISelection sel = benchWindow.getSelectionService( ).getSelection( );
if ( ( sel != null ) && ( sel instanceof IStructuredSelection ) )
{
selection = ( (IStructuredSelection) sel ).getFirstElement( );
}
}
IContainer ct = getDefaultContainer( selection );
if ( ct == null )
{
IEditorPart editor = UIUtil.getActiveEditor( true );
if ( editor != null )
{
ct = getDefaultContainer( editor.getEditorInput( ) );
}
}
if ( ct != null )
{
return ct.getFullPath( );
}
return null;
}
private IContainer getDefaultContainer( Object selection )
{
IContainer ct = null;
if ( selection instanceof IAdaptable )
{
IResource resource = (IResource) ( (IAdaptable) selection ).getAdapter( IResource.class );
if ( resource instanceof IContainer && resource.isAccessible( ) )
{
ct = (IContainer) resource;
}
else if ( resource != null
&& resource.getParent( ) != null
&& resource.getParent( ).isAccessible( ) )
{
ct = resource.getParent( );
}
}
return ct;
}
private String getUniqueReportName( )
{
IProject[] pjs = ResourcesPlugin.getWorkspace( )
.getRoot( )
.getProjects( );
resetUniqueCount( );
boolean goon = true;
while ( goon )
{
goon = false;
for ( int i = 0; i < pjs.length; i++ )
{
if ( pjs[i].isAccessible( ) )
{
if ( !validDuplicate( NEW_REPORT_FILE_NAME_PREFIX,
NEW_REPORT_FILE_EXTENSION,
UNIQUE_COUNTER,
pjs[i] ) )
{
UNIQUE_COUNTER++;
goon = true;
break;
}
}
}
}
if ( UNIQUE_COUNTER == 0 )
{
return NEW_REPORT_FILE_NAME;
}
return NEW_REPORT_FILE_NAME_PREFIX + "_" //$NON-NLS-1$
+ UNIQUE_COUNTER + NEW_REPORT_FILE_EXTENSION; //$NON-NLS-1$
}
private static final List tmpList = new ArrayList( );
private IConfigurationElement configElement;
private boolean validDuplicate( String prefix, String ext, int count,
IResource res )
{
if ( res != null && res.isAccessible( ) )
{
final String name;
if ( count == 0 )
{
name = prefix + ext;
}
else
{
name = prefix + "_" + count + ext; //$NON-NLS-1$
}
try
{
tmpList.clear( );
res.accept( new IResourceVisitor( ) {
public boolean visit( IResource resource )
throws CoreException
{
if ( resource.getType( ) == IResource.FILE
&& name.equals( ( (IFile) resource ).getName( ) ) )
{
tmpList.add( Boolean.TRUE );
}
return true;
}
},
IResource.DEPTH_INFINITE,
true );
if ( tmpList.size( ) > 0 )
{
return false;
}
}
catch ( CoreException e )
{
ExceptionHandler.handle( e );
}
}
return true;
}
/**
* Creates a folder resource handle for the folder with the given workspace path.
* This method does not create the folder resource; this is the responsibility
* of <code>createFolder</code>.
*
* @param folderPath the path of the folder resource to create a handle for
* @return the new folder resource handle
*/
protected IFolder createFolderHandle( IPath folderPath )
{
IWorkspaceRoot workspaceRoot = ResourcesPlugin.getWorkspace( )
.getRoot( );
return workspaceRoot.getFolder( folderPath );
}
/**
* The worker method. It will find the container, create the file if missing
* or just replace its contents, and open the editor on the newly created
* file.
*
* @param cheatSheetId
*
* @param containerName
* @param fileName
* @param showCheatSheet
* @param monitor
*/
private void doFinish( IPath containerName, String fileName,
InputStream stream,
IProgressMonitor monitor ) throws CoreException
{
// create a sample file
monitor.beginTask( CREATING + fileName, 2 );
IResource resource = (IContainer) ResourcesPlugin.getWorkspace( )
.getRoot( )
.findMember( containerName );
IContainer container = null;
if ( resource == null
|| !resource.exists( ) || !( resource instanceof IContainer ) )
{
// create folder if not exist
IFolder folder = createFolderHandle( containerName );
UIUtil.createFolder( folder, monitor );
container = folder;
}
else
{
container = (IContainer) resource;
}
final IFile file = container.getFile( new Path( fileName ) );
try
{
if ( file.exists( ) )
{
file.setContents( stream, true, true, monitor );
}
else
{
file.create( stream, true, monitor );
}
stream.close( );
}
catch ( IOException e )
{
}
monitor.worked( 1 );
monitor.setTaskName( OPENING_FILE_FOR_EDITING );
getShell( ).getDisplay( ).asyncExec( new Runnable( ) {
public void run( )
{
IWorkbench workbench = PlatformUI.getWorkbench( );
IWorkbenchWindow window = workbench.getActiveWorkbenchWindow( );
IWorkbenchPage page = window.getActivePage( );
try
{
IDE.openEditor( page, file, true );
}
catch ( Exception e )
{
ExceptionHandler.handle( e );
}
}
} );
monitor.worked( 1 );
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IExecutableExtension#setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)
*/
public void setInitializationData( IConfigurationElement config, String propertyName, Object data ) throws CoreException
{
this.configElement = config;
}
}
| - Summary: Switch to lib perspective after New Lib Wizard finish.
- Bugzilla Bug (s) Resolved:
- Description: Call BasicNewProjectResourceWizard.updatePerspective( getConfigElement() ); to switch to Lib perspective after New Lib Wiard finish
- Tests Description: manual
- Files Edited:
- Files Added:
- Notes to Build Team:
- Notes to Developers:
- Notes to QA:
- Notes to Documentation:
| UI/org.eclipse.birt.report.designer.ui.lib/src/org/eclipse/birt/report/designer/ui/wizards/NewLibraryWizard.java | - Summary: Switch to lib perspective after New Lib Wizard finish. | <ide><path>I/org.eclipse.birt.report.designer.ui.lib/src/org/eclipse/birt/report/designer/ui/wizards/NewLibraryWizard.java
<ide> import org.eclipse.ui.PlatformUI;
<ide> import org.eclipse.ui.dialogs.WizardNewFileCreationPage;
<ide> import org.eclipse.ui.ide.IDE;
<add>import org.eclipse.ui.wizards.newresource.BasicNewProjectResourceWizard;
<ide>
<ide>
<ide> /**
<ide> try
<ide> {
<ide> IDE.openEditor( page, file, true );
<add> BasicNewProjectResourceWizard.updatePerspective( getConfigElement() );
<ide> }
<ide> catch ( Exception e )
<ide> {
<ide> {
<ide> this.configElement = config;
<ide> }
<add>
<add>
<add> public IConfigurationElement getConfigElement( )
<add> {
<add> return configElement;
<add> }
<ide> } |
|
Java | apache-2.0 | 03808f236134d319c2160571cb1891e8c4ca618e | 0 | joaogl/LeGame-Remake | /*
* Copyright 2014 Joao Lourenco
*
* 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 net.joaolourenco.legame.world;
import java.util.*;
import net.joaolourenco.legame.*;
import net.joaolourenco.legame.entity.*;
import net.joaolourenco.legame.entity.light.*;
import net.joaolourenco.legame.graphics.*;
import net.joaolourenco.legame.graphics.font.*;
import net.joaolourenco.legame.settings.*;
import net.joaolourenco.legame.utils.*;
import net.joaolourenco.legame.utils.Timer;
import net.joaolourenco.legame.world.tile.*;
import org.lwjgl.input.*;
import static org.lwjgl.opengl.GL11.*;
/**
* @author Joao Lourenco
*
*/
public class Tutorial extends World {
boolean firstUpdate = false, needUpdates = false;
List<TutorialText> text = new ArrayList<TutorialText>();
int step = 0;
/**
* @param width
* @param height
* @author Joao Lourenco
*/
public Tutorial() {
super(100, 100);
}
public void preLoad() {
Registry.getPlayer().setRenderable(false);
new Timer("Map Loading", 2000, 1, new TimerResult(this) {
public void timerCall() {
World obj = (World) this.object;
if (obj.finished) obj.stopLoading();
obj.timerOver = true;
}
});
Texture.load();
}
/**
* @see net.joaolourenco.legame.world.World#generateLevel()
* @author Joao Lourenco
*/
@Override
public void generateLevel() {
SolidTile t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[0], true);
t.setSecondTexture(Texture.Dirt);
setTile(0, 0, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[1], true);
t.setSecondTexture(Texture.Dirt);
setTile(1, 0, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[2], true);
t.setSecondTexture(Texture.Dirt);
setTile(0, 1, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[3], true);
t.setSecondTexture(Texture.Dirt);
setTile(1, 1, t);
if (timerOver) super.generateLevel();
finished = true;
}
/**
* Method to render the entire world called by the Main Class.
*
* @author Joao Lourenco
*/
public void render() {
// Moving the Render to the right position to render.
glTranslatef(-this.xOffset, -this.yOffset, 0f);
// Clearing the colors.
glColor3f(1f, 1f, 1f);
// Getting the variables ready to check what tiles to render.
int x0 = this.xOffset >> GeneralSettings.TILE_SIZE_MASK;
int x1 = (this.xOffset >> GeneralSettings.TILE_SIZE_MASK) + (Registry.getScreenWidth() * 14 / 800);
int y0 = this.yOffset >> GeneralSettings.TILE_SIZE_MASK;
int y1 = (this.yOffset >> GeneralSettings.TILE_SIZE_MASK) + (Registry.getScreenHeight() * 11 / 600);
// Going through all the tiles to render.
for (int y = y0; y < y1; y++) {
for (int x = x0; x < x1; x++) {
// Getting and Rendering all the tiles.S
Tile tile = getTile(x, y);
if (tile != null) tile.render(x << GeneralSettings.TILE_SIZE_MASK, y << GeneralSettings.TILE_SIZE_MASK, this, getNearByLights(x << GeneralSettings.TILE_SIZE_MASK, y << GeneralSettings.TILE_SIZE_MASK));
}
}
// Clearing the colors once more.
glColor3f(1f, 1f, 1f);
// Going througth all the entities
for (Entity e : this.entities) {
// Checking if they are close to the player.
if (e != null && getDistance(e, this.player) < 800) {
if (e instanceof Light) {
// If its a Light render it and its shadows.
((Light) e).renderShadows(entities, worldTiles);
((Light) e).render();
// If not just render the Entity.
} else e.render();
}
}
// Moving the Render back to the default position.
glTranslatef(this.xOffset, this.yOffset, 0f);
try {
for (TutorialText t : text)
t.render();
} catch (ConcurrentModificationException e) {
} catch (NoSuchElementException e) {
}
}
/**
* Method to update everything called by the Main class 60 times per second.
*
* @author Joao Lourenco
*/
public void update() {
if (!firstUpdate || needUpdates) {
// Updating all the entities.
for (Entity e : this.entities) {
if (e != null && getDistance(this.player, e) <= Registry.getScreenWidth()) e.update();
}
firstUpdate = true;
}
// Updating all the world tiles.
for (Tile t : this.worldTiles)
if (t != null && getDistance(this.player, t.getX(), t.getY()) <= Registry.getScreenWidth()) t.update();
if (step == 0 && Keyboard.isKeyDown(Keyboard.KEY_RETURN)) {
text.clear();
step++;
Registry.clearAnimatedTexts();
}
}
/**
* Method to tick everything called by the Main class 10 times per second.
*
* @author Joao Lourenco
*/
public void tick() {
// If an entity is removed remove it from the Array.
for (Entity e : this.entities)
if (e != null && e.isRemoved()) this.entities.remove(e);
// Tick the entities.
for (Entity e : this.entities)
if (e != null) e.tick();
}
public void stopLoading() {
this.loading.remove();
int yPos = (Registry.getScreenHeight() / 4);
AnimatedText a = new AnimatedText("This game has a simple objective.", Registry.getScreenWidth() / 2, yPos, 25, 100, 200, -1);
new AnimatedText("Get to the end of each level. ALIVE!", Registry.getScreenWidth() / 2, yPos + 50, 25, 100, 200, -5, a);
this.text.add(new TutorialText("End Mark", Registry.getScreenWidth() / 2, (Registry.getScreenHeight() / 8) * 5, 25));
this.text.add(new TutorialText("Hit enter to continue.", 10, Registry.getScreenHeight() - 25, 18, false));
new Timer("Tutorial-Step-1", 10000, 1, new TimerResult(this) {
public void timerCall() {
Tutorial obj = (Tutorial) this.object;
if (obj.step == 0) {
obj.text.clear();
step++;
Registry.clearAnimatedTexts();
}
}
});
}
} | src/net/joaolourenco/legame/world/Tutorial.java | /*
* Copyright 2014 Joao Lourenco
*
* 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 net.joaolourenco.legame.world;
import java.util.*;
import net.joaolourenco.legame.*;
import net.joaolourenco.legame.entity.*;
import net.joaolourenco.legame.entity.light.*;
import net.joaolourenco.legame.graphics.*;
import net.joaolourenco.legame.graphics.font.*;
import net.joaolourenco.legame.settings.*;
import net.joaolourenco.legame.utils.*;
import net.joaolourenco.legame.utils.Timer;
import net.joaolourenco.legame.world.tile.*;
import org.lwjgl.input.*;
import static org.lwjgl.opengl.GL11.*;
/**
* @author Joao Lourenco
*
*/
public class Tutorial extends World {
boolean firstUpdate = false, needUpdates = false;
List<TutorialText> text = new ArrayList<TutorialText>();
int step = 0;
/**
* @param width
* @param height
* @author Joao Lourenco
*/
public Tutorial() {
super(100, 100);
}
public void preLoad() {
Registry.getPlayer().setRenderable(false);
new Timer("Map Loading", 2000, 1, new TimerResult(this) {
public void timerCall() {
World obj = (World) this.object;
if (obj.finished) obj.stopLoading();
obj.timerOver = true;
}
});
Texture.load();
}
/**
* @see net.joaolourenco.legame.world.World#generateLevel()
* @author Joao Lourenco
*/
@Override
public void generateLevel() {
SolidTile t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[0], true);
t.setSecondTexture(Texture.Dirt);
setTile(0, 0, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[1], true);
t.setSecondTexture(Texture.Dirt);
setTile(1, 0, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[2], true);
t.setSecondTexture(Texture.Dirt);
setTile(0, 1, t);
t = new SolidTile(GeneralSettings.TILE_SIZE, Texture.FinishPod[3], true);
t.setSecondTexture(Texture.Dirt);
setTile(1, 1, t);
if (timerOver) super.generateLevel();
finished = true;
}
/**
* Method to render the entire world called by the Main Class.
*
* @author Joao Lourenco
*/
public void render() {
// Moving the Render to the right position to render.
glTranslatef(-this.xOffset, -this.yOffset, 0f);
// Clearing the colors.
glColor3f(1f, 1f, 1f);
// Getting the variables ready to check what tiles to render.
int x0 = this.xOffset >> GeneralSettings.TILE_SIZE_MASK;
int x1 = (this.xOffset >> GeneralSettings.TILE_SIZE_MASK) + (Registry.getScreenWidth() * 14 / 800);
int y0 = this.yOffset >> GeneralSettings.TILE_SIZE_MASK;
int y1 = (this.yOffset >> GeneralSettings.TILE_SIZE_MASK) + (Registry.getScreenHeight() * 11 / 600);
// Going through all the tiles to render.
for (int y = y0; y < y1; y++) {
for (int x = x0; x < x1; x++) {
// Getting and Rendering all the tiles.S
Tile tile = getTile(x, y);
if (tile != null) tile.render(x << GeneralSettings.TILE_SIZE_MASK, y << GeneralSettings.TILE_SIZE_MASK, this, getNearByLights(x << GeneralSettings.TILE_SIZE_MASK, y << GeneralSettings.TILE_SIZE_MASK));
}
}
// Clearing the colors once more.
glColor3f(1f, 1f, 1f);
// Going througth all the entities
for (Entity e : this.entities) {
// Checking if they are close to the player.
if (e != null && getDistance(e, this.player) < 800) {
if (e instanceof Light) {
// If its a Light render it and its shadows.
((Light) e).renderShadows(entities, worldTiles);
((Light) e).render();
// If not just render the Entity.
} else e.render();
}
}
// Moving the Render back to the default position.
glTranslatef(this.xOffset, this.yOffset, 0f);
try {
for (TutorialText t : text)
t.render();
} catch (ConcurrentModificationException e) {
} catch (NoSuchElementException e) {
}
}
/**
* Method to update everything called by the Main class 60 times per second.
*
* @author Joao Lourenco
*/
public void update() {
if (!firstUpdate || needUpdates) {
// Updating all the entities.
for (Entity e : this.entities) {
if (e != null && getDistance(this.player, e) <= Registry.getScreenWidth()) e.update();
}
firstUpdate = true;
}
// Updating all the world tiles.
for (Tile t : this.worldTiles)
if (t != null && getDistance(this.player, t.getX(), t.getY()) <= Registry.getScreenWidth()) t.update();
if (step == 0 && Keyboard.isKeyDown(Keyboard.KEY_RETURN)) {
text.clear();
step++;
Registry.clearAnimatedTexts();
}
}
/**
* Method to tick everything called by the Main class 10 times per second.
*
* @author Joao Lourenco
*/
public void tick() {
// If an entity is removed remove it from the Array.
for (Entity e : this.entities)
if (e != null && e.isRemoved()) this.entities.remove(e);
// Tick the entities.
for (Entity e : this.entities)
if (e != null) e.tick();
}
public void stopLoading() {
this.loading.remove();
AnimatedText a = new AnimatedText("This game has a simple objective.", Registry.getScreenWidth() / 2, 100, 25, 100, 200, -1);
new AnimatedText("Get to the end of each level. ALIVE!", Registry.getScreenWidth() / 2, 150, 25, 100, 200, -5, a);
this.text.add(new TutorialText("End Mark", Registry.getScreenWidth() / 2, 400, 25));
this.text.add(new TutorialText("Hit enter to continue.", 10, Registry.getScreenHeight() - 25, 18, false));
new Timer("Tutorial-Step-1", 10000, 1, new TimerResult(this) {
public void timerCall() {
Tutorial obj = (Tutorial) this.object;
if (obj.step == 0) {
obj.text.clear();
step++;
Registry.clearAnimatedTexts();
}
}
});
}
} | Tutorial letters are now relative to the screen height. | src/net/joaolourenco/legame/world/Tutorial.java | Tutorial letters are now relative to the screen height. | <ide><path>rc/net/joaolourenco/legame/world/Tutorial.java
<ide> public void stopLoading() {
<ide> this.loading.remove();
<ide>
<del> AnimatedText a = new AnimatedText("This game has a simple objective.", Registry.getScreenWidth() / 2, 100, 25, 100, 200, -1);
<del> new AnimatedText("Get to the end of each level. ALIVE!", Registry.getScreenWidth() / 2, 150, 25, 100, 200, -5, a);
<del>
<del> this.text.add(new TutorialText("End Mark", Registry.getScreenWidth() / 2, 400, 25));
<add> int yPos = (Registry.getScreenHeight() / 4);
<add>
<add> AnimatedText a = new AnimatedText("This game has a simple objective.", Registry.getScreenWidth() / 2, yPos, 25, 100, 200, -1);
<add> new AnimatedText("Get to the end of each level. ALIVE!", Registry.getScreenWidth() / 2, yPos + 50, 25, 100, 200, -5, a);
<add>
<add> this.text.add(new TutorialText("End Mark", Registry.getScreenWidth() / 2, (Registry.getScreenHeight() / 8) * 5, 25));
<ide> this.text.add(new TutorialText("Hit enter to continue.", 10, Registry.getScreenHeight() - 25, 18, false));
<ide>
<ide> new Timer("Tutorial-Step-1", 10000, 1, new TimerResult(this) { |
|
Java | apache-2.0 | df3909d23d3cb79deeba2410cfc96e20a427e4a8 | 0 | hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode,hmusavi/jpo-ode | package us.dot.its.jpo.ode;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;
import groovy.lang.MissingPropertyException;
import us.dot.its.jpo.ode.context.AppContext;
import us.dot.its.jpo.ode.eventlog.EventLogger;
@ConfigurationProperties("ode")
@PropertySource("classpath:application.properties")
public class OdeProperties implements EnvironmentAware {
private Logger logger = LoggerFactory.getLogger(this.getClass());
@Autowired
private Environment env;
private List<Path> uploadLocations = new ArrayList<>();
private String uploadLocationRoot = "uploads";
private String uploadLocationBsm = "bsm";
private String uploadLocationMessageFrame = "messageframe";
private String pluginsLocations = "plugins";
private String asn1CoderClassName = "us.dot.its.jpo.ode.plugin.j2735.oss.OssAsn1Coder";
private String kafkaBrokers = null;
private String kafkaProducerType = AppContext.DEFAULT_KAFKA_PRODUCER_TYPE;
private String ddsCasUrl = "https://cas.connectedvcs.com/accounts/v1/tickets";
private String ddsCasUsername = "";
private String ddsCasPass = "";
private String ddsWebsocketUrl = "wss://webapp2.connectedvcs.com/whtools23/websocket";
private String kafkaTopicBsmSerializedPOJO = "topic.J2735Bsm";
private String kafkaTopicBsmJSON = "topic.J2735BsmRawJSON";
private String hostId;
public OdeProperties() {
super();
init();
}
public void init() {
uploadLocations.add(Paths.get(uploadLocationRoot));
uploadLocations.add(Paths.get(uploadLocationRoot, uploadLocationBsm));
uploadLocations.add(Paths.get(uploadLocationRoot, uploadLocationMessageFrame));
String hostname;
try {
hostname = InetAddress.getLocalHost().getHostName();
} catch (UnknownHostException e) {
// Let's just use a random hostname
hostname = UUID.randomUUID().toString();
logger.info("Unknown host error: {}, using random", e);
}
hostId = hostname;
logger.info("Host ID: {}", hostId);
EventLogger.logger.info("Initializing services on host {}", hostId);
if (kafkaBrokers == null) {
logger.info(
"ode.kafkaBrokers property not defined. Will try DOCKER_HOST_IP from which will derive the Kafka bootstrap-server");
kafkaBrokers = System.getenv("DOCKER_HOST_IP") + ":9092";
}
if (kafkaBrokers == null)
throw new MissingPropertyException(
"Neither ode.kafkaBrokers ode property nor DOCKER_HOST_IP environment variable are defined");
}
public List<Path> getUploadLocations() {
return this.uploadLocations;
}
public String getProperty(String key) {
return env.getProperty(key);
}
public String getProperty(String key, String defaultValue) {
return env.getProperty(key, defaultValue);
}
public Object getProperty(String key, int i) {
return env.getProperty(key, Integer.class, i);
}
public String getHostId() {
return hostId;
}
public String getUploadLocationBsm() {
return uploadLocationBsm;
}
public void setUploadLocationBsm(String uploadLocation) {
this.uploadLocationBsm = uploadLocation;
}
public String getPluginsLocations() {
return pluginsLocations;
}
public void setPluginsLocations(String pluginsLocations) {
this.pluginsLocations = pluginsLocations;
}
public String getAsn1CoderClassName() {
return asn1CoderClassName;
}
public void setAsn1CoderClassName(String asn1CoderClassName) {
this.asn1CoderClassName = asn1CoderClassName;
}
public String getKafkaBrokers() {
return kafkaBrokers;
}
public void setKafkaBrokers(String kafkaBrokers) {
this.kafkaBrokers = kafkaBrokers;
}
public String getKafkaProducerType() {
return kafkaProducerType;
}
public void setKafkaProducerType(String kafkaProducerType) {
this.kafkaProducerType = kafkaProducerType;
}
public Environment getEnv() {
return env;
}
public void setEnv(Environment env) {
this.env = env;
}
@Override
public void setEnvironment(Environment environment) {
env = environment;
}
public String getUploadLocationMessageFrame() {
return uploadLocationMessageFrame;
}
public void setUploadLocationMessageFrame(String uploadLocationMessageFrame) {
this.uploadLocationMessageFrame = uploadLocationMessageFrame;
}
public String getUploadLocationRoot() {
return uploadLocationRoot;
}
public void setUploadLocationRoot(String uploadLocationRoot) {
this.uploadLocationRoot = uploadLocationRoot;
}
public String getDdsCasUrl() {
return ddsCasUrl;
}
public void setDdsCasUrl(String ddsCasUrl) {
this.ddsCasUrl = ddsCasUrl;
}
public String getDdsCasUsername() {
return ddsCasUsername;
}
public void setDdsCasUsername(String ddsCasUsername) {
this.ddsCasUsername = ddsCasUsername;
}
public String getDdsCasPassword() {
return ddsCasPass;
}
public void setDdsCasPassword(String ddsCasPassword) {
this.ddsCasPass = ddsCasPassword;
}
public String getDdsWebsocketUrl() {
return ddsWebsocketUrl;
}
public void setDdsWebsocketUrl(String ddsWebsocketUrl) {
this.ddsWebsocketUrl = ddsWebsocketUrl;
}
public String getBsmKafkaTopicSerial() {
return kafkaTopicBsmSerializedPOJO;
}
public void setBsmKafkaTopicSerial(String bsmKafkaTopicSerial) {
this.kafkaTopicBsmSerializedPOJO = bsmKafkaTopicSerial;
}
public String getBsmKafkaTopicJson() {
return kafkaTopicBsmJSON;
}
public void setBsmKafkaTopicJson(String bsmKafkaTopicJson) {
this.kafkaTopicBsmJSON = bsmKafkaTopicJson;
}
}
| jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/OdeProperties.java | package us.dot.its.jpo.ode;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.EnvironmentAware;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;
import groovy.lang.MissingPropertyException;
import us.dot.its.jpo.ode.context.AppContext;
import us.dot.its.jpo.ode.eventlog.EventLogger;
@ConfigurationProperties("ode")
@PropertySource("classpath:application.properties")
public class OdeProperties implements EnvironmentAware {
private Logger logger = LoggerFactory.getLogger(this.getClass());
/////////////////////////////////////////////////////////////////////////////
// Kafka Topics
//public static final String KAFKA_TOPIC_J2735_BSM = "topic.J2735Bsm";
//public static final String KAFKA_TOPIC_J2735_BSM_JSON = "topic.J2735BsmRawJSON";
/////////////////////////////////////////////////////////////////////////////
@Autowired
private Environment env;
private List<Path> uploadLocations = new ArrayList<>();
private String uploadLocationRoot = "uploads";
private String uploadLocationBsm = "bsm";
private String uploadLocationMessageFrame = "messageframe";
private String pluginsLocations = "plugins";
private String asn1CoderClassName = "us.dot.its.jpo.ode.plugin.j2735.oss.OssAsn1Coder";
private String kafkaBrokers = null;
private String kafkaProducerType = AppContext.DEFAULT_KAFKA_PRODUCER_TYPE;
private String ddsCasUrl = "https://cas.connectedvcs.com/accounts/v1/tickets";
private String ddsCasUsername = "";
private String ddsCasPass = "";
private String ddsWebsocketUrl = "wss://webapp2.connectedvcs.com/whtools23/websocket";
private String kafkaTopicBsmSerializedPOJO = "topic.J2735Bsm";
private String kafkaTopicBsmJSON = "topic.J2735BsmRawJSON";
private String hostId;
public OdeProperties() {
super();
init();
}
public void init() {
uploadLocations.add(Paths.get(uploadLocationRoot));
uploadLocations.add(Paths.get(uploadLocationRoot, uploadLocationBsm));
uploadLocations.add(Paths.get(uploadLocationRoot, uploadLocationMessageFrame));
String hostname;
try {
hostname = InetAddress.getLocalHost().getHostName();
} catch (UnknownHostException e) {
// Let's just use a random hostname
hostname = UUID.randomUUID().toString();
logger.info("Unknown host error: {}, using random", e);
}
hostId = hostname;
logger.info("Host ID: {}", hostId);
EventLogger.logger.info("Initializing services on host {}", hostId);
if (kafkaBrokers == null) {
logger.info(
"ode.kafkaBrokers property not defined. Will try DOCKER_HOST_IP from which will derive the Kafka bootstrap-server");
kafkaBrokers = System.getenv("DOCKER_HOST_IP") + ":9092";
}
if (kafkaBrokers == null)
throw new MissingPropertyException(
"Neither ode.kafkaBrokers ode property nor DOCKER_HOST_IP environment variable are defined");
}
public List<Path> getUploadLocations() {
return this.uploadLocations;
}
public String getProperty(String key) {
return env.getProperty(key);
}
public String getProperty(String key, String defaultValue) {
return env.getProperty(key, defaultValue);
}
public Object getProperty(String key, int i) {
return env.getProperty(key, Integer.class, i);
}
public String getHostId() {
return hostId;
}
public String getUploadLocationBsm() {
return uploadLocationBsm;
}
public void setUploadLocationBsm(String uploadLocation) {
this.uploadLocationBsm = uploadLocation;
}
public String getPluginsLocations() {
return pluginsLocations;
}
public void setPluginsLocations(String pluginsLocations) {
this.pluginsLocations = pluginsLocations;
}
public String getAsn1CoderClassName() {
return asn1CoderClassName;
}
public void setAsn1CoderClassName(String asn1CoderClassName) {
this.asn1CoderClassName = asn1CoderClassName;
}
public String getKafkaBrokers() {
return kafkaBrokers;
}
public void setKafkaBrokers(String kafkaBrokers) {
this.kafkaBrokers = kafkaBrokers;
}
public String getKafkaProducerType() {
return kafkaProducerType;
}
public void setKafkaProducerType(String kafkaProducerType) {
this.kafkaProducerType = kafkaProducerType;
}
public Environment getEnv() {
return env;
}
public void setEnv(Environment env) {
this.env = env;
}
@Override
public void setEnvironment(Environment environment) {
env = environment;
}
public String getUploadLocationMessageFrame() {
return uploadLocationMessageFrame;
}
public void setUploadLocationMessageFrame(String uploadLocationMessageFrame) {
this.uploadLocationMessageFrame = uploadLocationMessageFrame;
}
public String getUploadLocationRoot() {
return uploadLocationRoot;
}
public void setUploadLocationRoot(String uploadLocationRoot) {
this.uploadLocationRoot = uploadLocationRoot;
}
public String getDdsCasUrl() {
return ddsCasUrl;
}
public void setDdsCasUrl(String ddsCasUrl) {
this.ddsCasUrl = ddsCasUrl;
}
public String getDdsCasUsername() {
return ddsCasUsername;
}
public void setDdsCasUsername(String ddsCasUsername) {
this.ddsCasUsername = ddsCasUsername;
}
public String getDdsCasPassword() {
return ddsCasPass;
}
public void setDdsCasPassword(String ddsCasPassword) {
this.ddsCasPass = ddsCasPassword;
}
public String getDdsWebsocketUrl() {
return ddsWebsocketUrl;
}
public void setDdsWebsocketUrl(String ddsWebsocketUrl) {
this.ddsWebsocketUrl = ddsWebsocketUrl;
}
public String getBsmKafkaTopicSerial() {
return kafkaTopicBsmSerializedPOJO;
}
public void setBsmKafkaTopicSerial(String bsmKafkaTopicSerial) {
this.kafkaTopicBsmSerializedPOJO = bsmKafkaTopicSerial;
}
public String getBsmKafkaTopicJson() {
return kafkaTopicBsmJSON;
}
public void setBsmKafkaTopicJson(String bsmKafkaTopicJson) {
this.kafkaTopicBsmJSON = bsmKafkaTopicJson;
}
}
| ODE-274 minor change
| jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/OdeProperties.java | ODE-274 minor change | <ide><path>po-ode-svcs/src/main/java/us/dot/its/jpo/ode/OdeProperties.java
<ide> public class OdeProperties implements EnvironmentAware {
<ide>
<ide> private Logger logger = LoggerFactory.getLogger(this.getClass());
<del>
<del> /////////////////////////////////////////////////////////////////////////////
<del> // Kafka Topics
<del> //public static final String KAFKA_TOPIC_J2735_BSM = "topic.J2735Bsm";
<del> //public static final String KAFKA_TOPIC_J2735_BSM_JSON = "topic.J2735BsmRawJSON";
<del> /////////////////////////////////////////////////////////////////////////////
<ide>
<ide> @Autowired
<ide> private Environment env; |
|
Java | mit | 17c811099f9d670af2ed1005ec646244dec92f4b | 0 | tkob/yokohamaunit,tkob/yokohamaunit | package yokohama.unit.translator;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.AnnotationEntryGen;
import org.apache.bcel.generic.ArrayType;
import org.apache.bcel.generic.BranchInstruction;
import org.apache.bcel.generic.ClassGen;
import org.apache.bcel.generic.ConstantPoolGen;
import org.apache.bcel.generic.InstructionConstants;
import org.apache.bcel.generic.InstructionFactory;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.InstructionList;
import org.apache.bcel.generic.LocalVariableGen;
import org.apache.bcel.generic.MethodGen;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.PUSH;
import org.apache.bcel.generic.Type;
import yokohama.unit.ast.Kind;
import yokohama.unit.ast_junit.CompilationUnit;
import yokohama.unit.ast_junit.IsNotStatement;
import yokohama.unit.ast_junit.IsStatement;
import yokohama.unit.ast_junit.Statement;
import yokohama.unit.ast_junit.TestMethod;
import yokohama.unit.ast_junit.Var;
import yokohama.unit.ast_junit.VarDeclVisitor;
import yokohama.unit.ast_junit.VarInitStatement;
import yokohama.unit.util.Pair;
public class BcelJUnitAstCompiler implements JUnitAstCompiler {
@Override
public boolean compile(
Path docyPath,
CompilationUnit ast,
String className,
String packageName,
List<String> classPath,
Optional<Path> dest,
List<String> javacArgs) {
ClassGen cg = new ClassGen(
packageName.equals("") ? className : packageName + "." + className,
"java.lang.Object", // super class
docyPath.getFileName().toString(), // source file name
Constants.ACC_PUBLIC | Constants.ACC_SUPER,
null // implemented interfaces
);
// set class file version to Java 1.6
cg.setMajor(50);
cg.setMinor(0);
ConstantPoolGen cp = cg.getConstantPool(); // cg creates constant pool
cg.addEmptyConstructor(Constants.ACC_PUBLIC);
for (TestMethod testMethod : ast.getClassDecl().getTestMethods()) {
visitTestMethod(testMethod, cg, cp);
}
try {
Path classFilePath = makeClassFilePath(dest, packageName, className);
cg.getJavaClass().dump(classFilePath.toFile());
} catch(java.io.IOException e) {
System.err.println(e);
}
return true;
}
public Path makeClassFilePath(Optional<Path> dest, String packageName, String className) {
Path classFile = (dest.isPresent() ? dest.get(): Paths.get("."))
.resolve(Paths.get(packageName.replace('.', '/')))
.resolve(className + ".class");
return classFile;
}
private void visitTestMethod(TestMethod testMethod, ClassGen cg, ConstantPoolGen cp) {
InstructionList il = new InstructionList();
MethodGen mg = new MethodGen(Constants.ACC_PUBLIC, // access flags
Type.VOID, // return type of a test method is always void
Type.NO_ARGS, new String[]{}, // test methods have no arguments
testMethod.getName(),
cg.getClassName(),
il, cp);
AnnotationEntryGen ag = new AnnotationEntryGen(
new ObjectType("org.junit.Test"),
Arrays.asList(),
true,
cp);
mg.addAnnotationEntry(ag);
InstructionFactory factory = new InstructionFactory(cg);
Map<String, LocalVariableGen> locals = new HashMap<>();
for (Pair<yokohama.unit.ast_junit.Type,String> pair :
VarDeclVisitor.sortedSet(new VarDeclVisitor().visitTestMethod(testMethod))) {
yokohama.unit.ast_junit.Type type = pair.getFirst();
String name = pair.getSecond();
LocalVariableGen lv = mg.addLocalVariable(name, typeOf(type), null, null);
locals.put(name, lv);
}
for (Statement statement : testMethod.getStatements()) {
visitStatement(statement, locals, il, factory, cp);
}
il.append(InstructionConstants.RETURN);
mg.setMaxStack();
cg.addMethod(mg.getMethod());
il.dispose();
}
private void visitStatement(
Statement statement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
statement.<Void>accept(
isStatement -> {
visitIsStatement(isStatement, locals, il, factory, cp);
return null;
},
isNotStatement -> {
visitIsNotStatement(isNotStatement, locals, il, factory, cp);
return null;
},
varInitStatement -> {
visitVarInitStatement(varInitStatement, locals, il, factory, cp);
return null;
},
returnIsStatement -> { return null; },
returnIsNotStatement -> { return null; },
invokeVoidStatement -> { return null; },
tryStatement -> { return null; },
ifStatement -> {
LocalVariableGen lv = locals.get(ifStatement.getCond().getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
// if
BranchInstruction ifeq = InstructionFactory.createBranchInstruction(Constants.IFEQ, null);
il.append(ifeq);
// then
for (Statement thenStatement : ifStatement.getThen()) {
visitStatement(thenStatement, locals, il, factory, cp);
}
BranchInstruction goto_ = InstructionFactory.createBranchInstruction(Constants.GOTO, null);
il.append(goto_);
// else
InstructionHandle else_ = il.append(InstructionFactory.NOP);
for (Statement elseStatement : ifStatement.getOtherwise()) {
visitStatement(elseStatement, locals, il, factory, cp);
}
InstructionHandle fi = il.append(InstructionFactory.NOP);
// tie the knot
ifeq.setTarget(else_);
goto_.setTarget(fi);
return null;
}
);
}
private void visitIsStatement(
IsStatement isStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen subject = locals.get(isStatement.getSubject().getName());
LocalVariableGen complement = locals.get(isStatement.getComplement().getName());
il.append(InstructionFactory.createLoad(subject.getType(), subject.getIndex()));
il.append(InstructionFactory.createLoad(complement.getType(), complement.getIndex()));
il.append(
factory.createInvoke(
"org.junit.Assert",
"assertThat",
Type.VOID,
new Type[] { subject.getType(), complement.getType() },
Constants.INVOKESTATIC));
}
private void visitIsNotStatement(
IsNotStatement isNotStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen subject = locals.get(isNotStatement.getSubject().getName());
LocalVariableGen complement = locals.get(isNotStatement.getComplement().getName());
il.append(InstructionFactory.createLoad(subject.getType(), subject.getIndex()));
il.append(InstructionFactory.createLoad(complement.getType(), complement.getIndex()));
il.append(
factory.createInvoke(
"org.hamcrest.CoreMatchers",
"not",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { complement.getType() },
Constants.INVOKESTATIC));
il.append(
factory.createInvoke(
"org.junit.Assert",
"assertThat",
Type.VOID,
new Type[] { subject.getType(), new ObjectType("org.hamcrest.Matcher") },
Constants.INVOKESTATIC));
}
private void visitVarInitStatement(
VarInitStatement varInitStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen var = locals.get(varInitStatement.getName());
Type type = typeOf(varInitStatement.getType());
varInitStatement.getValue().<Void>accept(
varExpr -> {
LocalVariableGen from = locals.get(varExpr.getName());
il.append(InstructionFactory.createLoad(from.getType(), from.getIndex()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
instanceOfMatcherExpr -> {
il.append(new PUSH(cp, new ObjectType(instanceOfMatcherExpr.getClassName())));
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"instanceOf",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { new ObjectType("java.lang.Class") },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
nullValueMatcherExpr -> {
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"nullValue",
new ObjectType("org.hamcrest.Matcher"),
Type.NO_ARGS,
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
conjunctionMatcherExpr -> {
List<Var> matchers = conjunctionMatcherExpr.getMatchers();
int numMatchers = matchers.size();
// first create array
il.append(new PUSH(cp, numMatchers));
il.append(factory.createNewArray(new ObjectType("org.hamcrest.Matcher"), (short) 1));
// fill the array with the matchers
for (int i = 0; i < numMatchers; i++) {
String name = matchers.get(i).getName();
LocalVariableGen lv = locals.get(name);
il.append(InstructionConstants.DUP);
il.append(new PUSH(cp, i));
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
il.append(InstructionConstants.AASTORE);
}
// then call allOf with the array(=vararg)
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"allOf",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { new ArrayType(new ObjectType("org.hamcrest.Matcher"), 1) },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
equalToMatcherExpr -> {
Var operand = equalToMatcherExpr.getOperand();
LocalVariableGen lv = locals.get(operand.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"is",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { lv.getType() },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
suchThatMatcherExpr -> { return null; },
newExpr -> {
il.append(factory.createNew(newExpr.getType()));
il.append(InstructionConstants.DUP);
il.append(factory.createInvoke(
newExpr.getType(),
"<init>",
Type.VOID,
Type.NO_ARGS,
Constants.INVOKESPECIAL));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
strLitExpr -> {
il.append(new PUSH(cp, strLitExpr.getText()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
nullExpr -> {
il.append(InstructionConstants.ACONST_NULL);
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
invokeExpr -> {
// first push target object
LocalVariableGen object = locals.get(invokeExpr.getObject().getName());
il.append(InstructionFactory.createLoad(object.getType(), object.getIndex()));
// push arguments
for (Var arg : invokeExpr.getArgs()) {
LocalVariableGen lv = locals.get(arg.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
}
// then call method
il.append(factory.createInvoke(
object.getType().toString(), // TODO: ?
invokeExpr.getMethodName(),
var.getType(),
invokeExpr.getArgs().stream()
.map(Var::getName)
.map(locals::get)
.map(LocalVariableGen::getType)
.collect(Collectors.toList())
.toArray(new Type[]{}),
Constants.INVOKEVIRTUAL));
return null;
},
invokeStaticExpr -> {
for (Var arg : invokeStaticExpr.getArgs()) {
LocalVariableGen lv = locals.get(arg.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
}
il.append(factory.createInvoke(
invokeStaticExpr.getClazz().getText(),
invokeStaticExpr.getMethodName(),
var.getType(),
invokeStaticExpr.getArgs().stream()
.map(Var::getName)
.map(locals::get)
.map(LocalVariableGen::getType)
.collect(Collectors.toList())
.toArray(new Type[]{}),
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
intLitExpr -> {
il.append(new PUSH(cp, intLitExpr.getValue()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
classLitExpr -> {
il.append(new PUSH(cp, new ObjectType(classLitExpr.getType().getText())));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
equalOpExpr -> {
LocalVariableGen lhs = locals.get(equalOpExpr.getLhs().getName());
il.append(InstructionFactory.createLoad(lhs.getType(), lhs.getIndex()));
LocalVariableGen rhs = locals.get(equalOpExpr.getRhs().getName());
il.append(InstructionFactory.createLoad(rhs.getType(), rhs.getIndex()));
// if
BranchInstruction if_acmpne = InstructionFactory.createBranchInstruction(Constants.IF_ACMPNE, null);
il.append(if_acmpne);
// then
il.append(new PUSH(cp, true));
BranchInstruction goto_ = InstructionFactory.createBranchInstruction(Constants.GOTO, null);
il.append(goto_);
// else
InstructionHandle else_ = il.append(new PUSH(cp, false));
InstructionHandle store = il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
// tie the knot
if_acmpne.setTarget(else_);
goto_.setTarget(store);
return null;
});
}
static Type typeOf(yokohama.unit.ast_junit.Type type) {
int dims = type.getDims();
if (dims == 0) {
return type.getNonArrayType().accept(
primitiveType -> {
Kind kind = primitiveType.getKind();
switch (kind) {
case BOOLEAN: return Type.BOOLEAN;
case BYTE: return Type.BYTE;
case SHORT: return Type.SHORT;
case INT: return Type.INT;
case LONG: return Type.LONG;
case CHAR: return Type.CHAR;
case FLOAT: return Type.FLOAT;
case DOUBLE: return Type.DOUBLE;
}
throw new RuntimeException("should not reach here");
},
classType -> new ObjectType(classType.getText()));
} else {
return new ArrayType(
typeOf(new yokohama.unit.ast_junit.Type(type.getNonArrayType() , 0)),
dims);
}
}
}
| src/main/java/yokohama/unit/translator/BcelJUnitAstCompiler.java | package yokohama.unit.translator;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.stream.Collectors;
import org.apache.bcel.Constants;
import org.apache.bcel.generic.AnnotationEntryGen;
import org.apache.bcel.generic.ArrayType;
import org.apache.bcel.generic.BranchInstruction;
import org.apache.bcel.generic.ClassGen;
import org.apache.bcel.generic.ConstantPoolGen;
import org.apache.bcel.generic.InstructionConstants;
import org.apache.bcel.generic.InstructionFactory;
import org.apache.bcel.generic.InstructionHandle;
import org.apache.bcel.generic.InstructionList;
import org.apache.bcel.generic.LocalVariableGen;
import org.apache.bcel.generic.MethodGen;
import org.apache.bcel.generic.ObjectType;
import org.apache.bcel.generic.PUSH;
import org.apache.bcel.generic.Type;
import yokohama.unit.ast.Kind;
import yokohama.unit.ast_junit.CompilationUnit;
import yokohama.unit.ast_junit.IsNotStatement;
import yokohama.unit.ast_junit.IsStatement;
import yokohama.unit.ast_junit.Statement;
import yokohama.unit.ast_junit.TestMethod;
import yokohama.unit.ast_junit.Var;
import yokohama.unit.ast_junit.VarDeclVisitor;
import yokohama.unit.ast_junit.VarInitStatement;
import yokohama.unit.util.Pair;
public class BcelJUnitAstCompiler implements JUnitAstCompiler {
@Override
public boolean compile(
Path docyPath,
CompilationUnit ast,
String className,
String packageName,
List<String> classPath,
Optional<Path> dest,
List<String> javacArgs) {
ClassGen cg = new ClassGen(
packageName.equals("") ? className : packageName + "." + className,
"java.lang.Object", // super class
docyPath.getFileName().toString(), // source file name
Constants.ACC_PUBLIC | Constants.ACC_SUPER,
null // implemented interfaces
);
// set class file version to Java 1.6
cg.setMajor(50);
cg.setMinor(0);
ConstantPoolGen cp = cg.getConstantPool(); // cg creates constant pool
cg.addEmptyConstructor(Constants.ACC_PUBLIC);
for (TestMethod testMethod : ast.getClassDecl().getTestMethods()) {
visitTestMethod(testMethod, cg, cp);
}
try {
Path classFilePath = makeClassFilePath(dest, packageName, className);
cg.getJavaClass().dump(classFilePath.toFile());
} catch(java.io.IOException e) {
System.err.println(e);
}
return true;
}
public Path makeClassFilePath(Optional<Path> dest, String packageName, String className) {
Path classFile = (dest.isPresent() ? dest.get(): Paths.get("."))
.resolve(Paths.get(packageName.replace('.', '/')))
.resolve(className + ".class");
return classFile;
}
private void visitTestMethod(TestMethod testMethod, ClassGen cg, ConstantPoolGen cp) {
InstructionList il = new InstructionList();
MethodGen mg = new MethodGen(Constants.ACC_PUBLIC, // access flags
Type.VOID, // return type of a test method is always void
Type.NO_ARGS, new String[]{}, // test methods have no arguments
testMethod.getName(),
cg.getClassName(),
il, cp);
AnnotationEntryGen ag = new AnnotationEntryGen(
new ObjectType("org.junit.Test"),
Arrays.asList(),
true,
cp);
mg.addAnnotationEntry(ag);
InstructionFactory factory = new InstructionFactory(cg);
Map<String, LocalVariableGen> locals = new HashMap<>();
for (Pair<yokohama.unit.ast_junit.Type,String> pair :
VarDeclVisitor.sortedSet(new VarDeclVisitor().visitTestMethod(testMethod))) {
yokohama.unit.ast_junit.Type type = pair.getFirst();
String name = pair.getSecond();
LocalVariableGen lv = mg.addLocalVariable(name, typeOf(type), null, null);
locals.put(name, lv);
}
for (Statement statement : testMethod.getStatements()) {
visitStatement(statement, locals, il, factory, cp);
}
il.append(InstructionConstants.RETURN);
mg.setMaxStack();
cg.addMethod(mg.getMethod());
il.dispose();
}
private void visitStatement(
Statement statement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
statement.<Void>accept(
isStatement -> {
visitIsStatement(isStatement, locals, il, factory, cp);
return null;
},
isNotStatement -> {
visitIsNotStatement(isNotStatement, locals, il, factory, cp);
return null;
},
varInitStatement -> {
visitVarInitStatement(varInitStatement, locals, il, factory, cp);
return null;
},
returnIsStatement -> { return null; },
returnIsNotStatement -> { return null; },
invokeVoidStatement -> { return null; },
tryStatement -> { return null; },
ifStatement -> { return null; }
);
}
private void visitIsStatement(
IsStatement isStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen subject = locals.get(isStatement.getSubject().getName());
LocalVariableGen complement = locals.get(isStatement.getComplement().getName());
il.append(InstructionFactory.createLoad(subject.getType(), subject.getIndex()));
il.append(InstructionFactory.createLoad(complement.getType(), complement.getIndex()));
il.append(
factory.createInvoke(
"org.junit.Assert",
"assertThat",
Type.VOID,
new Type[] { subject.getType(), complement.getType() },
Constants.INVOKESTATIC));
}
private void visitIsNotStatement(
IsNotStatement isNotStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen subject = locals.get(isNotStatement.getSubject().getName());
LocalVariableGen complement = locals.get(isNotStatement.getComplement().getName());
il.append(InstructionFactory.createLoad(subject.getType(), subject.getIndex()));
il.append(InstructionFactory.createLoad(complement.getType(), complement.getIndex()));
il.append(
factory.createInvoke(
"org.hamcrest.CoreMatchers",
"not",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { complement.getType() },
Constants.INVOKESTATIC));
il.append(
factory.createInvoke(
"org.junit.Assert",
"assertThat",
Type.VOID,
new Type[] { subject.getType(), new ObjectType("org.hamcrest.Matcher") },
Constants.INVOKESTATIC));
}
private void visitVarInitStatement(
VarInitStatement varInitStatement,
Map<String, LocalVariableGen> locals,
InstructionList il,
InstructionFactory factory,
ConstantPoolGen cp) {
LocalVariableGen var = locals.get(varInitStatement.getName());
Type type = typeOf(varInitStatement.getType());
varInitStatement.getValue().<Void>accept(
varExpr -> {
LocalVariableGen from = locals.get(varExpr.getName());
il.append(InstructionFactory.createLoad(from.getType(), from.getIndex()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
instanceOfMatcherExpr -> {
il.append(new PUSH(cp, new ObjectType(instanceOfMatcherExpr.getClassName())));
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"instanceOf",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { new ObjectType("java.lang.Class") },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
nullValueMatcherExpr -> {
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"nullValue",
new ObjectType("org.hamcrest.Matcher"),
Type.NO_ARGS,
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
conjunctionMatcherExpr -> {
List<Var> matchers = conjunctionMatcherExpr.getMatchers();
int numMatchers = matchers.size();
// first create array
il.append(new PUSH(cp, numMatchers));
il.append(factory.createNewArray(new ObjectType("org.hamcrest.Matcher"), (short) 1));
// fill the array with the matchers
for (int i = 0; i < numMatchers; i++) {
String name = matchers.get(i).getName();
LocalVariableGen lv = locals.get(name);
il.append(InstructionConstants.DUP);
il.append(new PUSH(cp, i));
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
il.append(InstructionConstants.AASTORE);
}
// then call allOf with the array(=vararg)
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"allOf",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { new ArrayType(new ObjectType("org.hamcrest.Matcher"), 1) },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
equalToMatcherExpr -> {
Var operand = equalToMatcherExpr.getOperand();
LocalVariableGen lv = locals.get(operand.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
il.append(factory.createInvoke(
"org.hamcrest.CoreMatchers",
"is",
new ObjectType("org.hamcrest.Matcher"),
new Type[] { lv.getType() },
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
suchThatMatcherExpr -> { return null; },
newExpr -> {
il.append(factory.createNew(newExpr.getType()));
il.append(InstructionConstants.DUP);
il.append(factory.createInvoke(
newExpr.getType(),
"<init>",
Type.VOID,
Type.NO_ARGS,
Constants.INVOKESPECIAL));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
strLitExpr -> {
il.append(new PUSH(cp, strLitExpr.getText()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
nullExpr -> {
il.append(InstructionConstants.ACONST_NULL);
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
invokeExpr -> {
// first push target object
LocalVariableGen object = locals.get(invokeExpr.getObject().getName());
il.append(InstructionFactory.createLoad(object.getType(), object.getIndex()));
// push arguments
for (Var arg : invokeExpr.getArgs()) {
LocalVariableGen lv = locals.get(arg.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
}
// then call method
il.append(factory.createInvoke(
object.getType().toString(), // TODO: ?
invokeExpr.getMethodName(),
var.getType(),
invokeExpr.getArgs().stream()
.map(Var::getName)
.map(locals::get)
.map(LocalVariableGen::getType)
.collect(Collectors.toList())
.toArray(new Type[]{}),
Constants.INVOKEVIRTUAL));
return null;
},
invokeStaticExpr -> {
for (Var arg : invokeStaticExpr.getArgs()) {
LocalVariableGen lv = locals.get(arg.getName());
il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
}
il.append(factory.createInvoke(
invokeStaticExpr.getClazz().getText(),
invokeStaticExpr.getMethodName(),
var.getType(),
invokeStaticExpr.getArgs().stream()
.map(Var::getName)
.map(locals::get)
.map(LocalVariableGen::getType)
.collect(Collectors.toList())
.toArray(new Type[]{}),
Constants.INVOKESTATIC));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
intLitExpr -> {
il.append(new PUSH(cp, intLitExpr.getValue()));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
classLitExpr -> {
il.append(new PUSH(cp, new ObjectType(classLitExpr.getType().getText())));
il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
return null;
},
equalOpExpr -> {
LocalVariableGen lhs = locals.get(equalOpExpr.getLhs().getName());
il.append(InstructionFactory.createLoad(lhs.getType(), lhs.getIndex()));
LocalVariableGen rhs = locals.get(equalOpExpr.getRhs().getName());
il.append(InstructionFactory.createLoad(rhs.getType(), rhs.getIndex()));
// if
BranchInstruction if_acmpne = InstructionFactory.createBranchInstruction(Constants.IF_ACMPNE, null);
il.append(if_acmpne);
// then
il.append(new PUSH(cp, true));
BranchInstruction goto_ = InstructionFactory.createBranchInstruction(Constants.GOTO, null);
il.append(goto_);
// else
InstructionHandle else_ = il.append(new PUSH(cp, false));
InstructionHandle store = il.append(InstructionFactory.createStore(var.getType(), var.getIndex()));
// tie the knot
if_acmpne.setTarget(else_);
goto_.setTarget(store);
return null;
});
}
static Type typeOf(yokohama.unit.ast_junit.Type type) {
int dims = type.getDims();
if (dims == 0) {
return type.getNonArrayType().accept(
primitiveType -> {
Kind kind = primitiveType.getKind();
switch (kind) {
case BOOLEAN: return Type.BOOLEAN;
case BYTE: return Type.BYTE;
case SHORT: return Type.SHORT;
case INT: return Type.INT;
case LONG: return Type.LONG;
case CHAR: return Type.CHAR;
case FLOAT: return Type.FLOAT;
case DOUBLE: return Type.DOUBLE;
}
throw new RuntimeException("should not reach here");
},
classType -> new ObjectType(classType.getText()));
} else {
return new ArrayType(
typeOf(new yokohama.unit.ast_junit.Type(type.getNonArrayType() , 0)),
dims);
}
}
}
| Implement code generator for IfStatement | src/main/java/yokohama/unit/translator/BcelJUnitAstCompiler.java | Implement code generator for IfStatement | <ide><path>rc/main/java/yokohama/unit/translator/BcelJUnitAstCompiler.java
<ide> returnIsNotStatement -> { return null; },
<ide> invokeVoidStatement -> { return null; },
<ide> tryStatement -> { return null; },
<del> ifStatement -> { return null; }
<add> ifStatement -> {
<add> LocalVariableGen lv = locals.get(ifStatement.getCond().getName());
<add> il.append(InstructionFactory.createLoad(lv.getType(), lv.getIndex()));
<add>
<add> // if
<add> BranchInstruction ifeq = InstructionFactory.createBranchInstruction(Constants.IFEQ, null);
<add> il.append(ifeq);
<add>
<add> // then
<add> for (Statement thenStatement : ifStatement.getThen()) {
<add> visitStatement(thenStatement, locals, il, factory, cp);
<add> }
<add> BranchInstruction goto_ = InstructionFactory.createBranchInstruction(Constants.GOTO, null);
<add> il.append(goto_);
<add>
<add> // else
<add> InstructionHandle else_ = il.append(InstructionFactory.NOP);
<add> for (Statement elseStatement : ifStatement.getOtherwise()) {
<add> visitStatement(elseStatement, locals, il, factory, cp);
<add> }
<add>
<add> InstructionHandle fi = il.append(InstructionFactory.NOP);
<add>
<add> // tie the knot
<add> ifeq.setTarget(else_);
<add> goto_.setTarget(fi);
<add>
<add> return null;
<add> }
<ide> );
<ide> }
<ide> |
|
Java | epl-1.0 | 6eb9c74def10f227b4830463e7e32e2edb970720 | 0 | whizzosoftware/hobson-hub-core | /*******************************************************************************
* Copyright (c) 2014 Whizzo Software, LLC.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package com.whizzosoftware.hobson.bootstrap.api.plugin;
import com.whizzosoftware.hobson.api.HobsonRuntimeException;
import com.whizzosoftware.hobson.api.action.ActionManager;
import com.whizzosoftware.hobson.api.config.ConfigurationPropertyMetaData;
import com.whizzosoftware.hobson.api.device.DeviceManager;
import com.whizzosoftware.hobson.api.disco.DiscoManager;
import com.whizzosoftware.hobson.api.event.*;
import com.whizzosoftware.hobson.api.hub.HubManager;
import com.whizzosoftware.hobson.api.plugin.*;
import com.whizzosoftware.hobson.api.task.TaskManager;
import com.whizzosoftware.hobson.api.util.UserUtil;
import com.whizzosoftware.hobson.api.variable.VariableManager;
import io.netty.util.concurrent.Future;
import org.osgi.framework.FrameworkUtil;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceEvent;
import org.osgi.framework.ServiceListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Collection;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
/**
* A class that encapsulates a Hobson plugin class in order to handle OSGi lifecycle events and provide
* the plugin event loop. This implements HobsonPlugin so it can will appear to the OSGi runtime as
* an actual plugin while it intercepts the OSGi lifecycle callbacks.
*
* @author Dan Noguerol
*/
public class HobsonPluginEventLoopWrapper implements HobsonPlugin, EventListener, ServiceListener {
private final Logger logger = LoggerFactory.getLogger(getClass());
// these will be dependency injected by the OSGi runtime
private volatile ActionManager actionManager;
private volatile DeviceManager deviceManager;
private volatile DiscoManager discoManager;
private volatile EventManager eventManager;
private volatile ExecutorService executorService;
private volatile HubManager hubManager;
private volatile PluginManager pluginManager;
private volatile TaskManager taskManager;
private volatile VariableManager variableManager;
private HobsonPlugin plugin;
/**
* Constructor.
*
* @param plugin the plugin to wrapper
*/
public HobsonPluginEventLoopWrapper(HobsonPlugin plugin) {
if (plugin != null) {
this.plugin = plugin;
} else {
throw new HobsonRuntimeException("Passed a null plugin to HobsonPluginEventLoopWrapper");
}
}
/**
* Called when the OSGi service is started. This performs plugin dependency injection and gets the
* plugin event loop started.
*/
public void start() {
// inject manager dependencies
getRuntime().setActionManager(actionManager);
getRuntime().setDeviceManager(deviceManager);
getRuntime().setDiscoManager(discoManager);
getRuntime().setEventManager(eventManager);
getRuntime().setHubManager(hubManager);
getRuntime().setPluginManager(pluginManager);
getRuntime().setTaskManager(taskManager);
getRuntime().setVariableManager(variableManager);
// wait for service to become registered before performing final initialization
try {
String filter = "(&(objectclass=" + HobsonPlugin.class.getName() + ")(pluginId=" + getId() + "))";
FrameworkUtil.getBundle(getClass()).getBundleContext().addServiceListener(this, filter);
} catch (InvalidSyntaxException e) {
logger.error("Error registering service listener for plugin " + getId(), e);
}
}
/**
* Called when the OSGi service is stopped. This will stop the plugin event loop.
*/
public void stop() {
// remove the service listener
FrameworkUtil.getBundle(getClass()).getBundleContext().removeServiceListener(this);
// shutdown the plugin
Future f = plugin.getRuntime().submitInEventLoop(new Runnable() {
@Override
public void run() {
// stop listening for all events
eventManager.removeListenerFromAllTopics(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, HobsonPluginEventLoopWrapper.this);
// unpublish all variables published by this plugin's devices
variableManager.getPublisher().unpublishAllPluginVariables(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, getId());
// stop all devices
deviceManager.getPublisher().unpublishAllDevices(plugin);
// shut down the plugin
getRuntime().onShutdown();
// post plugin stopped event
eventManager.postEvent(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, new PluginStoppedEvent(getId()));
// drop reference
plugin = null;
}
});
// wait for the async task to complete so that the OSGi framework knows that we've really stopped
try {
f.get();
} catch (Exception e) {
logger.error("Error waiting for plugin to stop", e);
}
}
/*
* EventManagerListener methods
*/
@Override
public void onHobsonEvent(final HobsonEvent event) {
plugin.getRuntime().executeInEventLoop(new Runnable() {
@Override
public void run() {
try {
if (event instanceof PluginConfigurationUpdateEvent && plugin.getId().equals(((PluginConfigurationUpdateEvent)event).getPluginId())) {
PluginConfigurationUpdateEvent pcue = (PluginConfigurationUpdateEvent)event;
plugin.getRuntime().onPluginConfigurationUpdate(pcue.getConfiguration());
} else if (event instanceof DeviceConfigurationUpdateEvent && plugin.getId().equals(((DeviceConfigurationUpdateEvent)event).getPluginId())) {
DeviceConfigurationUpdateEvent dcue = (DeviceConfigurationUpdateEvent)event;
plugin.getRuntime().onDeviceConfigurationUpdate(dcue.getDeviceId(), dcue.getConfiguration());
} else {
plugin.getRuntime().onHobsonEvent(event);
}
} catch (Exception e) {
logger.error("An error occurred processing an event", e);
}
}
});
}
/*
* Hobson plugin interface methods -- these all pass-through to the real plugin implementation
*/
@Override
public String getId() {
return plugin.getId();
}
@Override
public String getName() {
return plugin.getName();
}
@Override
public String getVersion() {
return plugin.getVersion();
}
@Override
public PluginStatus getStatus() {
return plugin.getStatus();
}
@Override
public long getRefreshInterval() {
return plugin.getRefreshInterval();
}
@Override
public String[] getEventTopics() {
return plugin.getEventTopics();
}
@Override
public Collection<ConfigurationPropertyMetaData> getConfigurationPropertyMetaData() {
return plugin.getConfigurationPropertyMetaData();
}
@Override
public PluginType getType() {
return plugin.getType();
}
@Override
public boolean isConfigurable() {
return plugin.isConfigurable();
}
@Override
public HobsonPluginRuntime getRuntime() {
return plugin.getRuntime();
}
@Override
public void serviceChanged(ServiceEvent serviceEvent) {
if (serviceEvent.getType() == ServiceEvent.REGISTERED) {
// register plugin for necessary event topics
int otherTopicsCount = 0;
String[] otherTopics = plugin.getEventTopics();
if (otherTopics != null) {
otherTopicsCount = otherTopics.length;
}
String[] topics = new String[otherTopicsCount + 2];
topics[0] = EventTopics.VARIABLES_TOPIC; // all plugins need to listen for variable events
topics[1] = EventTopics.CONFIG_TOPIC; // all plugins need to listen for configuration events
if (otherTopicsCount > 0) {
System.arraycopy(otherTopics, 0, topics, 2, otherTopicsCount);
}
eventManager.addListener(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, this, topics);
// start the event loop
Future f = getRuntime().submitInEventLoop(new Runnable() {
@Override
public void run() {
// start the plugin
getRuntime().onStartup(pluginManager.getPluginConfiguration(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, plugin).getPropertyDictionary());
// post plugin started event
eventManager.postEvent(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, new PluginStartedEvent(getId()));
// schedule the refresh callback if the plugin's refresh interval > 0
if (plugin.getRefreshInterval() > 0) {
getRuntime().scheduleAtFixedRateInEventLoop(new Runnable() {
@Override
public void run() {
try {
getRuntime().onRefresh();
} catch (Exception e) {
logger.error("Error refreshing plugin " + plugin.getId(), e);
}
}
}, 0, plugin.getRefreshInterval(), TimeUnit.SECONDS);
}
}
});
// wait for the async task to complete so that the OSGi framework knows that we've really started
try {
f.get();
} catch (Exception e) {
logger.error("Error waiting for plugin to start", e);
}
}
}
}
| src/main/java/com/whizzosoftware/hobson/bootstrap/api/plugin/HobsonPluginEventLoopWrapper.java | /*******************************************************************************
* Copyright (c) 2014 Whizzo Software, LLC.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*******************************************************************************/
package com.whizzosoftware.hobson.bootstrap.api.plugin;
import com.whizzosoftware.hobson.api.HobsonRuntimeException;
import com.whizzosoftware.hobson.api.action.ActionManager;
import com.whizzosoftware.hobson.api.config.ConfigurationPropertyMetaData;
import com.whizzosoftware.hobson.api.device.DeviceManager;
import com.whizzosoftware.hobson.api.disco.DiscoManager;
import com.whizzosoftware.hobson.api.event.*;
import com.whizzosoftware.hobson.api.hub.HubManager;
import com.whizzosoftware.hobson.api.plugin.*;
import com.whizzosoftware.hobson.api.task.TaskManager;
import com.whizzosoftware.hobson.api.util.UserUtil;
import com.whizzosoftware.hobson.api.variable.VariableManager;
import io.netty.util.concurrent.Future;
import org.osgi.framework.FrameworkUtil;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceEvent;
import org.osgi.framework.ServiceListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.Collection;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.TimeUnit;
/**
* A class that encapsulates a Hobson plugin class in order to handle OSGi lifecycle events and provide
* the plugin event loop. This implements HobsonPlugin so it can will appear to the OSGi runtime as
* an actual plugin while it intercepts the OSGi lifecycle callbacks.
*
* @author Dan Noguerol
*/
public class HobsonPluginEventLoopWrapper implements HobsonPlugin, EventListener, ServiceListener {
private final Logger logger = LoggerFactory.getLogger(getClass());
// these will be dependency injected by the OSGi runtime
private volatile ActionManager actionManager;
private volatile DeviceManager deviceManager;
private volatile DiscoManager discoManager;
private volatile EventManager eventManager;
private volatile ExecutorService executorService;
private volatile HubManager hubManager;
private volatile PluginManager pluginManager;
private volatile TaskManager taskManager;
private volatile VariableManager variableManager;
private HobsonPlugin plugin;
/**
* Constructor.
*
* @param plugin the plugin to wrapper
*/
public HobsonPluginEventLoopWrapper(HobsonPlugin plugin) {
if (plugin != null) {
this.plugin = plugin;
} else {
throw new HobsonRuntimeException("Passed a null plugin to HobsonPluginEventLoopWrapper");
}
}
/**
* Called when the OSGi service is started. This performs plugin dependency injection and gets the
* plugin event loop started.
*/
public void start() {
// inject manager dependencies
getRuntime().setActionManager(actionManager);
getRuntime().setDeviceManager(deviceManager);
getRuntime().setDiscoManager(discoManager);
getRuntime().setEventManager(eventManager);
getRuntime().setHubManager(hubManager);
getRuntime().setPluginManager(pluginManager);
getRuntime().setTaskManager(taskManager);
getRuntime().setVariableManager(variableManager);
// wait for service to become registered before performing final initialization
try {
String filter = "(&(objectclass=" + HobsonPlugin.class.getName() + ")(pluginId=" + getId() + "))";
FrameworkUtil.getBundle(getClass()).getBundleContext().addServiceListener(this, filter);
} catch (InvalidSyntaxException e) {
logger.error("Error registering service listener for plugin " + getId(), e);
}
}
/**
* Called when the OSGi service is stopped. This will stop the plugin event loop.
*/
public void stop() {
// remove the service listener
FrameworkUtil.getBundle(getClass()).getBundleContext().removeServiceListener(this);
// shutdown the plugin
Future f = plugin.getRuntime().submitInEventLoop(new Runnable() {
@Override
public void run() {
// stop listening for all events
eventManager.removeListenerFromAllTopics(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, HobsonPluginEventLoopWrapper.this);
// unpublish all variables published by this plugin's devices
variableManager.getPublisher().unpublishAllPluginVariables(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, getId());
// stop all devices
deviceManager.getPublisher().unpublishAllDevices(plugin);
// shut down the plugin
getRuntime().onShutdown();
// post plugin stopped event
eventManager.postEvent(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, new PluginStoppedEvent(getId()));
// drop reference
plugin = null;
}
});
// wait for the async task to complete so that the OSGi framework knows that we've really stopped
try {
f.get();
} catch (Exception e) {
logger.error("Error waiting for plugin to stop", e);
}
}
/*
* EventManagerListener methods
*/
@Override
public void onHobsonEvent(final HobsonEvent event) {
plugin.getRuntime().executeInEventLoop(new Runnable() {
@Override
public void run() {
try {
if (event instanceof PluginConfigurationUpdateEvent) {
PluginConfigurationUpdateEvent pcue = (PluginConfigurationUpdateEvent)event;
plugin.getRuntime().onPluginConfigurationUpdate(pcue.getConfiguration());
} else if (event instanceof DeviceConfigurationUpdateEvent) {
DeviceConfigurationUpdateEvent dcue = (DeviceConfigurationUpdateEvent)event;
plugin.getRuntime().onDeviceConfigurationUpdate(dcue.getDeviceId(), dcue.getConfiguration());
} else {
plugin.getRuntime().onHobsonEvent(event);
}
} catch (Exception e) {
logger.error("An error occurred processing an event", e);
}
}
});
}
/*
* Hobson plugin interface methods -- these all pass-through to the real plugin implementation
*/
@Override
public String getId() {
return plugin.getId();
}
@Override
public String getName() {
return plugin.getName();
}
@Override
public String getVersion() {
return plugin.getVersion();
}
@Override
public PluginStatus getStatus() {
return plugin.getStatus();
}
@Override
public long getRefreshInterval() {
return plugin.getRefreshInterval();
}
@Override
public String[] getEventTopics() {
return plugin.getEventTopics();
}
@Override
public Collection<ConfigurationPropertyMetaData> getConfigurationPropertyMetaData() {
return plugin.getConfigurationPropertyMetaData();
}
@Override
public PluginType getType() {
return plugin.getType();
}
@Override
public boolean isConfigurable() {
return plugin.isConfigurable();
}
@Override
public HobsonPluginRuntime getRuntime() {
return plugin.getRuntime();
}
@Override
public void serviceChanged(ServiceEvent serviceEvent) {
if (serviceEvent.getType() == ServiceEvent.REGISTERED) {
// register plugin for necessary event topics
int otherTopicsCount = 0;
String[] otherTopics = plugin.getEventTopics();
if (otherTopics != null) {
otherTopicsCount = otherTopics.length;
}
String[] topics = new String[otherTopicsCount + 2];
topics[0] = EventTopics.VARIABLES_TOPIC; // all plugins need to listen for variable events
topics[1] = EventTopics.CONFIG_TOPIC; // all plugins need to listen for configuration events
if (otherTopicsCount > 0) {
System.arraycopy(otherTopics, 0, topics, 2, otherTopicsCount);
}
eventManager.addListener(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, this, topics);
// start the event loop
Future f = getRuntime().submitInEventLoop(new Runnable() {
@Override
public void run() {
// start the plugin
getRuntime().onStartup(pluginManager.getPluginConfiguration(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, plugin).getPropertyDictionary());
// post plugin started event
eventManager.postEvent(UserUtil.DEFAULT_USER, UserUtil.DEFAULT_HUB, new PluginStartedEvent(getId()));
// schedule the refresh callback if the plugin's refresh interval > 0
if (plugin.getRefreshInterval() > 0) {
getRuntime().scheduleAtFixedRateInEventLoop(new Runnable() {
@Override
public void run() {
try {
getRuntime().onRefresh();
} catch (Exception e) {
logger.error("Error refreshing plugin " + plugin.getId(), e);
}
}
}, 0, plugin.getRefreshInterval(), TimeUnit.SECONDS);
}
}
});
// wait for the async task to complete so that the OSGi framework knows that we've really started
try {
f.get();
} catch (Exception e) {
logger.error("Error waiting for plugin to start", e);
}
}
}
}
| Fixed issue where plugin or device updates for a specific plugin would cause onPluginConfigurationUpdate() or onDeviceConfigurationUpdate() to be called on all plugins.
| src/main/java/com/whizzosoftware/hobson/bootstrap/api/plugin/HobsonPluginEventLoopWrapper.java | Fixed issue where plugin or device updates for a specific plugin would cause onPluginConfigurationUpdate() or onDeviceConfigurationUpdate() to be called on all plugins. | <ide><path>rc/main/java/com/whizzosoftware/hobson/bootstrap/api/plugin/HobsonPluginEventLoopWrapper.java
<ide> @Override
<ide> public void run() {
<ide> try {
<del> if (event instanceof PluginConfigurationUpdateEvent) {
<add> if (event instanceof PluginConfigurationUpdateEvent && plugin.getId().equals(((PluginConfigurationUpdateEvent)event).getPluginId())) {
<ide> PluginConfigurationUpdateEvent pcue = (PluginConfigurationUpdateEvent)event;
<ide> plugin.getRuntime().onPluginConfigurationUpdate(pcue.getConfiguration());
<del> } else if (event instanceof DeviceConfigurationUpdateEvent) {
<add> } else if (event instanceof DeviceConfigurationUpdateEvent && plugin.getId().equals(((DeviceConfigurationUpdateEvent)event).getPluginId())) {
<ide> DeviceConfigurationUpdateEvent dcue = (DeviceConfigurationUpdateEvent)event;
<ide> plugin.getRuntime().onDeviceConfigurationUpdate(dcue.getDeviceId(), dcue.getConfiguration());
<ide> } else { |
|
Java | bsd-3-clause | 6226183a3e491302c8e5f1d641a7f855fbadc70e | 0 | NCIP/stats-application-commons | package gov.nih.nci.caintegrator.application.util;
import gov.nih.nci.caintegrator.application.analysis.AnalysisServerClientManager;
import gov.nih.nci.caintegrator.application.service.ApplicationService;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.jms.JMSException;
import javax.naming.NamingException;
import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
import com.sun.org.apache.xerces.internal.impl.xs.dom.DOMParser;
/**
* @todo comment this!
* @author BhattarR, BauerD
*
*/
/**
* caIntegrator License
*
* Copyright 2001-2005 Science Applications International Corporation ("SAIC").
* The software subject to this notice and license includes both human readable source code form and machine readable,
* binary, object code form ("the caIntegrator Software"). The caIntegrator Software was developed in conjunction with
* the National Cancer Institute ("NCI") by NCI employees and employees of SAIC.
* To the extent government employees are authors, any rights in such works shall be subject to Title 17 of the United States
* Code, section 105.
* This caIntegrator Software License (the "License") is between NCI and You. "You (or "Your") shall mean a person or an
* entity, and all other entities that control, are controlled by, or are under common control with the entity. "Control"
* for purposes of this definition means (i) the direct or indirect power to cause the direction or management of such entity,
* whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii)
* beneficial ownership of such entity.
* This License is granted provided that You agree to the conditions described below. NCI grants You a non-exclusive,
* worldwide, perpetual, fully-paid-up, no-charge, irrevocable, transferable and royalty-free right and license in its rights
* in the caIntegrator Software to (i) use, install, access, operate, execute, copy, modify, translate, market, publicly
* display, publicly perform, and prepare derivative works of the caIntegrator Software; (ii) distribute and have distributed
* to and by third parties the caIntegrator Software and any modifications and derivative works thereof;
* and (iii) sublicense the foregoing rights set out in (i) and (ii) to third parties, including the right to license such
* rights to further third parties. For sake of clarity, and not by way of limitation, NCI shall have no right of accounting
* or right of payment from You or Your sublicensees for the rights granted under this License. This License is granted at no
* charge to You.
* 1. Your redistributions of the source code for the Software must retain the above copyright notice, this list of conditions
* and the disclaimer and limitation of liability of Article 6, below. Your redistributions in object code form must reproduce
* the above copyright notice, this list of conditions and the disclaimer of Article 6 in the documentation and/or other materials
* provided with the distribution, if any.
* 2. Your end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This
* product includes software developed by SAIC and the National Cancer Institute." If You do not include such end-user
* documentation, You shall include this acknowledgment in the Software itself, wherever such third-party acknowledgments
* normally appear.
* 3. You may not use the names "The National Cancer Institute", "NCI" "Science Applications International Corporation" and
* "SAIC" to endorse or promote products derived from this Software. This License does not authorize You to use any
* trademarks, service marks, trade names, logos or product names of either NCI or SAIC, except as required to comply with
* the terms of this License.
* 4. For sake of clarity, and not by way of limitation, You may incorporate this Software into Your proprietary programs and
* into any third party proprietary programs. However, if You incorporate the Software into third party proprietary
* programs, You agree that You are solely responsible for obtaining any permission from such third parties required to
* incorporate the Software into such third party proprietary programs and for informing Your sublicensees, including
* without limitation Your end-users, of their obligation to secure any required permissions from such third parties
* before incorporating the Software into such third party proprietary software programs. In the event that You fail
* to obtain such permissions, You agree to indemnify NCI for any claims against NCI by such third parties, except to
* the extent prohibited by law, resulting from Your failure to obtain such permissions.
* 5. For sake of clarity, and not by way of limitation, You may add Your own copyright statement to Your modifications and
* to the derivative works, and You may provide additional or different license terms and conditions in Your sublicenses
* of modifications of the Software, or any derivative works of the Software as a whole, provided Your use, reproduction,
* and distribution of the Work otherwise complies with the conditions stated in this License.
* 6. THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, (INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED.
* IN NO EVENT SHALL THE NATIONAL CANCER INSTITUTE, SAIC, OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
public class ApplicationContext{
private static Map mappings = new HashMap();
private static Logger logger = Logger.getLogger(ApplicationContext.class);
private static Properties labelProps = null;
private static Properties messagingProps = null;
private static Document doc =null;
/**
* COMMENT THIS
* @return
*/
public static Properties getLabelProperties() {
return labelProps;
}
public static Map getDEtoBeanAttributeMappings() {
return mappings;
}
public static Properties getJMSProperties(){
return messagingProps;
}
@SuppressWarnings("unused")
public static void init() {
logger.debug("Loading Application Resources");
// labelProps = PropertyLoader.loadProperties(RembrandtConstants.APPLICATION_RESOURCES);
// messagingProps = PropertyLoader.loadProperties(RembrandtConstants.JMS_PROPERTIES);
// try {
// logger.debug("Bean to Attribute Mappings");
// InputStream inStream = QueryHandler.class.getResourceAsStream(RembrandtConstants.DE_BEAN_FILE_NAME);
// assert true:inStream != null;
// DOMParser p = new DOMParser();
// p.parse(new InputSource(inStream));
// doc = p.getDocument();
// assert(doc != null);
// logger.debug("Begining DomainElement to Bean Mapping");
// mappings = new DEBeanMappingsHandler().populate(doc);
// logger.debug("DomainElement to Bean Mapping is completed");
// QueryHandler.init();
// } catch(Throwable t) {
// logger.error(new IllegalStateException("Error parsing deToBeanAttrMappings.xml file: Exception: " + t));
// }
//Start the JMS Lister
try {
//@SuppressWarnings("unused") AnalysisServerClientManager analysisServerClientManager = getApplicationService("ANALYSIS_SEVER_CLIENT_MGR").getInstance();
//Also need to create GeneExpressionAnnotationService
// } catch (NamingException e) {
// logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
// logger.error(e.getMessage());
// logger.error(e);
// } catch (JMSException e) {
// logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
// logger.error(e.getMessage());
// logger.error(e);
// }
}
catch(Throwable t) {
logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
logger.error(t.getMessage());
logger.error(t);
}
}
public static ApplicationService getApplicationService(String serviceName) {
// TODO Auto-generated method stub
return null;
}
}
| src/gov/nih/nci/caintegrator/application/util/ApplicationContext.java | package gov.nih.nci.caintegrator.application.util;
import gov.nih.nci.caintegrator.application.analysis.AnalysisServerClientManager;
import gov.nih.nci.caintegrator.application.service.ApplicationService;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import javax.jms.JMSException;
import javax.naming.NamingException;
import org.apache.log4j.Logger;
import org.w3c.dom.Document;
import org.xml.sax.InputSource;
import com.sun.org.apache.xerces.internal.impl.xs.dom.DOMParser;
/**
* @todo comment this!
* @author BhattarR, BauerD
*
*/
/**
* caIntegrator License
*
* Copyright 2001-2005 Science Applications International Corporation ("SAIC").
* The software subject to this notice and license includes both human readable source code form and machine readable,
* binary, object code form ("the caIntegrator Software"). The caIntegrator Software was developed in conjunction with
* the National Cancer Institute ("NCI") by NCI employees and employees of SAIC.
* To the extent government employees are authors, any rights in such works shall be subject to Title 17 of the United States
* Code, section 105.
* This caIntegrator Software License (the "License") is between NCI and You. "You (or "Your") shall mean a person or an
* entity, and all other entities that control, are controlled by, or are under common control with the entity. "Control"
* for purposes of this definition means (i) the direct or indirect power to cause the direction or management of such entity,
* whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii)
* beneficial ownership of such entity.
* This License is granted provided that You agree to the conditions described below. NCI grants You a non-exclusive,
* worldwide, perpetual, fully-paid-up, no-charge, irrevocable, transferable and royalty-free right and license in its rights
* in the caIntegrator Software to (i) use, install, access, operate, execute, copy, modify, translate, market, publicly
* display, publicly perform, and prepare derivative works of the caIntegrator Software; (ii) distribute and have distributed
* to and by third parties the caIntegrator Software and any modifications and derivative works thereof;
* and (iii) sublicense the foregoing rights set out in (i) and (ii) to third parties, including the right to license such
* rights to further third parties. For sake of clarity, and not by way of limitation, NCI shall have no right of accounting
* or right of payment from You or Your sublicensees for the rights granted under this License. This License is granted at no
* charge to You.
* 1. Your redistributions of the source code for the Software must retain the above copyright notice, this list of conditions
* and the disclaimer and limitation of liability of Article 6, below. Your redistributions in object code form must reproduce
* the above copyright notice, this list of conditions and the disclaimer of Article 6 in the documentation and/or other materials
* provided with the distribution, if any.
* 2. Your end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This
* product includes software developed by SAIC and the National Cancer Institute." If You do not include such end-user
* documentation, You shall include this acknowledgment in the Software itself, wherever such third-party acknowledgments
* normally appear.
* 3. You may not use the names "The National Cancer Institute", "NCI" "Science Applications International Corporation" and
* "SAIC" to endorse or promote products derived from this Software. This License does not authorize You to use any
* trademarks, service marks, trade names, logos or product names of either NCI or SAIC, except as required to comply with
* the terms of this License.
* 4. For sake of clarity, and not by way of limitation, You may incorporate this Software into Your proprietary programs and
* into any third party proprietary programs. However, if You incorporate the Software into third party proprietary
* programs, You agree that You are solely responsible for obtaining any permission from such third parties required to
* incorporate the Software into such third party proprietary programs and for informing Your sublicensees, including
* without limitation Your end-users, of their obligation to secure any required permissions from such third parties
* before incorporating the Software into such third party proprietary software programs. In the event that You fail
* to obtain such permissions, You agree to indemnify NCI for any claims against NCI by such third parties, except to
* the extent prohibited by law, resulting from Your failure to obtain such permissions.
* 5. For sake of clarity, and not by way of limitation, You may add Your own copyright statement to Your modifications and
* to the derivative works, and You may provide additional or different license terms and conditions in Your sublicenses
* of modifications of the Software, or any derivative works of the Software as a whole, provided Your use, reproduction,
* and distribution of the Work otherwise complies with the conditions stated in this License.
* 6. THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, (INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED.
* IN NO EVENT SHALL THE NATIONAL CANCER INSTITUTE, SAIC, OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
public class ApplicationContext{
private static Map mappings = new HashMap();
private static Logger logger = Logger.getLogger(ApplicationContext.class);
private static Properties labelProps = null;
private static Properties messagingProps = null;
private static Document doc =null;
/**
* COMMENT THIS
* @return
*/
public static Properties getLabelProperties() {
return labelProps;
}
public static Map getDEtoBeanAttributeMappings() {
return mappings;
}
public static Properties getJMSProperties(){
return messagingProps;
}
@SuppressWarnings("unused")
public static void init() {
logger.debug("Loading Application Resources");
// labelProps = PropertyLoader.loadProperties(RembrandtConstants.APPLICATION_RESOURCES);
// messagingProps = PropertyLoader.loadProperties(RembrandtConstants.JMS_PROPERTIES);
// try {
// logger.debug("Bean to Attribute Mappings");
// InputStream inStream = QueryHandler.class.getResourceAsStream(RembrandtConstants.DE_BEAN_FILE_NAME);
// assert true:inStream != null;
// DOMParser p = new DOMParser();
// p.parse(new InputSource(inStream));
// doc = p.getDocument();
// assert(doc != null);
// logger.debug("Begining DomainElement to Bean Mapping");
// mappings = new DEBeanMappingsHandler().populate(doc);
// logger.debug("DomainElement to Bean Mapping is completed");
// QueryHandler.init();
// } catch(Throwable t) {
// logger.error(new IllegalStateException("Error parsing deToBeanAttrMappings.xml file: Exception: " + t));
// }
//Start the JMS Lister
try {
@SuppressWarnings("unused") AnalysisServerClientManager analysisServerClientManager = AnalysisServerClientManager.getInstance();
//Also need to create GeneExpressionAnnotationService
} catch (NamingException e) {
logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
logger.error(e.getMessage());
logger.error(e);
} catch (JMSException e) {
logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
logger.error(e.getMessage());
logger.error(e);
} catch(Throwable t) {
logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
logger.error(t.getMessage());
logger.error(t);
}
}
public static ApplicationService getApplicationService(String serviceName) {
// TODO Auto-generated method stub
return null;
}
}
| Commented out some code to get it to compile.
SVN-Revision: 8089
| src/gov/nih/nci/caintegrator/application/util/ApplicationContext.java | Commented out some code to get it to compile. | <ide><path>rc/gov/nih/nci/caintegrator/application/util/ApplicationContext.java
<ide> // }
<ide> //Start the JMS Lister
<ide> try {
<del> @SuppressWarnings("unused") AnalysisServerClientManager analysisServerClientManager = AnalysisServerClientManager.getInstance();
<add> //@SuppressWarnings("unused") AnalysisServerClientManager analysisServerClientManager = getApplicationService("ANALYSIS_SEVER_CLIENT_MGR").getInstance();
<ide> //Also need to create GeneExpressionAnnotationService
<ide>
<del> } catch (NamingException e) {
<del> logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
<del> logger.error(e.getMessage());
<del> logger.error(e);
<del> } catch (JMSException e) {
<del> logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
<del> logger.error(e.getMessage());
<del> logger.error(e);
<del> } catch(Throwable t) {
<add>// } catch (NamingException e) {
<add>// logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
<add>// logger.error(e.getMessage());
<add>// logger.error(e);
<add>// } catch (JMSException e) {
<add>// logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
<add>// logger.error(e.getMessage());
<add>// logger.error(e);
<add>// }
<add> }
<add> catch(Throwable t) {
<ide> logger.error(new IllegalStateException("Error getting an instance of AnalysisServerClientManager" ));
<ide> logger.error(t.getMessage());
<ide> logger.error(t); |
|
Java | mit | 65f2c1dc25f326eba637379646141d0706e065eb | 0 | conveyal/r5,conveyal/r5,conveyal/r5,conveyal/r5,conveyal/r5 | package org.opentripplanner.analyst.cluster;
import com.amazonaws.regions.Region;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3Client;
import com.conveyal.geojson.GeoJsonModule;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.io.FileBackedOutputStream;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.config.SocketConfig;
import org.apache.http.conn.HttpHostConnectException;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.message.BasicHeader;
import org.apache.http.util.EntityUtils;
import org.opentripplanner.analyst.PointSet;
import org.opentripplanner.api.model.AgencyAndIdSerializer;
import org.opentripplanner.api.model.JodaLocalDateSerializer;
import org.opentripplanner.api.model.QualifiedModeSetSerializer;
import org.opentripplanner.api.model.TraverseModeSetSerializer;
import org.opentripplanner.common.MavenVersion;
import org.opentripplanner.profile.RaptorWorkerData;
import org.opentripplanner.profile.TNRepeatedRaptorProfileRouter;
import org.opentripplanner.streets.LinkedPointSet;
import org.opentripplanner.transit.TransportNetwork;
import org.opentripplanner.transit.TransportNetworkCache;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.net.SocketTimeoutException;
import java.net.URI;
import java.util.List;
import java.util.Properties;
import java.util.Random;
import java.util.UUID;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.zip.GZIPOutputStream;
/**
* This is an exact copy of AnalystWorker that's being modified to work with (new) TransitNetworks instead of (old) Graphs.
* We can afford the maintainability nightmare of duplicating so much code because this is intended to completely replace
* the old class sooner than later.
* We don't need to wait for point-to-point routing and detailed walking directions etc. to be available on the new
* TransitNetwork code to do analysis work with it.
*/
public class TNAnalystWorker implements Runnable {
/**
* worker ID - just a random ID so we can differentiate machines used for computation.
* Useful to isolate the logs from a particular machine, as well as to evaluate any
* variation in performance coming from variation in the performance of the underlying
* VMs.
*
* This needs to be static so the logger can access it; see the static member class
* WorkerIdDefiner. A side effect is that only one worker can run in a given JVM. It also
* needs to be defined before the logger is defined, so that it is initialized before the
* logger is.
*
* TODO use the per-thread slf4j ID feature
*/
public static final String machineId = UUID.randomUUID().toString().replaceAll("-", "");
private static final Logger LOG = LoggerFactory.getLogger(TNAnalystWorker.class);
public static final String WORKER_ID_HEADER = "X-Worker-Id";
public static final int POLL_TIMEOUT = 10 * 1000;
/** Keeps some TransportNetworks around, lazy-loading or lazy-building them. */
private final TransportNetworkCache transportNetworkCache;
/**
* If this value is non-negative, the worker will not actually do any work. It will just report all tasks
* as completed immediately, but will fail to do so on the given percentage of tasks. This is used in testing task
* re-delivery and overall broker sanity.
*/
public int dryRunFailureRate = -1;
/** How long (minimum, in milliseconds) should this worker stay alive after receiving a single point request? */
public static final int SINGLE_POINT_KEEPALIVE_MSEC = 15 * 60 * 1000;
/** should this worker shut down automatically */
public final boolean autoShutdown;
public static final Random random = new Random();
/** Records extra (meta-)data that is not essential to the calculation, such as speed and other performance info. */
private TaskStatisticsStore taskStatisticsStore;
/** is there currently a channel open to the broker to receive single point jobs? */
private volatile boolean sideChannelOpen = false;
/** Reads and writes JSON. */
ObjectMapper objectMapper;
String BROKER_BASE_URL = "http://localhost:9001";
static final HttpClient httpClient;
/** Cache RAPTOR data by Job ID */
private Cache<String, RaptorWorkerData> workerDataCache = CacheBuilder.newBuilder()
.maximumSize(10)
.build();
static {
PoolingHttpClientConnectionManager mgr = new PoolingHttpClientConnectionManager();
mgr.setDefaultMaxPerRoute(20);
int timeout = 10 * 1000; // TODO should this be a symbolic constant such as POLL_TIMEOUT ?
SocketConfig cfg = SocketConfig.custom()
.setSoTimeout(timeout)
.build();
mgr.setDefaultSocketConfig(cfg);
httpClient = HttpClients.custom()
.setConnectionManager(mgr)
.build();
}
// Builds and caches (old) Graphs
// ClusterGraphBuilder clusterGraphBuilder;
// Of course this will eventually need to be shared between multiple AnalystWorker threads.
PointSetDatastore pointSetDatastore;
// Clients for communicating with Amazon web services
AmazonS3 s3;
String graphIdAffinity = null;
long startupTime, nextShutdownCheckTime;
// Region awsRegion = Region.getRegion(Regions.EU_CENTRAL_1);
Region awsRegion = Region.getRegion(Regions.US_EAST_1);
/** AWS instance type, or null if not running on AWS. */
private String instanceType;
/** TODO what's this number? */
long lastHighPriorityRequestProcessed = 0;
/** If true Analyst is running locally, do not use internet connection and hosted servcies. */
private boolean workOffline;
/**
* Queues for high-priority interactive tasks and low-priority batch tasks.
* Should be plenty long enough to hold all that have come in - we don't need to block on polling the manager.
*/
private ThreadPoolExecutor highPriorityExecutor, batchExecutor;
public TNAnalystWorker(Properties config) {
// PARSE THE CONFIGURATION
// First, check whether we are running Analyst offline.
workOffline = Boolean.parseBoolean(config.getProperty("work-offline", "false"));
if (workOffline) {
LOG.info("Working offline. Avoiding internet connections and hosted services.");
}
// Set up the stats store.
String statsQueue = config.getProperty("statistics-queue");
if (workOffline || statsQueue == null) {
// A stats store that does nothing.
this.taskStatisticsStore = s -> { };
} else {
this.taskStatisticsStore = new SQSTaskStatisticsStore(statsQueue);
}
String addr = config.getProperty("broker-address");
String port = config.getProperty("broker-port");
if (addr != null) {
if (port != null) {
this.BROKER_BASE_URL = String.format("http://%s:%s", addr, port);
} else {
this.BROKER_BASE_URL = String.format("http://%s", addr);
}
}
// set the initial graph affinity of this worker (if it is not in the config file it will be
// set to null, i.e. no graph affinity)
// we don't actually build the graph now; this is just a hint to the broker as to what
// graph this machine was intended to analyze.
this.graphIdAffinity = config.getProperty("initial-graph-id");
this.pointSetDatastore = new PointSetDatastore(10, null, false, config.getProperty("pointsets-bucket"));
this.transportNetworkCache = new TransportNetworkCache(config.getProperty("graphs-bucket"));
Boolean autoShutdown = Boolean.parseBoolean(config.getProperty("auto-shutdown"));
this.autoShutdown = autoShutdown == null ? false : autoShutdown;
// Consider shutting this worker down once per hour, starting 55 minutes after it started up.
startupTime = System.currentTimeMillis();
nextShutdownCheckTime = startupTime + 55 * 60 * 1000;
// When creating the S3 and SQS clients use the default credentials chain.
// This will check environment variables and ~/.aws/credentials first, then fall back on
// the auto-assigned IAM role if this code is running on an EC2 instance.
// http://docs.aws.amazon.com/AWSSdkDocsJava/latest/DeveloperGuide/java-dg-roles.html
s3 = new AmazonS3Client();
s3.setRegion(awsRegion);
/* The ObjectMapper (de)serializes JSON. */
objectMapper = new ObjectMapper();
objectMapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
objectMapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); // ignore JSON fields that don't match target type
/* Tell Jackson how to (de)serialize AgencyAndIds, which appear as map keys in routing requests. */
objectMapper.registerModule(AgencyAndIdSerializer.makeModule());
/* serialize/deserialize qualified mode sets */
objectMapper.registerModule(QualifiedModeSetSerializer.makeModule());
/* serialize/deserialize Joda dates */
objectMapper.registerModule(JodaLocalDateSerializer.makeModule());
/* serialize/deserialize traversemodesets */
objectMapper.registerModule(TraverseModeSetSerializer.makeModule());
objectMapper.registerModule(new GeoJsonModule());
instanceType = getInstanceType();
}
/**
* This is the main worker event loop which fetches tasks from a broker and schedules them for execution.
* It maintains a small local queue so the worker doesn't idle while fetching new tasks.
*/
@Override
public void run() {
// Create executors with up to one thread per processor.
int nP = Runtime.getRuntime().availableProcessors();
highPriorityExecutor = new ThreadPoolExecutor(1, nP, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(255));
highPriorityExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
batchExecutor = new ThreadPoolExecutor(1, nP, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(nP * 2));
batchExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
// If an initial graph ID was provided in the config file, build that TransportNetwork on startup.
// TODO pre-building graphs may not be necessary once we're just loading them quickly from disk. Actually what is the point of doing this since we can lazy-build? Leaving it out.
// Start filling the work queues.
boolean idle = false;
while (true) {
long now = System.currentTimeMillis();
// Consider shutting down if enough time has passed
if (now > nextShutdownCheckTime && autoShutdown) {
if (idle && now > lastHighPriorityRequestProcessed + SINGLE_POINT_KEEPALIVE_MSEC) {
LOG.warn("Machine is idle, shutting down.");
try {
Process process = new ProcessBuilder("sudo", "/sbin/shutdown", "-h", "now").start();
process.waitFor();
} catch (Exception ex) {
LOG.error("Unable to terminate worker", ex);
} finally {
System.exit(0);
}
}
nextShutdownCheckTime += 60 * 60 * 1000;
}
LOG.info("Long-polling for work ({} second timeout).", POLL_TIMEOUT / 1000.0);
// Long-poll (wait a few seconds for messages to become available)
List<AnalystClusterRequest> tasks = getSomeWork(WorkType.BATCH);
if (tasks == null) {
LOG.info("Didn't get any work. Retrying.");
idle = true;
continue;
}
// Enqueue high-priority (interactive) tasks first to ensure they are enqueued
// even if the low-priority batch queue blocks.
tasks.stream().filter(t -> t.outputLocation == null)
.forEach(t -> highPriorityExecutor.execute(() -> {
LOG.warn("Handling single point request via normal channel, side channel should open shortly.");
this.handleOneRequest(t);
}));
// Enqueue low-priority (batch) tasks; note that this may block anywhere in the process
logQueueStatus();
tasks.stream().filter(t -> t.outputLocation != null)
.forEach(t -> {
// attempt to enqueue, waiting if the queue is full
while (true) {
try {
batchExecutor.execute(() -> this.handleOneRequest(t));
break;
} catch (RejectedExecutionException e) {
// queue is full, wait 200ms and try again
try {
Thread.sleep(200);
} catch (InterruptedException e1) { /* nothing */}
}
}
});
// TODO log info about the high-priority queue as well.
logQueueStatus();
idle = false;
}
}
/**
* This is the callback that processes a single task and returns the results upon completion.
* It may be called several times simultaneously on different executor threads.
*/
private void handleOneRequest(AnalystClusterRequest clusterRequest) {
if (dryRunFailureRate >= 0) {
// This worker is running in test mode.
// It should report all work as completed without actually doing anything,
// but will fail a certain percentage of the time.
if (random.nextInt(100) >= dryRunFailureRate) {
// Pretend to succeed.
deleteRequest(clusterRequest);
} else {
LOG.info("Intentionally failing on task {}", clusterRequest.taskId);
}
return;
}
try {
long startTime = System.currentTimeMillis();
LOG.info("Handling message {}", clusterRequest.toString());
// We need to distinguish between and handle four different types of requests here:
// Either vector isochrones or accessibility to a pointset,
// as either a single-origin priority request (where the result is returned immediately)
// or a job task (where the result is saved to output location on S3).
boolean isochrone = (clusterRequest.destinationPointsetId == null);
boolean singlePoint = (clusterRequest.outputLocation == null);
boolean transit = (clusterRequest.profileRequest.transitModes != null && !clusterRequest.profileRequest.transitModes.isTransit());
if (singlePoint) {
lastHighPriorityRequestProcessed = startTime;
if (!sideChannelOpen) {
openSideChannel();
}
}
TaskStatistics ts = new TaskStatistics();
ts.pointsetId = clusterRequest.destinationPointsetId;
ts.graphId = clusterRequest.graphId;
ts.awsInstanceType = instanceType;
ts.jobId = clusterRequest.jobId;
ts.workerId = machineId;
ts.single = singlePoint;
// Get the graph object for the ID given in the request, fetching inputs and building as needed.
// All requests handled together are for the same graph, and this call is synchronized so the graph will
// only be built once.
long graphStartTime = System.currentTimeMillis();
TransportNetwork transportNetwork = transportNetworkCache.getNetwork(clusterRequest.graphId);
// Record graphId so we "stick" to this same graph on subsequent polls.
// TODO allow for a list of multiple cached TransitNetworks.
graphIdAffinity = clusterRequest.graphId;
ts.graphBuild = (int) (System.currentTimeMillis() - graphStartTime);
// TODO lazy-initialize all additional indexes on transitLayer
// ts.graphTripCount = transportNetwork.transitLayer...
ts.graphStopCount = transportNetwork.transitLayer.streetVertexForStop.size(); // TODO nStops function.
ts.lon = clusterRequest.profileRequest.fromLon;
ts.lat = clusterRequest.profileRequest.fromLat;
// If this one-to-many request is for accessibility information based on travel times to a pointset,
// fetch the set of points we will use as destinations.
final PointSet targets;
final LinkedPointSet linkedTargets;
if (isochrone) {
// This is an isochrone request, search to a regular grid of points.
targets = transportNetwork.getGridPointSet();
} else {
// This is a detailed accessibility request. There is necessarily a destination point set supplied.
targets = pointSetDatastore.get(clusterRequest.destinationPointsetId);
}
linkedTargets = targets.link(transportNetwork.streetLayer); // TODO this breaks if transportNetwork has been rebuilt ?
TNRepeatedRaptorProfileRouter router =
new TNRepeatedRaptorProfileRouter(transportNetwork, clusterRequest, linkedTargets, ts);
// Produce RAPTOR data tables, going through a cache where relevant.
// This is only used for multi-point requests. Single-point requests are assumed to be continually
// changing, so we create throw-away RAPTOR tables for them.
// Ideally we'd want this caching to happen invisibly inside the RepeatedRaptorProfileRouter,
// but the RepeatedRaptorProfileRouter doesn't know the job ID or other information from the cluster request.
// It would be possible to just supply the cache _key_ as a way of saying that the cache should be used.
// But then we'd need to pass in both the cache and the key, which is weird.
long raptorDataStart = System.currentTimeMillis();
if (transit) {
// We only create data tables if transit is in use, otherwise they don't serve any purpose.
if (singlePoint) {
// Generate a one-time throw-away table if transit is in use but .
router.raptorWorkerData =
new RaptorWorkerData(transportNetwork.transitLayer, clusterRequest.profileRequest.date); // FIXME repetitive...
} else {
router.raptorWorkerData = workerDataCache.get(clusterRequest.jobId, () ->
new RaptorWorkerData(transportNetwork.transitLayer, clusterRequest.profileRequest.date));
}
// TODO include TempVertex targets and scenario mods, in RaptorWorkerData
}
ts.raptorData = (int) (System.currentTimeMillis() - raptorDataStart);
// Run the core repeated-raptor analysis.
// This result envelope will contain the results of the one-to-many profile or single-departure-time search.
ResultEnvelope envelope = new ResultEnvelope();
try {
envelope = router.route();
ts.success = true;
} catch (Exception ex) {
// An error occurred. Leave the envelope empty and TODO include error information.
LOG.error("Error occurred in profile request", ex);
ts.success = false;
}
// Send the ResultEnvelope back to the user.
// The results are either stored on S3 (for multi-origin jobs) or sent back through the broker (for
// immediate interactive display of isochrones).
envelope.id = clusterRequest.id;
envelope.jobId = clusterRequest.jobId;
envelope.destinationPointsetId = clusterRequest.destinationPointsetId;
if (clusterRequest.outputLocation != null) {
// Convert the result envelope and its contents to JSON and gzip it in this thread.
// Transfer the results to Amazon S3 in another thread, piping between the two.
String s3key = String.join("/", clusterRequest.jobId, clusterRequest.id + ".json.gz");
PipedInputStream inPipe = new PipedInputStream();
PipedOutputStream outPipe = new PipedOutputStream(inPipe);
Runnable resultSaverRunnable;
if (workOffline) {
resultSaverRunnable = () -> {
// No internet connection or hosted services. Save to local file.
try {
File fakeS3 = new File("S3", clusterRequest.outputLocation);
OutputStream fileOut = new FileOutputStream(new File(fakeS3, s3key));
} catch (FileNotFoundException e) {
LOG.error("Could not save results locally.");
}
};
} else {
resultSaverRunnable = () -> {
// TODO catch the case where the S3 putObject fails. (call deleteRequest based on PutObjectResult)
// Otherwise the AnalystWorker can freeze piping data to a failed S3 connection.
s3.putObject(clusterRequest.outputLocation, s3key, inPipe, null);
};
};
new Thread(resultSaverRunnable).start();
OutputStream gzipOutputStream = new GZIPOutputStream(outPipe);
// We could do the writeValue() in a thread instead, in which case both the DELETE and S3 options
// could consume it in the same way.
objectMapper.writeValue(gzipOutputStream, envelope);
gzipOutputStream.close();
// Tell the broker the task has been handled and should not be re - delivered to another worker.
deleteRequest(clusterRequest);
} else {
// No output location was provided. Instead of saving the result on S3,
// return the result immediately via a connection held open by the broker and mark the task completed.
finishPriorityTask(clusterRequest, envelope);
}
// Record information about the current task so we can analyze usage and efficiency over time.
ts.total = (int) (System.currentTimeMillis() - startTime);
taskStatisticsStore.store(ts);
} catch (Exception ex) {
LOG.error("An error occurred while routing", ex);
}
}
/** Open a single point channel to the broker to receive high-priority requests immediately */
private synchronized void openSideChannel () {
if (sideChannelOpen) {
return;
}
LOG.info("Opening side channel for single point requests.");
new Thread(() -> {
sideChannelOpen = true;
// don't keep single point connections alive forever
while (System.currentTimeMillis() < lastHighPriorityRequestProcessed + SINGLE_POINT_KEEPALIVE_MSEC) {
LOG.info("Awaiting high-priority work");
try {
List<AnalystClusterRequest> tasks = getSomeWork(WorkType.HIGH_PRIORITY);
if (tasks != null)
tasks.stream().forEach(t -> highPriorityExecutor.execute(
() -> this.handleOneRequest(t)));
logQueueStatus();
} catch (Exception e) {
LOG.error("Unexpected exception getting single point work", e);
}
}
sideChannelOpen = false;
}).start();
}
public List<AnalystClusterRequest> getSomeWork(WorkType type) {
// Run a POST request (long-polling for work) indicating which graph this worker prefers to work on
String url;
if (type == WorkType.HIGH_PRIORITY) {
// this is a side-channel request for single point work
url = BROKER_BASE_URL + "/single/" + graphIdAffinity;
} else {
url = BROKER_BASE_URL + "/dequeue/" + graphIdAffinity;
}
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader(new BasicHeader(WORKER_ID_HEADER, machineId));
HttpResponse response = null;
try {
response = httpClient.execute(httpPost);
HttpEntity entity = response.getEntity();
if (entity == null) {
return null;
}
if (response.getStatusLine().getStatusCode() != 200) {
EntityUtils.consumeQuietly(entity);
return null;
}
return objectMapper.readValue(entity.getContent(), new TypeReference<List<AnalystClusterRequest>>() {
});
} catch (JsonProcessingException e) {
LOG.error("JSON processing exception while getting work", e);
} catch (SocketTimeoutException stex) {
LOG.error("Socket timeout while waiting to receive work.");
} catch (HttpHostConnectException ce) {
LOG.error("Broker refused connection. Sleeping before retry.");
try {
Thread.currentThread().sleep(5000);
} catch (InterruptedException e) {
}
} catch (IOException e) {
LOG.error("IO exception while getting work", e);
}
return null;
}
/**
* Signal the broker that the given high-priority task is completed, providing a result.
*/
public void finishPriorityTask(AnalystClusterRequest clusterRequest, Object result) {
String url = BROKER_BASE_URL + String.format("/complete/priority/%s", clusterRequest.taskId);
HttpPost httpPost = new HttpPost(url);
try {
// TODO reveal any errors etc. that occurred on the worker.
// Really this should probably be done with an InputStreamEntity and a JSON writer thread.
byte[] serializedResult = objectMapper.writeValueAsBytes(result);
httpPost.setEntity(new ByteArrayEntity(serializedResult));
HttpResponse response = httpClient.execute(httpPost);
// Signal the http client library that we're done with this response object, allowing connection reuse.
EntityUtils.consumeQuietly(response.getEntity());
if (response.getStatusLine().getStatusCode() == 200) {
LOG.info("Successfully marked task {} as completed.", clusterRequest.taskId);
} else if (response.getStatusLine().getStatusCode() == 404) {
LOG.info("Task {} was not marked as completed because it doesn't exist.", clusterRequest.taskId);
} else {
LOG.info("Failed to mark task {} as completed, ({}).", clusterRequest.taskId,
response.getStatusLine());
}
} catch (Exception e) {
LOG.warn("Failed to mark task {} as completed.", clusterRequest.taskId, e);
}
}
/**
* Tell the broker that the given message has been successfully processed by a worker (HTTP DELETE).
*/
public void deleteRequest(AnalystClusterRequest clusterRequest) {
String url = BROKER_BASE_URL + String.format("/tasks/%s", clusterRequest.taskId);
HttpDelete httpDelete = new HttpDelete(url);
try {
HttpResponse response = httpClient.execute(httpDelete);
// Signal the http client library that we're done with this response object, allowing connection reuse.
EntityUtils.consumeQuietly(response.getEntity());
if (response.getStatusLine().getStatusCode() == 200) {
LOG.info("Successfully deleted task {}.", clusterRequest.taskId);
} else {
LOG.info("Failed to delete task {} ({}).", clusterRequest.taskId, response.getStatusLine());
}
} catch (Exception e) {
LOG.warn("Failed to delete task {}", clusterRequest.taskId, e);
}
}
/** Get the AWS instance type if applicable */
public String getInstanceType () {
try {
HttpGet get = new HttpGet();
// see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
// This seems very much not EC2-like to hardwire an IP address for getting instance metadata,
// but that's how it's done.
get.setURI(new URI("http://169.254.169.254/latest/meta-data/instance-type"));
get.setConfig(RequestConfig.custom()
.setConnectTimeout(2000)
.setSocketTimeout(2000)
.build()
);
HttpResponse res = httpClient.execute(get);
InputStream is = res.getEntity().getContent();
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
String type = reader.readLine().trim();
reader.close();
return type;
} catch (Exception e) {
LOG.info("could not retrieve EC2 instance type, you may be running outside of EC2.");
return null;
}
}
/** log queue status */
private void logQueueStatus() {
LOG.info("Waiting tasks: high priority: {}, batch: {}", highPriorityExecutor.getQueue().size(), batchExecutor.getQueue().size());
}
/**
* Requires a worker configuration, which is a Java Properties file with the following
* attributes.
*
* broker-address address of the broker, without protocol or port
* broker port port broker is running on, default 80.
* graphs-bucket S3 bucket in which graphs are stored.
* pointsets-bucket S3 bucket in which pointsets are stored
* auto-shutdown Should this worker shut down its machine if it is idle (e.g. on throwaway cloud instances)
* statistics-queue SQS queue to which to send statistics (optional)
* initial-graph-id The graph ID for this worker to start on
*/
public static void main(String[] args) {
LOG.info("Starting NEW STYLE ANALYST WORKER FOR TRANSPORTNETWORKS");
LOG.info("OTP commit is {}", MavenVersion.VERSION.commit);
Properties config = new Properties();
try {
File cfg;
if (args.length > 0)
cfg = new File(args[0]);
else
cfg = new File("worker.conf");
InputStream cfgis = new FileInputStream(cfg);
config.load(cfgis);
cfgis.close();
} catch (Exception e) {
LOG.info("Error loading worker configuration", e);
return;
}
try {
new TNAnalystWorker(config).run();
} catch (Exception e) {
LOG.error("Error in analyst worker", e);
return;
}
}
public static enum WorkType {
HIGH_PRIORITY, BATCH;
}
} | src/main/java/org/opentripplanner/analyst/cluster/TNAnalystWorker.java | package org.opentripplanner.analyst.cluster;
import com.amazonaws.regions.Region;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.s3.AmazonS3;
import com.amazonaws.services.s3.AmazonS3Client;
import com.conveyal.geojson.GeoJsonModule;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.HttpDelete;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.config.SocketConfig;
import org.apache.http.conn.HttpHostConnectException;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
import org.apache.http.message.BasicHeader;
import org.apache.http.util.EntityUtils;
import org.opentripplanner.analyst.PointSet;
import org.opentripplanner.api.model.AgencyAndIdSerializer;
import org.opentripplanner.api.model.JodaLocalDateSerializer;
import org.opentripplanner.api.model.QualifiedModeSetSerializer;
import org.opentripplanner.api.model.TraverseModeSetSerializer;
import org.opentripplanner.common.MavenVersion;
import org.opentripplanner.profile.RaptorWorkerData;
import org.opentripplanner.profile.TNRepeatedRaptorProfileRouter;
import org.opentripplanner.streets.LinkedPointSet;
import org.opentripplanner.transit.TransportNetwork;
import org.opentripplanner.transit.TransportNetworkCache;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.PipedInputStream;
import java.io.PipedOutputStream;
import java.net.SocketTimeoutException;
import java.net.URI;
import java.util.List;
import java.util.Properties;
import java.util.Random;
import java.util.UUID;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.RejectedExecutionException;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.zip.GZIPOutputStream;
/**
* This is an exact copy of AnalystWorker that's being modified to work with (new) TransitNetworks instead of (old) Graphs.
* We can afford the maintainability nightmare of duplicating so much code because this is intended to completely replace
* the old class sooner than later.
* We don't need to wait for point-to-point routing and detailed walking directions etc. to be available on the new
* TransitNetwork code to do analysis work with it.
*/
public class TNAnalystWorker implements Runnable {
/**
* worker ID - just a random ID so we can differentiate machines used for computation.
* Useful to isolate the logs from a particular machine, as well as to evaluate any
* variation in performance coming from variation in the performance of the underlying
* VMs.
*
* This needs to be static so the logger can access it; see the static member class
* WorkerIdDefiner. A side effect is that only one worker can run in a given JVM. It also
* needs to be defined before the logger is defined, so that it is initialized before the
* logger is.
*
* TODO use the per-thread slf4j ID feature
*/
public static final String machineId = UUID.randomUUID().toString().replaceAll("-", "");
private static final Logger LOG = LoggerFactory.getLogger(TNAnalystWorker.class);
public static final String WORKER_ID_HEADER = "X-Worker-Id";
public static final int POLL_TIMEOUT = 10 * 1000;
/** Keeps some TransportNetworks around, lazy-loading or lazy-building them. */
private final TransportNetworkCache transportNetworkCache;
/**
* If this value is non-negative, the worker will not actually do any work. It will just report all tasks
* as completed immediately, but will fail to do so on the given percentage of tasks. This is used in testing task
* re-delivery and overall broker sanity.
*/
public int dryRunFailureRate = -1;
/** How long (minimum, in milliseconds) should this worker stay alive after receiving a single point request? */
public static final int SINGLE_POINT_KEEPALIVE_MSEC = 15 * 60 * 1000;
/** should this worker shut down automatically */
public final boolean autoShutdown;
public static final Random random = new Random();
/** Records extra (meta-)data that is not essential to the calculation, such as speed and other performance info. */
private TaskStatisticsStore taskStatisticsStore;
/** is there currently a channel open to the broker to receive single point jobs? */
private volatile boolean sideChannelOpen = false;
/** Reads and writes JSON. */
ObjectMapper objectMapper;
String BROKER_BASE_URL = "http://localhost:9001";
static final HttpClient httpClient;
/** Cache RAPTOR data by Job ID */
private Cache<String, RaptorWorkerData> workerDataCache = CacheBuilder.newBuilder()
.maximumSize(10)
.build();
static {
PoolingHttpClientConnectionManager mgr = new PoolingHttpClientConnectionManager();
mgr.setDefaultMaxPerRoute(20);
int timeout = 10 * 1000; // TODO should this be a symbolic constant such as POLL_TIMEOUT ?
SocketConfig cfg = SocketConfig.custom()
.setSoTimeout(timeout)
.build();
mgr.setDefaultSocketConfig(cfg);
httpClient = HttpClients.custom()
.setConnectionManager(mgr)
.build();
}
// Builds and caches (old) Graphs
// ClusterGraphBuilder clusterGraphBuilder;
// Of course this will eventually need to be shared between multiple AnalystWorker threads.
PointSetDatastore pointSetDatastore;
// Clients for communicating with Amazon web services
AmazonS3 s3;
String graphIdAffinity = null;
long startupTime, nextShutdownCheckTime;
// Region awsRegion = Region.getRegion(Regions.EU_CENTRAL_1);
Region awsRegion = Region.getRegion(Regions.US_EAST_1);
/** AWS instance type, or null if not running on AWS. */
private String instanceType;
/** TODO what's this number? */
long lastHighPriorityRequestProcessed = 0;
/**
* Queues for high-priority interactive tasks and low-priority batch tasks.
* Should be plenty long enough to hold all that have come in - we don't need to block on polling the manager.
*/
private ThreadPoolExecutor highPriorityExecutor, batchExecutor;
public TNAnalystWorker(Properties config) {
// PARSE THE CONFIGURATION
// Set up the stats store.
String statsQueue = config.getProperty("statistics-queue");
if (statsQueue != null) {
this.taskStatisticsStore = new SQSTaskStatisticsStore(statsQueue);
} else {
// a stats store that does nothing.
this.taskStatisticsStore = s -> { };
}
String addr = config.getProperty("broker-address");
String port = config.getProperty("broker-port");
if (addr != null) {
if (port != null) {
this.BROKER_BASE_URL = String.format("http://%s:%s", addr, port);
} else {
this.BROKER_BASE_URL = String.format("http://%s", addr);
}
}
// set the initial graph affinity of this worker (if it is not in the config file it will be
// set to null, i.e. no graph affinity)
// we don't actually build the graph now; this is just a hint to the broker as to what
// graph this machine was intended to analyze.
this.graphIdAffinity = config.getProperty("initial-graph-id");
this.pointSetDatastore = new PointSetDatastore(10, null, false, config.getProperty("pointsets-bucket"));
this.transportNetworkCache = new TransportNetworkCache(config.getProperty("graphs-bucket"));
Boolean autoShutdown = Boolean.parseBoolean(config.getProperty("auto-shutdown"));
this.autoShutdown = autoShutdown == null ? false : autoShutdown;
// Consider shutting this worker down once per hour, starting 55 minutes after it started up.
startupTime = System.currentTimeMillis();
nextShutdownCheckTime = startupTime + 55 * 60 * 1000;
// When creating the S3 and SQS clients use the default credentials chain.
// This will check environment variables and ~/.aws/credentials first, then fall back on
// the auto-assigned IAM role if this code is running on an EC2 instance.
// http://docs.aws.amazon.com/AWSSdkDocsJava/latest/DeveloperGuide/java-dg-roles.html
s3 = new AmazonS3Client();
s3.setRegion(awsRegion);
/* The ObjectMapper (de)serializes JSON. */
objectMapper = new ObjectMapper();
objectMapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
objectMapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); // ignore JSON fields that don't match target type
/* Tell Jackson how to (de)serialize AgencyAndIds, which appear as map keys in routing requests. */
objectMapper.registerModule(AgencyAndIdSerializer.makeModule());
/* serialize/deserialize qualified mode sets */
objectMapper.registerModule(QualifiedModeSetSerializer.makeModule());
/* serialize/deserialize Joda dates */
objectMapper.registerModule(JodaLocalDateSerializer.makeModule());
/* serialize/deserialize traversemodesets */
objectMapper.registerModule(TraverseModeSetSerializer.makeModule());
objectMapper.registerModule(new GeoJsonModule());
instanceType = getInstanceType();
}
/**
* This is the main worker event loop which fetches tasks from a broker and schedules them for execution.
* It maintains a small local queue so the worker doesn't idle while fetching new tasks.
*/
@Override
public void run() {
// Create executors with up to one thread per processor.
int nP = Runtime.getRuntime().availableProcessors();
highPriorityExecutor = new ThreadPoolExecutor(1, nP, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(255));
highPriorityExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());
batchExecutor = new ThreadPoolExecutor(1, nP, 60, TimeUnit.SECONDS, new ArrayBlockingQueue<>(nP * 2));
batchExecutor.setRejectedExecutionHandler(new ThreadPoolExecutor.AbortPolicy());
// If an initial graph ID was provided in the config file, build that TransportNetwork on startup.
// TODO pre-building graphs may not be necessary once we're just loading them quickly from disk. Actually what is the point of doing this since we can lazy-build? Leaving it out.
// Start filling the work queues.
boolean idle = false;
while (true) {
long now = System.currentTimeMillis();
// Consider shutting down if enough time has passed
if (now > nextShutdownCheckTime && autoShutdown) {
if (idle && now > lastHighPriorityRequestProcessed + SINGLE_POINT_KEEPALIVE_MSEC) {
LOG.warn("Machine is idle, shutting down.");
try {
Process process = new ProcessBuilder("sudo", "/sbin/shutdown", "-h", "now").start();
process.waitFor();
} catch (Exception ex) {
LOG.error("Unable to terminate worker", ex);
} finally {
System.exit(0);
}
}
nextShutdownCheckTime += 60 * 60 * 1000;
}
LOG.info("Long-polling for work ({} second timeout).", POLL_TIMEOUT / 1000.0);
// Long-poll (wait a few seconds for messages to become available)
List<AnalystClusterRequest> tasks = getSomeWork(WorkType.BATCH);
if (tasks == null) {
LOG.info("Didn't get any work. Retrying.");
idle = true;
continue;
}
// Enqueue high-priority (interactive) tasks first to ensure they are enqueued
// even if the low-priority batch queue blocks.
tasks.stream().filter(t -> t.outputLocation == null)
.forEach(t -> highPriorityExecutor.execute(() -> {
LOG.warn("Handling single point request via normal channel, side channel should open shortly.");
this.handleOneRequest(t);
}));
// Enqueue low-priority (batch) tasks; note that this may block anywhere in the process
logQueueStatus();
tasks.stream().filter(t -> t.outputLocation != null)
.forEach(t -> {
// attempt to enqueue, waiting if the queue is full
while (true) {
try {
batchExecutor.execute(() -> this.handleOneRequest(t));
break;
} catch (RejectedExecutionException e) {
// queue is full, wait 200ms and try again
try {
Thread.sleep(200);
} catch (InterruptedException e1) { /* nothing */}
}
}
});
// TODO log info about the high-priority queue as well.
logQueueStatus();
idle = false;
}
}
/**
* This is the callback that processes a single task and returns the results upon completion.
* It may be called several times simultaneously on different executor threads.
*/
private void handleOneRequest(AnalystClusterRequest clusterRequest) {
if (dryRunFailureRate >= 0) {
// This worker is running in test mode.
// It should report all work as completed without actually doing anything,
// but will fail a certain percentage of the time.
if (random.nextInt(100) >= dryRunFailureRate) {
// Pretend to succeed.
deleteRequest(clusterRequest);
} else {
LOG.info("Intentionally failing on task {}", clusterRequest.taskId);
}
return;
}
try {
long startTime = System.currentTimeMillis();
LOG.info("Handling message {}", clusterRequest.toString());
// We need to distinguish between and handle four different types of requests here:
// Either vector isochrones or accessibility to a pointset,
// as either a single-origin priority request (where the result is returned immediately)
// or a job task (where the result is saved to output location on S3).
boolean isochrone = (clusterRequest.destinationPointsetId == null);
boolean singlePoint = (clusterRequest.outputLocation == null);
boolean transit = (clusterRequest.profileRequest.transitModes != null && !clusterRequest.profileRequest.transitModes.isTransit());
if (singlePoint) {
lastHighPriorityRequestProcessed = startTime;
if (!sideChannelOpen) {
openSideChannel();
}
}
TaskStatistics ts = new TaskStatistics();
ts.pointsetId = clusterRequest.destinationPointsetId;
ts.graphId = clusterRequest.graphId;
ts.awsInstanceType = instanceType;
ts.jobId = clusterRequest.jobId;
ts.workerId = machineId;
ts.single = singlePoint;
// Get the graph object for the ID given in the request, fetching inputs and building as needed.
// All requests handled together are for the same graph, and this call is synchronized so the graph will
// only be built once.
long graphStartTime = System.currentTimeMillis();
TransportNetwork transportNetwork = transportNetworkCache.getNetwork(clusterRequest.graphId);
// Record graphId so we "stick" to this same graph on subsequent polls.
// TODO allow for a list of multiple cached TransitNetworks.
graphIdAffinity = clusterRequest.graphId;
ts.graphBuild = (int) (System.currentTimeMillis() - graphStartTime);
// TODO lazy-initialize all additional indexes on transitLayer
// ts.graphTripCount = transportNetwork.transitLayer...
ts.graphStopCount = transportNetwork.transitLayer.streetVertexForStop.size(); // TODO nStops function.
ts.lon = clusterRequest.profileRequest.fromLon;
ts.lat = clusterRequest.profileRequest.fromLat;
// If this one-to-many request is for accessibility information based on travel times to a pointset,
// fetch the set of points we will use as destinations.
final PointSet targets;
final LinkedPointSet linkedTargets;
if (isochrone) {
// This is an isochrone request, search to a regular grid of points.
targets = transportNetwork.getGridPointSet();
} else {
// This is a detailed accessibility request. There is necessarily a destination point set supplied.
targets = pointSetDatastore.get(clusterRequest.destinationPointsetId);
}
linkedTargets = targets.link(transportNetwork.streetLayer); // TODO this breaks if transportNetwork has been rebuilt ?
TNRepeatedRaptorProfileRouter router =
new TNRepeatedRaptorProfileRouter(transportNetwork, clusterRequest, linkedTargets, ts);
// Produce RAPTOR data tables, going through a cache where relevant.
// This is only used for multi-point requests. Single-point requests are assumed to be continually
// changing, so we create throw-away RAPTOR tables for them.
// Ideally we'd want this caching to happen invisibly inside the RepeatedRaptorProfileRouter,
// but the RepeatedRaptorProfileRouter doesn't know the job ID or other information from the cluster request.
// It would be possible to just supply the cache _key_ as a way of saying that the cache should be used.
// But then we'd need to pass in both the cache and the key, which is weird.
long raptorDataStart = System.currentTimeMillis();
if (transit) {
// We only create data tables if transit is in use, otherwise they don't serve any purpose.
if (singlePoint) {
// Generate a one-time throw-away table if transit is in use but .
router.raptorWorkerData =
new RaptorWorkerData(transportNetwork.transitLayer, clusterRequest.profileRequest.date); // FIXME repetitive...
} else {
router.raptorWorkerData = workerDataCache.get(clusterRequest.jobId, () ->
new RaptorWorkerData(transportNetwork.transitLayer, clusterRequest.profileRequest.date));
}
// TODO include TempVertex targets and scenario mods, in RaptorWorkerData
}
ts.raptorData = (int) (System.currentTimeMillis() - raptorDataStart);
// Run the core repeated-raptor analysis.
// This result envelope will contain the results of the one-to-many profile or single-departure-time search.
ResultEnvelope envelope = new ResultEnvelope();
try {
envelope = router.route();
envelope.id = clusterRequest.id;
ts.success = true;
} catch (Exception ex) {
// An error occurred. Leave the envelope empty and TODO include error information.
LOG.error("Error occurred in profile request", ex);
ts.success = false;
}
// Send the ResultEnvelope back to the user.
// The results are either stored on S3 (for multi-origin jobs) or sent back through the broker (for
// immediate interactive display of isochrones).
envelope.id = clusterRequest.id;
envelope.jobId = clusterRequest.jobId;
envelope.destinationPointsetId = clusterRequest.destinationPointsetId;
if (clusterRequest.outputLocation != null) {
// Convert the result envelope and its contents to JSON and gzip it in this thread.
// Transfer the results to Amazon S3 in another thread, piping between the two.
String s3key = String.join("/", clusterRequest.jobId, clusterRequest.id + ".json.gz");
PipedInputStream inPipe = new PipedInputStream();
PipedOutputStream outPipe = new PipedOutputStream(inPipe);
new Thread(() -> {
s3.putObject(clusterRequest.outputLocation, s3key, inPipe, null);
}).start();
OutputStream gzipOutputStream = new GZIPOutputStream(outPipe);
// We could do the writeValue() in a thread instead, in which case both the DELETE and S3 options
// could consume it in the same way.
objectMapper.writeValue(gzipOutputStream, envelope);
gzipOutputStream.close();
// Tell the broker the task has been handled and should not be re-delivered to another worker.
deleteRequest(clusterRequest);
} else {
// No output location was provided. Instead of saving the result on S3,
// return the result immediately via a connection held open by the broker and mark the task completed.
finishPriorityTask(clusterRequest, envelope);
}
// Record information about the current task so we can analyze usage and efficiency over time.
ts.total = (int) (System.currentTimeMillis() - startTime);
taskStatisticsStore.store(ts);
} catch (Exception ex) {
LOG.error("An error occurred while routing", ex);
}
}
/** Open a single point channel to the broker to receive high-priority requests immediately */
private synchronized void openSideChannel () {
if (sideChannelOpen) {
return;
}
LOG.info("Opening side channel for single point requests.");
new Thread(() -> {
sideChannelOpen = true;
// don't keep single point connections alive forever
while (System.currentTimeMillis() < lastHighPriorityRequestProcessed + SINGLE_POINT_KEEPALIVE_MSEC) {
LOG.info("Awaiting high-priority work");
try {
List<AnalystClusterRequest> tasks = getSomeWork(WorkType.HIGH_PRIORITY);
if (tasks != null)
tasks.stream().forEach(t -> highPriorityExecutor.execute(
() -> this.handleOneRequest(t)));
logQueueStatus();
} catch (Exception e) {
LOG.error("Unexpected exception getting single point work", e);
}
}
sideChannelOpen = false;
}).start();
}
public List<AnalystClusterRequest> getSomeWork(WorkType type) {
// Run a POST request (long-polling for work) indicating which graph this worker prefers to work on
String url;
if (type == WorkType.HIGH_PRIORITY) {
// this is a side-channel request for single point work
url = BROKER_BASE_URL + "/single/" + graphIdAffinity;
} else {
url = BROKER_BASE_URL + "/dequeue/" + graphIdAffinity;
}
HttpPost httpPost = new HttpPost(url);
httpPost.setHeader(new BasicHeader(WORKER_ID_HEADER, machineId));
HttpResponse response = null;
try {
response = httpClient.execute(httpPost);
HttpEntity entity = response.getEntity();
if (entity == null) {
return null;
}
if (response.getStatusLine().getStatusCode() != 200) {
EntityUtils.consumeQuietly(entity);
return null;
}
return objectMapper.readValue(entity.getContent(), new TypeReference<List<AnalystClusterRequest>>() {
});
} catch (JsonProcessingException e) {
LOG.error("JSON processing exception while getting work", e);
} catch (SocketTimeoutException stex) {
LOG.error("Socket timeout while waiting to receive work.");
} catch (HttpHostConnectException ce) {
LOG.error("Broker refused connection. Sleeping before retry.");
try {
Thread.currentThread().sleep(5000);
} catch (InterruptedException e) {
}
} catch (IOException e) {
LOG.error("IO exception while getting work", e);
}
return null;
}
/**
* Signal the broker that the given high-priority task is completed, providing a result.
*/
public void finishPriorityTask(AnalystClusterRequest clusterRequest, Object result) {
String url = BROKER_BASE_URL + String.format("/complete/priority/%s", clusterRequest.taskId);
HttpPost httpPost = new HttpPost(url);
try {
// TODO reveal any errors etc. that occurred on the worker.
// Really this should probably be done with an InputStreamEntity and a JSON writer thread.
byte[] serializedResult = objectMapper.writeValueAsBytes(result);
httpPost.setEntity(new ByteArrayEntity(serializedResult));
HttpResponse response = httpClient.execute(httpPost);
// Signal the http client library that we're done with this response object, allowing connection reuse.
EntityUtils.consumeQuietly(response.getEntity());
if (response.getStatusLine().getStatusCode() == 200) {
LOG.info("Successfully marked task {} as completed.", clusterRequest.taskId);
} else if (response.getStatusLine().getStatusCode() == 404) {
LOG.info("Task {} was not marked as completed because it doesn't exist.", clusterRequest.taskId);
} else {
LOG.info("Failed to mark task {} as completed, ({}).", clusterRequest.taskId,
response.getStatusLine());
}
} catch (Exception e) {
LOG.warn("Failed to mark task {} as completed.", clusterRequest.taskId, e);
}
}
/**
* Tell the broker that the given message has been successfully processed by a worker (HTTP DELETE).
*/
public void deleteRequest(AnalystClusterRequest clusterRequest) {
String url = BROKER_BASE_URL + String.format("/tasks/%s", clusterRequest.taskId);
HttpDelete httpDelete = new HttpDelete(url);
try {
HttpResponse response = httpClient.execute(httpDelete);
// Signal the http client library that we're done with this response object, allowing connection reuse.
EntityUtils.consumeQuietly(response.getEntity());
if (response.getStatusLine().getStatusCode() == 200) {
LOG.info("Successfully deleted task {}.", clusterRequest.taskId);
} else {
LOG.info("Failed to delete task {} ({}).", clusterRequest.taskId, response.getStatusLine());
}
} catch (Exception e) {
LOG.warn("Failed to delete task {}", clusterRequest.taskId, e);
}
}
/** Get the AWS instance type if applicable */
public String getInstanceType () {
try {
HttpGet get = new HttpGet();
// see http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html
// This seems very much not EC2-like to hardwire an IP address for getting instance metadata,
// but that's how it's done.
get.setURI(new URI("http://169.254.169.254/latest/meta-data/instance-type"));
get.setConfig(RequestConfig.custom()
.setConnectTimeout(2000)
.setSocketTimeout(2000)
.build()
);
HttpResponse res = httpClient.execute(get);
InputStream is = res.getEntity().getContent();
BufferedReader reader = new BufferedReader(new InputStreamReader(is));
String type = reader.readLine().trim();
reader.close();
return type;
} catch (Exception e) {
LOG.info("could not retrieve EC2 instance type, you may be running outside of EC2.");
return null;
}
}
/** log queue status */
private void logQueueStatus() {
LOG.info("Waiting tasks: high priority: {}, batch: {}", highPriorityExecutor.getQueue().size(), batchExecutor.getQueue().size());
}
/**
* Requires a worker configuration, which is a Java Properties file with the following
* attributes.
*
* broker-address address of the broker, without protocol or port
* broker port port broker is running on, default 80.
* graphs-bucket S3 bucket in which graphs are stored.
* pointsets-bucket S3 bucket in which pointsets are stored
* auto-shutdown Should this worker shut down its machine if it is idle (e.g. on throwaway cloud instances)
* statistics-queue SQS queue to which to send statistics (optional)
* initial-graph-id The graph ID for this worker to start on
*/
public static void main(String[] args) {
LOG.info("Starting analyst worker");
LOG.info("OTP commit is {}", MavenVersion.VERSION.commit);
Properties config = new Properties();
try {
File cfg;
if (args.length > 0)
cfg = new File(args[0]);
else
cfg = new File("worker.conf");
InputStream cfgis = new FileInputStream(cfg);
config.load(cfgis);
cfgis.close();
} catch (Exception e) {
LOG.info("Error loading worker configuration", e);
return;
}
try {
new TNAnalystWorker(config).run();
} catch (Exception e) {
LOG.error("Error in analyst worker", e);
return;
}
}
public static enum WorkType {
HIGH_PRIORITY, BATCH;
}
} | work offline mode for new Analyst worker
Former-commit-id: cf14a186fb5a106206ec1234f6ef761984fc28b6
| src/main/java/org/opentripplanner/analyst/cluster/TNAnalystWorker.java | work offline mode for new Analyst worker | <ide><path>rc/main/java/org/opentripplanner/analyst/cluster/TNAnalystWorker.java
<ide> import com.fasterxml.jackson.databind.ObjectMapper;
<ide> import com.google.common.cache.Cache;
<ide> import com.google.common.cache.CacheBuilder;
<add>import com.google.common.io.FileBackedOutputStream;
<ide> import org.apache.http.HttpEntity;
<ide> import org.apache.http.HttpResponse;
<ide> import org.apache.http.client.HttpClient;
<ide> import java.io.BufferedReader;
<ide> import java.io.File;
<ide> import java.io.FileInputStream;
<add>import java.io.FileNotFoundException;
<add>import java.io.FileOutputStream;
<ide> import java.io.IOException;
<ide> import java.io.InputStream;
<ide> import java.io.InputStreamReader;
<ide> /** TODO what's this number? */
<ide> long lastHighPriorityRequestProcessed = 0;
<ide>
<add> /** If true Analyst is running locally, do not use internet connection and hosted servcies. */
<add> private boolean workOffline;
<add>
<ide> /**
<ide> * Queues for high-priority interactive tasks and low-priority batch tasks.
<ide> * Should be plenty long enough to hold all that have come in - we don't need to block on polling the manager.
<ide>
<ide> // PARSE THE CONFIGURATION
<ide>
<add> // First, check whether we are running Analyst offline.
<add> workOffline = Boolean.parseBoolean(config.getProperty("work-offline", "false"));
<add> if (workOffline) {
<add> LOG.info("Working offline. Avoiding internet connections and hosted services.");
<add> }
<add>
<ide> // Set up the stats store.
<ide> String statsQueue = config.getProperty("statistics-queue");
<del> if (statsQueue != null) {
<add> if (workOffline || statsQueue == null) {
<add> // A stats store that does nothing.
<add> this.taskStatisticsStore = s -> { };
<add> } else {
<ide> this.taskStatisticsStore = new SQSTaskStatisticsStore(statsQueue);
<del> } else {
<del> // a stats store that does nothing.
<del> this.taskStatisticsStore = s -> { };
<ide> }
<ide>
<ide> String addr = config.getProperty("broker-address");
<ide> ResultEnvelope envelope = new ResultEnvelope();
<ide> try {
<ide> envelope = router.route();
<del> envelope.id = clusterRequest.id;
<ide> ts.success = true;
<ide> } catch (Exception ex) {
<ide> // An error occurred. Leave the envelope empty and TODO include error information.
<ide> String s3key = String.join("/", clusterRequest.jobId, clusterRequest.id + ".json.gz");
<ide> PipedInputStream inPipe = new PipedInputStream();
<ide> PipedOutputStream outPipe = new PipedOutputStream(inPipe);
<del> new Thread(() -> {
<del> s3.putObject(clusterRequest.outputLocation, s3key, inPipe, null);
<del> }).start();
<add> Runnable resultSaverRunnable;
<add> if (workOffline) {
<add> resultSaverRunnable = () -> {
<add> // No internet connection or hosted services. Save to local file.
<add> try {
<add> File fakeS3 = new File("S3", clusterRequest.outputLocation);
<add> OutputStream fileOut = new FileOutputStream(new File(fakeS3, s3key));
<add> } catch (FileNotFoundException e) {
<add> LOG.error("Could not save results locally.");
<add> }
<add> };
<add> } else {
<add> resultSaverRunnable = () -> {
<add> // TODO catch the case where the S3 putObject fails. (call deleteRequest based on PutObjectResult)
<add> // Otherwise the AnalystWorker can freeze piping data to a failed S3 connection.
<add> s3.putObject(clusterRequest.outputLocation, s3key, inPipe, null);
<add> };
<add> };
<add> new Thread(resultSaverRunnable).start();
<ide> OutputStream gzipOutputStream = new GZIPOutputStream(outPipe);
<ide> // We could do the writeValue() in a thread instead, in which case both the DELETE and S3 options
<ide> // could consume it in the same way.
<ide> objectMapper.writeValue(gzipOutputStream, envelope);
<ide> gzipOutputStream.close();
<del> // Tell the broker the task has been handled and should not be re-delivered to another worker.
<add>
<add> // Tell the broker the task has been handled and should not be re - delivered to another worker.
<ide> deleteRequest(clusterRequest);
<ide> } else {
<ide> // No output location was provided. Instead of saving the result on S3,
<ide> * initial-graph-id The graph ID for this worker to start on
<ide> */
<ide> public static void main(String[] args) {
<del> LOG.info("Starting analyst worker");
<add> LOG.info("Starting NEW STYLE ANALYST WORKER FOR TRANSPORTNETWORKS");
<ide> LOG.info("OTP commit is {}", MavenVersion.VERSION.commit);
<ide>
<ide> Properties config = new Properties(); |
|
Java | apache-2.0 | 158b8bb68efb9b885a296b78e0218218dfda92ee | 0 | punkhorn/camel-upstream,zregvart/camel,driseley/camel,apache/camel,salikjan/camel,adessaigne/camel,scranton/camel,prashant2402/camel,gilfernandes/camel,apache/camel,YoshikiHigo/camel,w4tson/camel,hqstevenson/camel,salikjan/camel,lburgazzoli/apache-camel,bgaudaen/camel,acartapanis/camel,NickCis/camel,prashant2402/camel,gnodet/camel,nikhilvibhav/camel,gautric/camel,chirino/camel,tadayosi/camel,acartapanis/camel,scranton/camel,sverkera/camel,onders86/camel,nicolaferraro/camel,dmvolod/camel,jkorab/camel,borcsokj/camel,mcollovati/camel,gautric/camel,lburgazzoli/camel,pax95/camel,prashant2402/camel,Thopap/camel,sverkera/camel,pmoerenhout/camel,sabre1041/camel,anton-k11/camel,gnodet/camel,hqstevenson/camel,akhettar/camel,yuruki/camel,lburgazzoli/camel,davidkarlsen/camel,tkopczynski/camel,cunningt/camel,bhaveshdt/camel,pax95/camel,CodeSmell/camel,oalles/camel,curso007/camel,driseley/camel,borcsokj/camel,allancth/camel,gautric/camel,YoshikiHigo/camel,rmarting/camel,jlpedrosa/camel,acartapanis/camel,NickCis/camel,gautric/camel,lburgazzoli/camel,sirlatrom/camel,oalles/camel,bgaudaen/camel,bhaveshdt/camel,apache/camel,jarst/camel,chirino/camel,sverkera/camel,nboukhed/camel,dmvolod/camel,tlehoux/camel,mgyongyosi/camel,bhaveshdt/camel,mcollovati/camel,bhaveshdt/camel,neoramon/camel,gilfernandes/camel,nicolaferraro/camel,jamesnetherton/camel,allancth/camel,tlehoux/camel,apache/camel,w4tson/camel,w4tson/camel,curso007/camel,nicolaferraro/camel,jlpedrosa/camel,pax95/camel,sabre1041/camel,davidkarlsen/camel,akhettar/camel,adessaigne/camel,DariusX/camel,rmarting/camel,sirlatrom/camel,veithen/camel,mgyongyosi/camel,drsquidop/camel,curso007/camel,Thopap/camel,snurmine/camel,lburgazzoli/camel,jkorab/camel,tkopczynski/camel,tdiesler/camel,hqstevenson/camel,jamesnetherton/camel,snurmine/camel,tadayosi/camel,cunningt/camel,sabre1041/camel,Thopap/camel,ssharma/camel,objectiser/camel,tkopczynski/camel,tadayosi/camel,pkletsko/camel,YoshikiHigo/camel,hqstevenson/camel,JYBESSON/camel,pax95/camel,jkorab/camel,adessaigne/camel,tlehoux/camel,JYBESSON/camel,tlehoux/camel,adessaigne/camel,davidkarlsen/camel,jarst/camel,jlpedrosa/camel,drsquidop/camel,DariusX/camel,curso007/camel,anoordover/camel,nicolaferraro/camel,mgyongyosi/camel,anoordover/camel,sverkera/camel,acartapanis/camel,curso007/camel,RohanHart/camel,onders86/camel,mcollovati/camel,lburgazzoli/apache-camel,tadayosi/camel,Thopap/camel,anoordover/camel,neoramon/camel,Fabryprog/camel,jkorab/camel,mgyongyosi/camel,jarst/camel,Fabryprog/camel,gnodet/camel,onders86/camel,drsquidop/camel,veithen/camel,borcsokj/camel,gnodet/camel,yuruki/camel,veithen/camel,akhettar/camel,allancth/camel,christophd/camel,hqstevenson/camel,tdiesler/camel,NickCis/camel,anoordover/camel,scranton/camel,gnodet/camel,scranton/camel,jamesnetherton/camel,chirino/camel,punkhorn/camel-upstream,yuruki/camel,punkhorn/camel-upstream,driseley/camel,snurmine/camel,drsquidop/camel,chirino/camel,ullgren/camel,alvinkwekel/camel,w4tson/camel,Thopap/camel,dmvolod/camel,christophd/camel,alvinkwekel/camel,pkletsko/camel,tadayosi/camel,borcsokj/camel,JYBESSON/camel,objectiser/camel,hqstevenson/camel,jonmcewen/camel,zregvart/camel,jarst/camel,neoramon/camel,gautric/camel,lburgazzoli/apache-camel,curso007/camel,oalles/camel,snurmine/camel,rmarting/camel,jkorab/camel,nboukhed/camel,jonmcewen/camel,kevinearls/camel,bhaveshdt/camel,CodeSmell/camel,bgaudaen/camel,JYBESSON/camel,tdiesler/camel,gilfernandes/camel,pmoerenhout/camel,christophd/camel,cunningt/camel,isavin/camel,neoramon/camel,sirlatrom/camel,ssharma/camel,jlpedrosa/camel,prashant2402/camel,dmvolod/camel,pkletsko/camel,tadayosi/camel,NickCis/camel,sverkera/camel,oalles/camel,anton-k11/camel,dmvolod/camel,jamesnetherton/camel,christophd/camel,akhettar/camel,mgyongyosi/camel,sabre1041/camel,jonmcewen/camel,rmarting/camel,neoramon/camel,scranton/camel,kevinearls/camel,jlpedrosa/camel,lburgazzoli/camel,jarst/camel,pmoerenhout/camel,bhaveshdt/camel,driseley/camel,gilfernandes/camel,Fabryprog/camel,jarst/camel,ssharma/camel,apache/camel,ullgren/camel,allancth/camel,CodeSmell/camel,CodeSmell/camel,nboukhed/camel,rmarting/camel,pmoerenhout/camel,pkletsko/camel,tkopczynski/camel,isavin/camel,dmvolod/camel,anton-k11/camel,nikhilvibhav/camel,YoshikiHigo/camel,snurmine/camel,pax95/camel,JYBESSON/camel,davidkarlsen/camel,kevinearls/camel,pkletsko/camel,anoordover/camel,rmarting/camel,zregvart/camel,punkhorn/camel-upstream,sirlatrom/camel,acartapanis/camel,jamesnetherton/camel,gilfernandes/camel,christophd/camel,yuruki/camel,veithen/camel,neoramon/camel,jkorab/camel,anton-k11/camel,bgaudaen/camel,bgaudaen/camel,DariusX/camel,isavin/camel,alvinkwekel/camel,driseley/camel,tdiesler/camel,borcsokj/camel,DariusX/camel,yuruki/camel,onders86/camel,ssharma/camel,tlehoux/camel,tkopczynski/camel,tdiesler/camel,lburgazzoli/apache-camel,onders86/camel,kevinearls/camel,chirino/camel,kevinearls/camel,tdiesler/camel,w4tson/camel,RohanHart/camel,YoshikiHigo/camel,anton-k11/camel,objectiser/camel,veithen/camel,lburgazzoli/apache-camel,mgyongyosi/camel,akhettar/camel,christophd/camel,drsquidop/camel,pmoerenhout/camel,RohanHart/camel,jonmcewen/camel,cunningt/camel,RohanHart/camel,jamesnetherton/camel,nboukhed/camel,Thopap/camel,veithen/camel,yuruki/camel,jonmcewen/camel,zregvart/camel,sirlatrom/camel,pax95/camel,drsquidop/camel,prashant2402/camel,pmoerenhout/camel,adessaigne/camel,apache/camel,allancth/camel,ullgren/camel,gilfernandes/camel,isavin/camel,nikhilvibhav/camel,anoordover/camel,borcsokj/camel,snurmine/camel,jonmcewen/camel,objectiser/camel,akhettar/camel,prashant2402/camel,gautric/camel,driseley/camel,Fabryprog/camel,anton-k11/camel,mcollovati/camel,jlpedrosa/camel,tlehoux/camel,isavin/camel,RohanHart/camel,scranton/camel,isavin/camel,lburgazzoli/apache-camel,sabre1041/camel,NickCis/camel,bgaudaen/camel,tkopczynski/camel,onders86/camel,sverkera/camel,NickCis/camel,acartapanis/camel,w4tson/camel,cunningt/camel,pkletsko/camel,ssharma/camel,ullgren/camel,ssharma/camel,sabre1041/camel,JYBESSON/camel,YoshikiHigo/camel,oalles/camel,lburgazzoli/camel,nboukhed/camel,RohanHart/camel,alvinkwekel/camel,nikhilvibhav/camel,cunningt/camel,allancth/camel,sirlatrom/camel,nboukhed/camel,oalles/camel,chirino/camel,kevinearls/camel,adessaigne/camel | /**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.camel.component.file.remote;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFileEntryParser;
import org.apache.commons.net.ftp.parser.CompositeFileEntryParser;
import org.apache.commons.net.ftp.parser.MVSFTPEntryParser;
import org.apache.commons.net.ftp.parser.MacOsPeterFTPEntryParser;
import org.apache.commons.net.ftp.parser.NTFTPEntryParser;
import org.apache.commons.net.ftp.parser.NetwareFTPEntryParser;
import org.apache.commons.net.ftp.parser.OS2FTPEntryParser;
import org.apache.commons.net.ftp.parser.OS400FTPEntryParser;
import org.apache.commons.net.ftp.parser.UnixFTPEntryParser;
import org.apache.commons.net.ftp.parser.VMSVersioningFTPEntryParser;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import static org.hamcrest.core.IsInstanceOf.instanceOf;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;
@RunWith(MockitoJUnitRunner.class)
public class OsgiParserFactoryTest {
private static final OsgiParserFactory OSGI_PARSER_FACTORY = new OsgiParserFactory(null);
@Mock
private FTPClientConfig ftpClientConfig;
@Before
public void setup() {
when(ftpClientConfig.getDefaultDateFormatStr()).thenReturn("yyyy-MM-dd");
}
@Test
public void createFileEntryParserUnix()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla unix bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserLinux()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla linux bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserTypeL8()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla type: l8 bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserVms()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla vms bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(VMSVersioningFTPEntryParser.class));
}
@Test
public void createFileEntryParserPlainWindows()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("WINDOWS");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(NTFTPEntryParser.class));
}
@Test
public void createFileEntryParserNotPlainWindows()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("WINDOWS XP");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(CompositeFileEntryParser.class));
}
@Test
public void createFileEntryParserWin32()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla WIN32 bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(CompositeFileEntryParser.class));
}
@Test
public void createFileEntryParserOs2()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla OS/2 bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(OS2FTPEntryParser.class));
}
@Test
public void createFileEntryParserPlainOs400()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("OS/400");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(OS400FTPEntryParser.class));
}
@Test
public void createFileEntryParserNotPlainOs400()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("OS/400 bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(CompositeFileEntryParser.class));
}
@Test
public void createFileEntryParserMvs()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla MvS bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(MVSFTPEntryParser.class));
}
@Test
public void createFileEntryParserNetware()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla NeTwArE bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(NetwareFTPEntryParser.class));
}
@Test
public void createFileEntryParserMacOsPeter()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla MaCoS PeTER bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(MacOsPeterFTPEntryParser.class));
}
} | components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/OsgiParserFactoryTest.java | /**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.camel.component.file.remote;
import org.apache.commons.net.ftp.FTPClientConfig;
import org.apache.commons.net.ftp.FTPFileEntryParser;
import org.apache.commons.net.ftp.parser.CompositeFileEntryParser;
import org.apache.commons.net.ftp.parser.NTFTPEntryParser;
import org.apache.commons.net.ftp.parser.UnixFTPEntryParser;
import org.apache.commons.net.ftp.parser.VMSVersioningFTPEntryParser;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import static org.hamcrest.core.IsInstanceOf.instanceOf;
import static org.junit.Assert.assertThat;
import static org.mockito.Mockito.when;
@RunWith(MockitoJUnitRunner.class)
public class OsgiParserFactoryTest {
private static final OsgiParserFactory OSGI_PARSER_FACTORY = new OsgiParserFactory(null);
@Mock
private FTPClientConfig ftpClientConfig;
@Before
public void setup() {
when(ftpClientConfig.getDefaultDateFormatStr()).thenReturn("yyyy-MM-dd");
}
@Test
public void createFileEntryParserUnix()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla unix bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserLinux()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla linux bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserTypeL8()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla type: l8 bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(UnixFTPEntryParser.class));
}
@Test
public void createFileEntryParserVms()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("bla vms bla");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(VMSVersioningFTPEntryParser.class));
}
@Test
public void createFileEntryParserPlainWindows()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("WINDOWS");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(NTFTPEntryParser.class));
}
@Test
public void createFileEntryParserNotPlainWindows()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("WINDOWS XP");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(CompositeFileEntryParser.class));
}
@Test
public void createFileEntryParserWin32()
throws Exception {
when(ftpClientConfig.getServerSystemKey()).thenReturn("WIN32");
FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
assertThat(result, instanceOf(CompositeFileEntryParser.class));
}
} | CAMEL-10103: More unittest
| components/camel-ftp/src/test/java/org/apache/camel/component/file/remote/OsgiParserFactoryTest.java | CAMEL-10103: More unittest | <ide><path>omponents/camel-ftp/src/test/java/org/apache/camel/component/file/remote/OsgiParserFactoryTest.java
<ide> import org.apache.commons.net.ftp.FTPClientConfig;
<ide> import org.apache.commons.net.ftp.FTPFileEntryParser;
<ide> import org.apache.commons.net.ftp.parser.CompositeFileEntryParser;
<add>import org.apache.commons.net.ftp.parser.MVSFTPEntryParser;
<add>import org.apache.commons.net.ftp.parser.MacOsPeterFTPEntryParser;
<ide> import org.apache.commons.net.ftp.parser.NTFTPEntryParser;
<add>import org.apache.commons.net.ftp.parser.NetwareFTPEntryParser;
<add>import org.apache.commons.net.ftp.parser.OS2FTPEntryParser;
<add>import org.apache.commons.net.ftp.parser.OS400FTPEntryParser;
<ide> import org.apache.commons.net.ftp.parser.UnixFTPEntryParser;
<ide> import org.apache.commons.net.ftp.parser.VMSVersioningFTPEntryParser;
<ide> import org.junit.Before;
<ide> @Test
<ide> public void createFileEntryParserWin32()
<ide> throws Exception {
<del> when(ftpClientConfig.getServerSystemKey()).thenReturn("WIN32");
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("bla WIN32 bla");
<ide> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<ide> assertThat(result, instanceOf(CompositeFileEntryParser.class));
<ide> }
<ide>
<add> @Test
<add> public void createFileEntryParserOs2()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("bla OS/2 bla");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(OS2FTPEntryParser.class));
<add> }
<add>
<add> @Test
<add> public void createFileEntryParserPlainOs400()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("OS/400");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(OS400FTPEntryParser.class));
<add> }
<add>
<add> @Test
<add> public void createFileEntryParserNotPlainOs400()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("OS/400 bla");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(CompositeFileEntryParser.class));
<add> }
<add>
<add> @Test
<add> public void createFileEntryParserMvs()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("bla MvS bla");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(MVSFTPEntryParser.class));
<add> }
<add>
<add> @Test
<add> public void createFileEntryParserNetware()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("bla NeTwArE bla");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(NetwareFTPEntryParser.class));
<add> }
<add>
<add> @Test
<add> public void createFileEntryParserMacOsPeter()
<add> throws Exception {
<add> when(ftpClientConfig.getServerSystemKey()).thenReturn("bla MaCoS PeTER bla");
<add> FTPFileEntryParser result = OSGI_PARSER_FACTORY.createFileEntryParser(ftpClientConfig);
<add> assertThat(result, instanceOf(MacOsPeterFTPEntryParser.class));
<add> }
<add>
<ide> } |
|
Java | apache-2.0 | cb48277bb3b4a868e8e14d9278a2f100aa971ac4 | 0 | gstevey/gradle,gstevey/gradle,robinverduijn/gradle,gstevey/gradle,lsmaira/gradle,robinverduijn/gradle,lsmaira/gradle,robinverduijn/gradle,gstevey/gradle,blindpirate/gradle,blindpirate/gradle,gradle/gradle,lsmaira/gradle,lsmaira/gradle,lsmaira/gradle,blindpirate/gradle,blindpirate/gradle,gstevey/gradle,blindpirate/gradle,gradle/gradle,lsmaira/gradle,robinverduijn/gradle,robinverduijn/gradle,gradle/gradle,blindpirate/gradle,blindpirate/gradle,lsmaira/gradle,robinverduijn/gradle,gradle/gradle,gstevey/gradle,lsmaira/gradle,robinverduijn/gradle,gradle/gradle,robinverduijn/gradle,lsmaira/gradle,gradle/gradle,lsmaira/gradle,gstevey/gradle,robinverduijn/gradle,gradle/gradle,blindpirate/gradle,gradle/gradle,blindpirate/gradle,gstevey/gradle,robinverduijn/gradle,gradle/gradle,robinverduijn/gradle,gradle/gradle,gstevey/gradle,blindpirate/gradle | /*
* Copyright 2017 the original author or 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 org.gradle.internal.operations.notify;
import org.gradle.api.Action;
import org.gradle.internal.progress.BuildOperationDescriptor;
import org.gradle.internal.progress.BuildOperationListener;
import org.gradle.internal.progress.OperationFinishEvent;
import org.gradle.internal.progress.OperationStartEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class DefaultBuildOperationNotificationListenerRegistrar implements BuildOperationNotificationListenerRegistrar {
private static final Logger LOGGER = LoggerFactory.getLogger(DefaultBuildOperationNotificationListenerRegistrar.class);
private final Action<? super BuildOperationListener> listenerSubscriber;
public DefaultBuildOperationNotificationListenerRegistrar(Action<? super BuildOperationListener> listenerSubscriber) {
this.listenerSubscriber = listenerSubscriber;
}
@Override
public void registerBuildScopeListener(BuildOperationNotificationListener listener) {
listenerSubscriber.execute(new Listener(listener));
}
private static class Listener implements BuildOperationListener {
private final BuildOperationNotificationListener listener;
private Listener(BuildOperationNotificationListener listener) {
this.listener = listener;
}
@Override
public void started(BuildOperationDescriptor buildOperation, OperationStartEvent startEvent) {
// replace this with opt-in to exposing on producer side
// it just so happens right now that this is a reasonable heuristic
if (buildOperation.getDetails() == null) {
return;
}
Started notification = new Started(buildOperation.getId(), buildOperation.getParentId(), buildOperation.getDetails());
try {
listener.started(notification);
} catch (Exception e) {
LOGGER.debug("Build operation notification listener threw an error on " + notification, e);
}
}
@Override
public void finished(BuildOperationDescriptor buildOperation, OperationFinishEvent finishEvent) {
// replace this with opt-in to exposing on producer side
// it just so happens right now that this is a reasonable heuristic
if (finishEvent.getResult() == null) {
return;
}
Finished notification = new Finished(buildOperation.getId(), finishEvent.getResult());
try {
listener.finished(notification);
} catch (Exception e) {
LOGGER.debug("Build operation notification listener threw an error on " + notification, e);
}
}
}
private static class Started implements BuildOperationStartedNotification {
private final Object id;
private final Object parentId;
private final Object details;
private Started(Object id, Object parentId, Object details) {
this.id = id;
this.parentId = parentId;
this.details = details;
}
@Override
public Object getId() {
return id;
}
@Override
public Object getParentId() {
return parentId;
}
@Override
public Object getDetails() {
return details;
}
@Override
public String toString() {
return "BuildOperationStartedNotification{id=" + id + ", parentId=" + parentId + ", details=" + details + '}';
}
}
private static class Finished implements BuildOperationFinishedNotification {
private final Object id;
private final Object result;
private Finished(Object id, Object result) {
this.id = id;
this.result = result;
}
@Override
public Object getId() {
return id;
}
@Override
public Object getResult() {
return result;
}
@Override
public String toString() {
return "BuildOperationFinishedNotification{id=" + id + ", result=" + result + '}';
}
}
}
| subprojects/base-services/src/main/java/org/gradle/internal/operations/notify/DefaultBuildOperationNotificationListenerRegistrar.java | /*
* Copyright 2017 the original author or 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 org.gradle.internal.operations.notify;
import org.gradle.api.Action;
import org.gradle.internal.progress.BuildOperationDescriptor;
import org.gradle.internal.progress.BuildOperationListener;
import org.gradle.internal.progress.OperationFinishEvent;
import org.gradle.internal.progress.OperationStartEvent;
public class DefaultBuildOperationNotificationListenerRegistrar implements BuildOperationNotificationListenerRegistrar {
private final Action<? super BuildOperationListener> listenerSubscriber;
public DefaultBuildOperationNotificationListenerRegistrar(Action<? super BuildOperationListener> listenerSubscriber) {
this.listenerSubscriber = listenerSubscriber;
}
@Override
public void registerBuildScopeListener(BuildOperationNotificationListener listener) {
listenerSubscriber.execute(new Listener(listener));
}
private static class Listener implements BuildOperationListener {
private final BuildOperationNotificationListener listener;
private Listener(BuildOperationNotificationListener listener) {
this.listener = listener;
}
@Override
public void started(BuildOperationDescriptor buildOperation, OperationStartEvent startEvent) {
// replace this with opt-in to exposing on producer side
// it just so happens right now that this is a reasonable heuristic
if (buildOperation.getDetails() == null) {
return;
}
Started notification = new Started(buildOperation.getId(), buildOperation.getParentId(), buildOperation.getDetails());
try {
listener.started(notification);
} catch (Exception ignore) {
// ignore
}
}
@Override
public void finished(BuildOperationDescriptor buildOperation, OperationFinishEvent finishEvent) {
// replace this with opt-in to exposing on producer side
// it just so happens right now that this is a reasonable heuristic
if (finishEvent.getResult() == null) {
return;
}
Finished notification = new Finished(buildOperation.getId(), finishEvent.getResult());
try {
listener.finished(notification);
} catch (Exception ignore) {
// ignore
}
}
}
private static class Started implements BuildOperationStartedNotification {
private final Object id;
private final Object parentId;
private final Object details;
private Started(Object id, Object parentId, Object details) {
this.id = id;
this.parentId = parentId;
this.details = details;
}
@Override
public Object getId() {
return id;
}
@Override
public Object getParentId() {
return parentId;
}
@Override
public Object getDetails() {
return details;
}
}
private static class Finished implements BuildOperationFinishedNotification {
private final Object id;
private final Object result;
private Finished(Object id, Object result) {
this.id = id;
this.result = result;
}
@Override
public Object getId() {
return id;
}
@Override
public Object getResult() {
return result;
}
}
}
| Log notification listener errors.
| subprojects/base-services/src/main/java/org/gradle/internal/operations/notify/DefaultBuildOperationNotificationListenerRegistrar.java | Log notification listener errors. | <ide><path>ubprojects/base-services/src/main/java/org/gradle/internal/operations/notify/DefaultBuildOperationNotificationListenerRegistrar.java
<ide> import org.gradle.internal.progress.BuildOperationListener;
<ide> import org.gradle.internal.progress.OperationFinishEvent;
<ide> import org.gradle.internal.progress.OperationStartEvent;
<add>import org.slf4j.Logger;
<add>import org.slf4j.LoggerFactory;
<ide>
<ide> public class DefaultBuildOperationNotificationListenerRegistrar implements BuildOperationNotificationListenerRegistrar {
<add>
<add> private static final Logger LOGGER = LoggerFactory.getLogger(DefaultBuildOperationNotificationListenerRegistrar.class);
<ide>
<ide> private final Action<? super BuildOperationListener> listenerSubscriber;
<ide>
<ide> Started notification = new Started(buildOperation.getId(), buildOperation.getParentId(), buildOperation.getDetails());
<ide> try {
<ide> listener.started(notification);
<del> } catch (Exception ignore) {
<del> // ignore
<add> } catch (Exception e) {
<add> LOGGER.debug("Build operation notification listener threw an error on " + notification, e);
<ide> }
<ide> }
<ide>
<ide> Finished notification = new Finished(buildOperation.getId(), finishEvent.getResult());
<ide> try {
<ide> listener.finished(notification);
<del> } catch (Exception ignore) {
<del> // ignore
<add> } catch (Exception e) {
<add> LOGGER.debug("Build operation notification listener threw an error on " + notification, e);
<ide> }
<ide> }
<ide> }
<ide> public Object getDetails() {
<ide> return details;
<ide> }
<add>
<add> @Override
<add> public String toString() {
<add> return "BuildOperationStartedNotification{id=" + id + ", parentId=" + parentId + ", details=" + details + '}';
<add> }
<ide> }
<ide>
<ide> private static class Finished implements BuildOperationFinishedNotification {
<ide> public Object getResult() {
<ide> return result;
<ide> }
<add>
<add> @Override
<add> public String toString() {
<add> return "BuildOperationFinishedNotification{id=" + id + ", result=" + result + '}';
<add> }
<ide> }
<ide>
<ide> } |
|
JavaScript | mit | a1ac2a779116993199d824b283b75bce74b7083e | 0 | gabrielmtzcarrillo/SteamIventoryViewer,gabrielmtzcarrillo/SteamIventoryViewer | var steamId = null;
function loadUrl(url,funct)
{
var xmlhttp;
if (window.XMLHttpRequest)
{// code for IE7+, Firefox, Chrome, Opera, Safari
xmlhttp=new XMLHttpRequest();
}
else
{// code for IE6, IE5
xmlhttp=new ActiveXObject("Microsoft.XMLHTTP");
}
xmlhttp.onreadystatechange=function()
{
if (xmlhttp.readyState==4 && xmlhttp.status==200)
{
result = xmlhttp.responseText;
eval(funct+'()');
}
if (xmlhttp.readyState==4 && xmlhttp.status!=200)
{
result = false;
eval(funct+'()');
}
}
xmlhttp.open("GET",url,true);
xmlhttp.send();
}
function loadProfile(steamid){
document.getElementById('profile').innerHTML='<img class="avatar loader" src="img/loader.gif" alt="loading..."/><b>Loading profile</b>';
loadUrl('data/profile/?id='+steamid,'profile_ready');
}
function profile_ready()
{
profile=document.getElementById('profile');
bot = JSON.parse(result);
if(!bot['success'])
{
profile.innerHTML = "Couldn't load profile";
return false;
}
profile.innerHTML = '<img class="avatar" src="'+bot.avatar+'" alt=""/><b>'+bot.name+'</b><br>'+bot.personastate+'<br>'+bot.steam;
}
function loadTF2bp(steamid){
document.getElementById('backpack').innerHTML='<span class="card"><img src="img/loader.gif" alt="loading..."/><br><b>Loading Backpack</b></span>';
loadUrl('data/inventory/tf2/?id='+steamid,'bp_ready');}
function bp_ready(){
card=document.getElementById('backpack');
tf2bp = JSON.parse(result);
if(!tf2bp.success)
{
card.innerHTML = "<b>Couldn't load TF2 backpack</b><br>¿Steam community down?";
return false;
}
var classIcons;
var qualityString;
var tmpStrbuilder = ['<div class="card"><img class="imgInv" src="http://media.steampowered.com/apps/440/icons/',tf2bp.schema[5002].image,'" alt=""/><span class="name"><b>',tf2bp.metal,'</b> Refined</span></div>'];
for(var defindex in tf2bp.stock) {
for(var quality in tf2bp.stock[defindex])
{
qualityString='';
switch(quality)
{
case '1':
qualityString = 'g';
break;
case '3':
qualityString = 'v';
break;
case '6':
qualityString = 'n';
break;
case '11':
qualityString = 's';
break;
case '13':
qualityString = 'h';
break;
case '600':
qualityString = 'd';
break;
default:
qualityString = quality;
}
tmpStrbuilder.push('<div class="card ',qualityString,'"><a href="http://wiki.teamfortress.com/scripts/itemredirect.php?id=',defindex,'"><img class="imgInv" src="http://media.steampowered.com/apps/440/icons/',tf2bp.schema[defindex].image,'" alt="" title="',tf2bp.schema[defindex].name,'" /></a><br><b>',tf2bp.stock[defindex][quality],' x ',tf2bp.schema[defindex].name,'</b></div>');
}
}
card.innerHTML=tmpStrbuilder.join('');
}
function loadInventory(steamid,appid,context){
if(appid!=undefined)
appid = '&appid='+appid;
else
appid = '&appid=753';
if(context!=undefined)
context = '&context='+context;
else
context = '&context=6';
document.getElementById('backpack').innerHTML='<span class="card"><img src="img/loader.gif" alt="" title="loading..."/><br><b>Loading...</b></span>';
loadUrl('data/inventory/?id='+steamid+appid+context,'loadInventory_ready');
}
function loadInventory_ready(){
backpack=document.getElementById('backpack');
bp = JSON.parse(result);
tmpStrBuilder = ['If nothing appears, you inventory is set private or you have no items!<br>'];
for (var id in bp)
{
if(bp[id].type.indexOf('Emoticon')!=-1)
style='class="emoticon"';
else
style='';
tmpStrBuilder.push('<div class="card"><img ',style,' src="http://cdn.steamcommunity.com/economy/image/',bp[id].image,'/96x96" alt=""/><br><span class="name code">',bp[id].stock,' x ',bp[id].name,'</span></div>');
}
backpack.innerHTML = tmpStrBuilder.join('');
} | www/js/core.js | var steamId = null;
function loadUrl(url,funct)
{
var xmlhttp;
if (window.XMLHttpRequest)
{// code for IE7+, Firefox, Chrome, Opera, Safari
xmlhttp=new XMLHttpRequest();
}
else
{// code for IE6, IE5
xmlhttp=new ActiveXObject("Microsoft.XMLHTTP");
}
xmlhttp.onreadystatechange=function()
{
if (xmlhttp.readyState==4 && xmlhttp.status==200)
{
result = xmlhttp.responseText;
eval(funct+'()');
}
if (xmlhttp.readyState==4 && xmlhttp.status!=200)
{
result = false;
eval(funct+'()');
}
}
xmlhttp.open("GET",url,true);
xmlhttp.send();
}
function loadProfile(steamid){
document.getElementById('profile').innerHTML='<img class="avatar loader" src="img/loader.gif" alt="loading..."/><b>Loading profile</b>';
loadUrl('data/profile/?id='+steamid,'profile_ready');
}
function profile_ready()
{
profile=document.getElementById('profile');
bot = JSON.parse(result);
if(!bot['success'])
{
profile.innerHTML = "Couldn't load profile";
return false;
}
profile.innerHTML = '<img class="avatar" src="'+bot.avatar+'" alt=""/><b>'+bot.name+'</b><br>'+bot.personastate+'<br>'+bot.steam;
}
function loadTF2bp(steamid){
document.getElementById('backpack').innerHTML='<span class="card"><img src="img/loader.gif" alt="loading..."/><br><b>Loading Backpack</b></span>';
loadUrl('data/inventory/tf2/?id='+steamid,'bp_ready');}
function bp_ready(){
card=document.getElementById('backpack');
tf2bp = JSON.parse(result);
if(!tf2bp.success)
{
card.innerHTML = "<b>Couldn't load TF2 backpack</b><br>¿Steam community down?";
return false;
}
var classIcons;
var qualityString;
var tmpStrbuilder = ['<div class="card"><img class="imgInv" src="http://media.steampowered.com/apps/440/icons/',tf2bp.schema[5002].image,'" alt=""/><span class="name"><b>',tf2bp.metal,'</b> Refined</span></div>'];
for(var defindex in tf2bp.stock) {
for(var quality in tf2bp.stock[defindex])
{
qualityString='';
switch(quality)
{
case '1':
qualityString = 'g';
break;
case '3':
qualityString = 'v';
break;
case '6':
qualityString = 'n';
break;
case '11':
qualityString = 's';
break;
case '13':
qualityString = 'h';
break;
case '600':
qualityString = 'd';
break;
default:
qualityString = quality;
}
tmpStrbuilder.push('<div class="card ',qualityString,'"><a href="http://wiki.teamfortress.com/scripts/itemredirect.php?id=',defindex,'"><img class="imgInv" src="http://media.steampowered.com/apps/440/icons/',tf2bp.schema[defindex].image,'" alt="" title="',tf2bp.schema[defindex].name,'" /></a><br><b>',tf2bp.stock[defindex][quality],' x ',tf2bp.schema[defindex].name,'</b></div>');
}
}
card.innerHTML=tmpStrbuilder.join('');
}
function loadInventory(steamid,appid,context){
if(appid!=undefined)
appid = '&appid='+appid;
else
appid = '&appid=753';
if(context!=undefined)
context = '&context='+context;
else
context = '&context=6';
document.getElementById('backpack').innerHTML='<span class="card"><img src="img/loader.gif" alt="" title="loading..."/><br><b>Loading...</b></span>';
loadUrl('data/inventory/?id='+steamid+appid+context,'loadInventory_ready');
}
function loadInventory_ready(){
backpack=document.getElementById('backpack');
if(!tf2bp.success)
{
backpack.innerHTML = "<b>Couldn't load inventory</b><br>¿Steam community down or not logged in?";
return false;
}
bp = JSON.parse(result);
tmpStrBuilder = ['If nothing appears, you inventory is set private or you have no items!<br>'];
for (var id in bp)
{
if(bp[id].type.indexOf('Emoticon')!=-1)
style='class="emoticon"';
else
style='';
tmpStrBuilder.push('<div class="card"><img ',style,' src="http://cdn.steamcommunity.com/economy/image/',bp[id].image,'/96x96" alt=""/><br><span class="name code">',bp[id].stock,' x ',bp[id].name,'</span></div>');
}
backpack.innerHTML = tmpStrBuilder.join('');
} | Quickfix
Removed: uneeded tf2 backpack code
| www/js/core.js | Quickfix | <ide><path>ww/js/core.js
<ide>
<ide> function loadInventory_ready(){
<ide> backpack=document.getElementById('backpack');
<del>if(!tf2bp.success)
<del>{
<del> backpack.innerHTML = "<b>Couldn't load inventory</b><br>¿Steam community down or not logged in?";
<del> return false;
<del>}
<ide> bp = JSON.parse(result);
<add>
<ide> tmpStrBuilder = ['If nothing appears, you inventory is set private or you have no items!<br>'];
<ide>
<ide> for (var id in bp) |
|
Java | epl-1.0 | d615b756990543f6b0557127cc1268b1ae09877a | 0 | ccw-ide/ccw,noncom/ccw,laurentpetit/ccw,michelangelo13/ccw,noncom/ccw,laurentpetit/ccw,michelangelo13/ccw,noncom/ccw,ccw-ide/ccw,laurentpetit/ccw,ccw-ide/ccw,michelangelo13/ccw | package ccw.outline;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.ListenerList;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.util.SafeRunnable;
import org.eclipse.jface.viewers.CellLabelProvider;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerCell;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.ViewPart;
import ccw.CCWPlugin;
import ccw.ClojureCore;
import ccw.debug.ClojureClient;
import ccw.util.ClojureDocUtils;
import ccw.util.DisplayUtil;
import clojure.lang.Keyword;
public class NamespaceBrowser extends ViewPart implements ISelectionProvider, ISelectionChangedListener {
/**
* The plugin prefix.
*/
public static final String PREFIX = CCWPlugin.PLUGIN_ID + "."; //$NON-NLS-1$
/**
* Help context id used for the content outline view (value
* <code>"org.eclipse.ui.content_outline_context"</code>).
*/
public static final String CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID = PREFIX + "content_outline_context";//$NON-NLS-1$
private static final String NS_BROWSER_REFRESH_FAMILY = "ccw.outline.job.refresh";
private static final Keyword KEYWORD_NAME = Keyword.intern(null, "name");
private static final Keyword KEYWORD_CHILDREN = Keyword.intern(null, "children");
private static final Keyword KEYWORD_TYPE = Keyword.intern(null, "type");
public static final Keyword KEYWORD_PRIVATE = Keyword.intern(null, "private");
public static final Keyword KEYWORD_NS = Keyword.intern(null, "ns");
private static final Keyword KEYWORD_FILE = Keyword.intern(null, "file");
private static final Keyword KEYWORD_LINE = Keyword.intern(null, "line");
private ListenerList selectionChangedListeners = new ListenerList();
private TreeViewer treeViewer;
private ClojureClient clojureClient;
private Composite control;
private Text filterText;
private String patternString = "";
private Pattern pattern;
private ISelection selectionBeforePatternSearchBegan;
private Object[] expandedElementsBeforeSearchBegan;
/**
* Creates a content outline view with no content outline pages.
*/
public NamespaceBrowser() {
super();
}
public void init(IViewSite site) throws PartInitException {
super.init(site);
site.setSelectionProvider(this);
}
/**
* The <code>PageBookView</code> implementation of this
* <code>IWorkbenchPart</code> method creates a <code>PageBook</code>
* control with its default page showing.
*/
public void createPartControl(Composite theParent) {
control = new Composite(theParent, SWT.NONE);
GridLayout gl = new GridLayout();
gl.numColumns = 2;
control.setLayout(gl);
Label l = new Label(control, SWT.NONE);
l.setText("Find :");
l.setToolTipText("Enter an expression on which the browser will filter, based on name and doc string of vars");
GridData gd = new GridData();
gd.verticalAlignment = SWT.CENTER;
l.setLayoutData(gd);
filterText = new Text(control, SWT.FILL | SWT.BORDER);
filterText.setToolTipText("Enter here a word to search. It can be a regexp. e.g. \"-map$\" (without double quotes) for matching strings ending with -map");
gd = new GridData();
gd.horizontalAlignment = SWT.FILL;
gd.verticalAlignment = SWT.CENTER;
gd.grabExcessHorizontalSpace = true;
filterText.setLayoutData(gd);
filterText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
patternString = ((Text) e.getSource()).getText();
if ("".equals(patternString.trim())) {
if (pattern != null) {
// user stops search, we restore the previous state of
// the tree
pattern = null;
delayedRefresh(false);
treeViewer.setExpandedElements(expandedElementsBeforeSearchBegan);
treeViewer.setSelection(selectionBeforePatternSearchBegan);
selectionBeforePatternSearchBegan = null;
expandedElementsBeforeSearchBegan = null;
}
} else {
pattern = Pattern.compile(patternString.trim());
if (selectionBeforePatternSearchBegan == null) {
// user triggers search, we save the current state of
// the tree
selectionBeforePatternSearchBegan = treeViewer.getSelection();
expandedElementsBeforeSearchBegan = treeViewer.getExpandedElements();
}
delayedRefresh(false);
treeViewer.expandAll();
}
}
});
treeViewer = new TreeViewer(control, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);
treeViewer.addSelectionChangedListener(this);
gd = new GridData();// SWT.FILL, SWT.FILL, true, true, 2, 1);
gd.horizontalSpan = 2;
gd.horizontalAlignment = SWT.FILL;
gd.grabExcessHorizontalSpace = true;
gd.verticalAlignment = SWT.FILL;
gd.grabExcessVerticalSpace = true;
treeViewer.getControl().setLayoutData(gd);
ColumnViewerToolTipSupport.enableFor(treeViewer);
treeViewer.setContentProvider(new ContentProvider());
treeViewer.setLabelProvider(new LabelProvider());
treeViewer.addFilter(new ViewerFilter() {
@Override
public boolean select(Viewer viewer, Object parentElement, Object element) {
if (patternString == null || patternString.trim().equals("")) {
return true;
} else {
return recursiveElemMatches(element);
}
}
/** Tests element node, and its children if necessary, recursively */
private boolean recursiveElemMatches(Object element) {
if (elemMatches(element)) {
return true;
} else {
ITreeContentProvider cp = (ITreeContentProvider) treeViewer.getContentProvider();
if (cp.hasChildren(element)) {
for (Object c: cp.getChildren(element)) {
if (recursiveElemMatches(c)) {
return true;
}
}
return false;
} else {
return false;
}
}
}
/** Test just element node, not its children */
private boolean elemMatches(Object element) {
Map elem = (Map) element;
String name = (String) elem.get(KEYWORD_NAME);
boolean nameMatches = name != null && pattern.matcher(name).find();
String doc = (String) elem.get(ClojureDocUtils.KEYWORD_DOC);
boolean docMatches = doc != null && pattern.matcher(doc).find();
return nameMatches || docMatches;
}
});
treeViewer.addDoubleClickListener(new IDoubleClickListener() {
public void doubleClick(DoubleClickEvent event) {
IStructuredSelection sel = (IStructuredSelection) event.getSelection();
if (sel.size() == 0)
return;
Map node = (Map) sel.getFirstElement();
if (!"var".equals(node.get(KEYWORD_TYPE)))
return;
String searchedNS = ((String) node.get(KEYWORD_NS));
String searchedFileName = (String) node.get(KEYWORD_FILE);
int line = (node.get(KEYWORD_LINE) == null) ? -1 : Integer.valueOf((String) node.get(KEYWORD_LINE));
ClojureCore.openInEditor(searchedNS, searchedFileName, line);
}
});
// PlatformUI.getWorkbench().getHelpSystem().setHelp(getPageBook(),
// CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID);
}
public Object getAdapter(Class key) {
return super.getAdapter(key);
}
private static class ContentProvider implements ITreeContentProvider {
public Object[] getElements(Object inputElement) {
return getChildren(inputElement);
}
public void dispose() {
}
public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
}
public Object[] getChildren(Object parentElement) {
if (Map.class.isInstance(parentElement)) {
Collection children = (Collection) ((Map) parentElement).get(KEYWORD_CHILDREN);
if (children == null) {
return new Object[0];
} else {
return children.toArray();
}
} else {
return new Object[0];
}
}
public Object getParent(Object element) {
return null;
}
public boolean hasChildren(Object parentElement) {
if (Map.class.isInstance(parentElement)) {
return ((Map) parentElement).get(KEYWORD_CHILDREN) != null;
} else {
return false;
}
}
}
private static class LabelProvider extends CellLabelProvider {
public String getToolTipText(Object element) {
return ClojureDocUtils.getVarDocInfo(element);
}
public Point getToolTipShift(Object object) {
return new Point(5, 15);
}
public int getToolTipDisplayDelayTime(Object object) {
return 100;
}
public int getToolTipTimeDisplayed(Object object) {
return 15000;
}
public void update(ViewerCell cell) {
cell.setText(getText(cell.getElement()));
cell.setImage(getImage(cell.getElement()));
}
private String getText(Object element) {
if (Map.class.isInstance(element)) {
return (String) ((Map) element).get(KEYWORD_NAME);
} else {
return element.toString();
}
}
private Image getImage(Object element) {
if (Map.class.isInstance(element)) {
Map node = (Map) element;
if ("ns".equals(node.get(KEYWORD_TYPE))) {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.NS);
} else {
if ("true".equals(node.get(KEYWORD_PRIVATE))) {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.PRIVATE_FUNCTION);
} else {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.PUBLIC_FUNCTION);
}
}
}
return null;
}
}
private Map<String, List<String>> getRemoteNsTree() {
if (clojureClient == null)
return Collections.emptyMap();
Map result = (Map) clojureClient.remoteLoadRead("(ccw.debug.serverrepl/namespaces-info)");
if (result==null) {
System.out.println("no result, connection problem");
return null;
}
if (result.get("response-type").equals(0)) {
return (Map<String, List<String>>) result.get("response");
} else {
// error detected
Map error = (Map) result.get("response");
System.out.println("error :"
+ "line: " + error.get("line-number")
+ "file: " + error.get("file-name")
+ "message:" + error.get("message"));
return null;
}
}
public void resetInput() {
Job job = new Job("Namespace browser tree refresh") {
@Override
protected IStatus run(IProgressMonitor monitor) {
if (treeViewer == null) {
return Status.CANCEL_STATUS;
}
Object oldInput = treeViewer.getInput();
final Object newInput = getRemoteNsTree();
if (oldInput != null && oldInput.equals(newInput)) {
return Status.CANCEL_STATUS;
}
if (Display.getCurrent() == null) {
final Display display = PlatformUI.getWorkbench().getDisplay();
display.asyncExec(new Runnable() {
public void run() {
inUIResetInput(newInput);
}
});
} else {
inUIResetInput(newInput);
}
return Status.OK_STATUS;
}
@Override
public boolean belongsTo(Object family) {
return NS_BROWSER_REFRESH_FAMILY.equals(family);
}
};
job.setSystem(true);
Job.getJobManager().cancel(NS_BROWSER_REFRESH_FAMILY);
job.schedule(200);
}
public void delayedRefresh(final boolean updateLabels) {
Job job = new Job("Namespace browser tree refresh") {
@Override
protected IStatus run(IProgressMonitor monitor) {
if (treeViewer == null) {
return Status.CANCEL_STATUS;
}
if (Display.getCurrent() == null) {
final Display display = PlatformUI.getWorkbench().getDisplay();
display.asyncExec(new Runnable() {
public void run() {
System.out.println("delayed refresh start");
treeViewer.refresh(updateLabels);
System.out.println("delayed refresh stop");
}
});
} else {
treeViewer.refresh(updateLabels);
}
return Status.OK_STATUS;
}
@Override
public boolean belongsTo(Object family) {
return NS_BROWSER_REFRESH_FAMILY.equals(family);
}
};
job.setSystem(true);
Job.getJobManager().cancel(NS_BROWSER_REFRESH_FAMILY);
job.schedule(500);
}
private void inUIResetInput(Object newInput) {
ISelection sel = treeViewer.getSelection();
TreePath[] expandedTreePaths = treeViewer.getExpandedTreePaths();
treeViewer.setInput(newInput);
treeViewer.setExpandedTreePaths(expandedTreePaths);
treeViewer.setSelection(sel);
}
public void addSelectionChangedListener(ISelectionChangedListener listener) {
selectionChangedListeners.add(listener);
}
/**
* Fires a selection changed event.
*
* @param selection
* the new selection
*/
protected void fireSelectionChanged(ISelection selection) {
// create an event
final SelectionChangedEvent event = new SelectionChangedEvent(this, selection);
// fire the event
Object[] listeners = selectionChangedListeners.getListeners();
for (int i = 0; i < listeners.length; ++i) {
final ISelectionChangedListener l = (ISelectionChangedListener) listeners[i];
SafeRunner.run(new SafeRunnable() {
public void run() {
l.selectionChanged(event);
}
});
}
}
public Control getControl() {
if (control == null) {
return null;
}
return control;
}
public ISelection getSelection() {
if (treeViewer == null) {
return StructuredSelection.EMPTY;
}
return treeViewer.getSelection();
}
public void removeSelectionChangedListener(ISelectionChangedListener listener) {
selectionChangedListeners.remove(listener);
}
public void selectionChanged(SelectionChangedEvent event) {
fireSelectionChanged(event.getSelection());
}
/**
* Sets focus to a part in the page.
*/
public void setFocus() {
if (treeViewer != null) {
treeViewer.getControl().setFocus();
}
}
public void setSelection(ISelection selection) {
if (treeViewer != null) {
treeViewer.setSelection(selection);
}
}
/**
* @param clojureClient
*/
public static void setClojureClient(final ClojureClient clojureClient) {
DisplayUtil.asyncExec(new Runnable() {
public void run() {
inUIThreadSetClojureClient(clojureClient);
}});
}
private static void inUIThreadSetClojureClient(ClojureClient clojureClient) {
IViewPart[] views = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getViews();
NamespaceBrowser co = null;
for (IViewPart v: views) {
if (NamespaceBrowser.class.isInstance(v)) {
co = (NamespaceBrowser) v;
break;
}
}
if (co == null) {
return;
}
co.clojureClient = clojureClient;
co.resetInput();
}
}
| ccw.core/src/ccw/outline/NamespaceBrowser.java | package ccw.outline;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.ListenerList;
import org.eclipse.core.runtime.SafeRunner;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jface.util.SafeRunnable;
import org.eclipse.jface.viewers.CellLabelProvider;
import org.eclipse.jface.viewers.ColumnViewerToolTipSupport;
import org.eclipse.jface.viewers.DoubleClickEvent;
import org.eclipse.jface.viewers.IDoubleClickListener;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionChangedListener;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.SelectionChangedEvent;
import org.eclipse.jface.viewers.StructuredSelection;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerCell;
import org.eclipse.jface.viewers.ViewerFilter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.ModifyEvent;
import org.eclipse.swt.events.ModifyListener;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Display;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;
import org.eclipse.ui.IViewPart;
import org.eclipse.ui.IViewSite;
import org.eclipse.ui.PartInitException;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.part.ViewPart;
import ccw.CCWPlugin;
import ccw.ClojureCore;
import ccw.debug.ClojureClient;
import ccw.util.ClojureDocUtils;
import ccw.util.DisplayUtil;
import clojure.lang.Keyword;
public class NamespaceBrowser extends ViewPart implements ISelectionProvider, ISelectionChangedListener {
/**
* The plugin prefix.
*/
public static final String PREFIX = CCWPlugin.PLUGIN_ID + "."; //$NON-NLS-1$
/**
* Help context id used for the content outline view (value
* <code>"org.eclipse.ui.content_outline_context"</code>).
*/
public static final String CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID = PREFIX + "content_outline_context";//$NON-NLS-1$
private static final String NS_BROWSER_REFRESH_FAMILY = "ccw.outline.job.refresh";
private static final Keyword KEYWORD_NAME = Keyword.intern(null, "name");
private static final Keyword KEYWORD_CHILDREN = Keyword.intern(null, "children");
private static final Keyword KEYWORD_TYPE = Keyword.intern(null, "type");
public static final Keyword KEYWORD_PRIVATE = Keyword.intern(null, "private");
public static final Keyword KEYWORD_NS = Keyword.intern(null, "ns");
private static final Keyword KEYWORD_FILE = Keyword.intern(null, "file");
private static final Keyword KEYWORD_LINE = Keyword.intern(null, "line");
private ListenerList selectionChangedListeners = new ListenerList();
private TreeViewer treeViewer;
private ClojureClient clojureClient;
private Composite control;
private Text filterText;
private String patternString = "";
private Pattern pattern;
private ISelection selectionBeforePatternSearchBegan;
private Object[] expandedElementsBeforeSearchBegan;
/**
* Creates a content outline view with no content outline pages.
*/
public NamespaceBrowser() {
super();
}
public void init(IViewSite site) throws PartInitException {
super.init(site);
site.setSelectionProvider(this);
}
/**
* The <code>PageBookView</code> implementation of this
* <code>IWorkbenchPart</code> method creates a <code>PageBook</code>
* control with its default page showing.
*/
public void createPartControl(Composite theParent) {
control = new Composite(theParent, SWT.NONE);
GridLayout gl = new GridLayout();
gl.numColumns = 2;
control.setLayout(gl);
Label l = new Label(control, SWT.NONE);
l.setText("Find :");
l.setToolTipText("Enter an expression on which the browser will filter, based on name and doc string of vars");
GridData gd = new GridData();
gd.verticalAlignment = SWT.CENTER;
l.setLayoutData(gd);
filterText = new Text(control, SWT.FILL | SWT.BORDER);
filterText.setTextLimit(10);
filterText.setToolTipText("Enter here a word to search. It can be a regexp. e.g. \"-map$\" (without double quotes) for matching strings ending with -map");
gd = new GridData();
gd.horizontalAlignment = SWT.FILL;
gd.verticalAlignment = SWT.CENTER;
gd.grabExcessHorizontalSpace = true;
filterText.setLayoutData(gd);
filterText.addModifyListener(new ModifyListener() {
public void modifyText(ModifyEvent e) {
patternString = ((Text) e.getSource()).getText();
if ("".equals(patternString.trim())) {
if (pattern != null) {
// user stops search, we restore the previous state of
// the tree
pattern = null;
delayedRefresh(false);
treeViewer.setExpandedElements(expandedElementsBeforeSearchBegan);
treeViewer.setSelection(selectionBeforePatternSearchBegan);
selectionBeforePatternSearchBegan = null;
expandedElementsBeforeSearchBegan = null;
}
} else {
pattern = Pattern.compile(patternString.trim());
if (selectionBeforePatternSearchBegan == null) {
// user triggers search, we save the current state of
// the tree
selectionBeforePatternSearchBegan = treeViewer.getSelection();
expandedElementsBeforeSearchBegan = treeViewer.getExpandedElements();
}
delayedRefresh(false);
treeViewer.expandAll();
}
}
});
treeViewer = new TreeViewer(control, SWT.MULTI | SWT.H_SCROLL | SWT.V_SCROLL);
treeViewer.addSelectionChangedListener(this);
gd = new GridData();// SWT.FILL, SWT.FILL, true, true, 2, 1);
gd.horizontalSpan = 2;
gd.horizontalAlignment = SWT.FILL;
gd.grabExcessHorizontalSpace = true;
gd.verticalAlignment = SWT.FILL;
gd.grabExcessVerticalSpace = true;
treeViewer.getControl().setLayoutData(gd);
ColumnViewerToolTipSupport.enableFor(treeViewer);
treeViewer.setContentProvider(new ContentProvider());
treeViewer.setLabelProvider(new LabelProvider());
treeViewer.addFilter(new ViewerFilter() {
@Override
public boolean select(Viewer viewer, Object parentElement, Object element) {
if (patternString == null || patternString.trim().equals("")) {
return true;
}
Map parent = (Map) parentElement;
Map elem = (Map) element;
if ("var".equals(elem.get(KEYWORD_TYPE))) {
String name = (String) elem.get(KEYWORD_NAME);
boolean nameMatches = name != null && pattern.matcher(name).find();
String doc = (String) elem.get(ClojureDocUtils.KEYWORD_DOC);
boolean docMatches = doc != null && pattern.matcher(doc).find();
return nameMatches || docMatches;
} else {
return true;
}
}
});
treeViewer.addDoubleClickListener(new IDoubleClickListener() {
public void doubleClick(DoubleClickEvent event) {
IStructuredSelection sel = (IStructuredSelection) event.getSelection();
if (sel.size() == 0)
return;
Map node = (Map) sel.getFirstElement();
if (!"var".equals(node.get(KEYWORD_TYPE)))
return;
String searchedNS = ((String) node.get(KEYWORD_NS));
String searchedFileName = (String) node.get(KEYWORD_FILE);
int line = (node.get(KEYWORD_LINE) == null) ? -1 : Integer.valueOf((String) node.get(KEYWORD_LINE));
ClojureCore.openInEditor(searchedNS, searchedFileName, line);
}
});
// PlatformUI.getWorkbench().getHelpSystem().setHelp(getPageBook(),
// CONTENT_OUTLINE_VIEW_HELP_CONTEXT_ID);
}
public Object getAdapter(Class key) {
return super.getAdapter(key);
}
private static class ContentProvider implements ITreeContentProvider {
public Object[] getElements(Object inputElement) {
return getChildren(inputElement);
}
public void dispose() {
}
public void inputChanged(Viewer viewer, Object oldInput, Object newInput) {
}
public Object[] getChildren(Object parentElement) {
if (Map.class.isInstance(parentElement)) {
Collection children = (Collection) ((Map) parentElement).get(KEYWORD_CHILDREN);
if (children == null) {
return new Object[0];
} else {
return children.toArray();
}
} else {
return new Object[0];
}
}
public Object getParent(Object element) {
return null;
}
public boolean hasChildren(Object parentElement) {
if (Map.class.isInstance(parentElement)) {
return ((Map) parentElement).get(KEYWORD_CHILDREN) != null;
} else {
return false;
}
}
}
private static class LabelProvider extends CellLabelProvider {
public String getToolTipText(Object element) {
return ClojureDocUtils.getVarDocInfo(element);
}
public Point getToolTipShift(Object object) {
return new Point(5, 15);
}
public int getToolTipDisplayDelayTime(Object object) {
return 100;
}
public int getToolTipTimeDisplayed(Object object) {
return 15000;
}
public void update(ViewerCell cell) {
cell.setText(getText(cell.getElement()));
cell.setImage(getImage(cell.getElement()));
}
private String getText(Object element) {
if (Map.class.isInstance(element)) {
return (String) ((Map) element).get(KEYWORD_NAME);
} else {
return element.toString();
}
}
private Image getImage(Object element) {
if (Map.class.isInstance(element)) {
Map node = (Map) element;
if ("ns".equals(node.get(KEYWORD_TYPE))) {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.NS);
} else {
if ("true".equals(node.get(KEYWORD_PRIVATE))) {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.PRIVATE_FUNCTION);
} else {
return CCWPlugin.getDefault().getImageRegistry().get(CCWPlugin.PUBLIC_FUNCTION);
}
}
}
return null;
}
}
private Map<String, List<String>> getRemoteNsTree() {
if (clojureClient == null)
return Collections.emptyMap();
Map result = (Map) clojureClient.remoteLoadRead("(ccw.debug.serverrepl/namespaces-info)");
if (result==null) {
System.out.println("no result, connection problem");
return null;
}
if (result.get("response-type").equals(0)) {
return (Map<String, List<String>>) result.get("response");
} else {
// error detected
Map error = (Map) result.get("response");
System.out.println("error :"
+ "line: " + error.get("line-number")
+ "file: " + error.get("file-name")
+ "message:" + error.get("message"));
return null;
}
}
public void resetInput() {
Job job = new Job("Namespace browser tree refresh") {
@Override
protected IStatus run(IProgressMonitor monitor) {
if (treeViewer == null) {
return Status.CANCEL_STATUS;
}
Object oldInput = treeViewer.getInput();
final Object newInput = getRemoteNsTree();
if (oldInput != null && oldInput.equals(newInput)) {
return Status.CANCEL_STATUS;
}
if (Display.getCurrent() == null) {
final Display display = PlatformUI.getWorkbench().getDisplay();
display.asyncExec(new Runnable() {
public void run() {
inUIResetInput(newInput);
}
});
} else {
inUIResetInput(newInput);
}
return Status.OK_STATUS;
}
@Override
public boolean belongsTo(Object family) {
return NS_BROWSER_REFRESH_FAMILY.equals(family);
}
};
job.setSystem(true);
Job.getJobManager().cancel(NS_BROWSER_REFRESH_FAMILY);
job.schedule(200);
}
public void delayedRefresh(final boolean updateLabels) {
Job job = new Job("Namespace browser tree refresh") {
@Override
protected IStatus run(IProgressMonitor monitor) {
if (treeViewer == null) {
return Status.CANCEL_STATUS;
}
if (Display.getCurrent() == null) {
final Display display = PlatformUI.getWorkbench().getDisplay();
display.asyncExec(new Runnable() {
public void run() {
System.out.println("delayed refresh start");
treeViewer.refresh(updateLabels);
System.out.println("delayed refresh stop");
}
});
} else {
treeViewer.refresh(updateLabels);
}
return Status.OK_STATUS;
}
@Override
public boolean belongsTo(Object family) {
return NS_BROWSER_REFRESH_FAMILY.equals(family);
}
};
job.setSystem(true);
Job.getJobManager().cancel(NS_BROWSER_REFRESH_FAMILY);
job.schedule(500);
}
private void inUIResetInput(Object newInput) {
ISelection sel = treeViewer.getSelection();
TreePath[] expandedTreePaths = treeViewer.getExpandedTreePaths();
treeViewer.setInput(newInput);
treeViewer.setExpandedTreePaths(expandedTreePaths);
treeViewer.setSelection(sel);
}
public void addSelectionChangedListener(ISelectionChangedListener listener) {
selectionChangedListeners.add(listener);
}
/**
* Fires a selection changed event.
*
* @param selection
* the new selection
*/
protected void fireSelectionChanged(ISelection selection) {
// create an event
final SelectionChangedEvent event = new SelectionChangedEvent(this, selection);
// fire the event
Object[] listeners = selectionChangedListeners.getListeners();
for (int i = 0; i < listeners.length; ++i) {
final ISelectionChangedListener l = (ISelectionChangedListener) listeners[i];
SafeRunner.run(new SafeRunnable() {
public void run() {
l.selectionChanged(event);
}
});
}
}
public Control getControl() {
if (control == null) {
return null;
}
return control;
}
public ISelection getSelection() {
if (treeViewer == null) {
return StructuredSelection.EMPTY;
}
return treeViewer.getSelection();
}
public void removeSelectionChangedListener(ISelectionChangedListener listener) {
selectionChangedListeners.remove(listener);
}
public void selectionChanged(SelectionChangedEvent event) {
fireSelectionChanged(event.getSelection());
}
/**
* Sets focus to a part in the page.
*/
public void setFocus() {
if (treeViewer != null) {
treeViewer.getControl().setFocus();
}
}
public void setSelection(ISelection selection) {
if (treeViewer != null) {
treeViewer.setSelection(selection);
}
}
/**
* @param clojureClient
*/
public static void setClojureClient(final ClojureClient clojureClient) {
DisplayUtil.asyncExec(new Runnable() {
public void run() {
inUIThreadSetClojureClient(clojureClient);
}});
}
private static void inUIThreadSetClojureClient(ClojureClient clojureClient) {
IViewPart[] views = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getViews();
NamespaceBrowser co = null;
for (IViewPart v: views) {
if (NamespaceBrowser.class.isInstance(v)) {
co = (NamespaceBrowser) v;
break;
}
}
if (co == null) {
return;
}
co.clojureClient = clojureClient;
co.resetInput();
}
}
| Namespace browser now also filters on namespace documentation and names. And empty namespaces are totally removed from the filtered tree
| ccw.core/src/ccw/outline/NamespaceBrowser.java | Namespace browser now also filters on namespace documentation and names. And empty namespaces are totally removed from the filtered tree | <ide><path>cw.core/src/ccw/outline/NamespaceBrowser.java
<ide> l.setLayoutData(gd);
<ide>
<ide> filterText = new Text(control, SWT.FILL | SWT.BORDER);
<del> filterText.setTextLimit(10);
<ide> filterText.setToolTipText("Enter here a word to search. It can be a regexp. e.g. \"-map$\" (without double quotes) for matching strings ending with -map");
<ide> gd = new GridData();
<ide> gd.horizontalAlignment = SWT.FILL;
<ide> public boolean select(Viewer viewer, Object parentElement, Object element) {
<ide> if (patternString == null || patternString.trim().equals("")) {
<ide> return true;
<del> }
<del> Map parent = (Map) parentElement;
<add> } else {
<add> return recursiveElemMatches(element);
<add> }
<add> }
<add>
<add> /** Tests element node, and its children if necessary, recursively */
<add> private boolean recursiveElemMatches(Object element) {
<add> if (elemMatches(element)) {
<add> return true;
<add> } else {
<add> ITreeContentProvider cp = (ITreeContentProvider) treeViewer.getContentProvider();
<add> if (cp.hasChildren(element)) {
<add> for (Object c: cp.getChildren(element)) {
<add> if (recursiveElemMatches(c)) {
<add> return true;
<add> }
<add> }
<add> return false;
<add> } else {
<add> return false;
<add> }
<add> }
<add> }
<add>
<add> /** Test just element node, not its children */
<add> private boolean elemMatches(Object element) {
<ide> Map elem = (Map) element;
<del> if ("var".equals(elem.get(KEYWORD_TYPE))) {
<del> String name = (String) elem.get(KEYWORD_NAME);
<del> boolean nameMatches = name != null && pattern.matcher(name).find();
<del>
<del> String doc = (String) elem.get(ClojureDocUtils.KEYWORD_DOC);
<del> boolean docMatches = doc != null && pattern.matcher(doc).find();
<del>
<del> return nameMatches || docMatches;
<del> } else {
<del> return true;
<del> }
<add> String name = (String) elem.get(KEYWORD_NAME);
<add> boolean nameMatches = name != null && pattern.matcher(name).find();
<add>
<add> String doc = (String) elem.get(ClojureDocUtils.KEYWORD_DOC);
<add> boolean docMatches = doc != null && pattern.matcher(doc).find();
<add>
<add> return nameMatches || docMatches;
<ide> }
<ide> });
<ide> |
|
Java | mit | 111b5a213a52810434137c610440b263df800805 | 0 | teoreteetik/api-snippets,teoreteetik/api-snippets,teoreteetik/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,teoreteetik/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,teoreteetik/api-snippets,teoreteetik/api-snippets,teoreteetik/api-snippets,teoreteetik/api-snippets,teoreteetik/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets,TwilioDevEd/api-snippets | // Install the Java helper library from twilio.com/docs/java/install
import java.io.IOException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.twilio.twiml.Enqueue;
import com.twilio.twiml.TwiMLException;
import com.twilio.twiml.VoiceResponse;
public class Example extends HttpServlet {
public void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
Enqueue enqueue = new Enqueue.Builder().queueName("Queue Demo").build();
VoiceResponse twiml = new VoiceResponse.Builder().enqueue(enqueue).build();
response.setContentType("application/xml");
try {
response.getWriter().print(twiml.toXml());
} catch (TwiMLException e) {
e.printStackTrace();
}
}
}
| voice/queueing/caller/queue-caller.7.x.java | // Install the Java helper library from twilio.com/docs/java/install
import java.io.IOException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import com.twilio.twiml.Dial;
import com.twilio.twiml.Queue;
import com.twilio.twiml.TwiMLException;
import com.twilio.twiml.VoiceResponse;
public class Example extends HttpServlet {
public void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
Queue queue = new Queue.Builder("Queue Demo").build();
Dial dial = new Dial.Builder().queue(queue).build();
VoiceResponse twiml = new VoiceResponse.Builder().dial(dial).build();
response.setContentType("application/xml");
try {
response.getWriter().print(twiml.toXml());
} catch (TwiMLException e) {
e.printStackTrace();
}
}
}
| Fix Enqueue example Java 7
| voice/queueing/caller/queue-caller.7.x.java | Fix Enqueue example Java 7 | <ide><path>oice/queueing/caller/queue-caller.7.x.java
<ide> import javax.servlet.http.HttpServletRequest;
<ide> import javax.servlet.http.HttpServletResponse;
<ide>
<del>import com.twilio.twiml.Dial;
<del>import com.twilio.twiml.Queue;
<add>import com.twilio.twiml.Enqueue;
<ide> import com.twilio.twiml.TwiMLException;
<ide> import com.twilio.twiml.VoiceResponse;
<ide>
<ide> public class Example extends HttpServlet {
<ide> public void service(HttpServletRequest request, HttpServletResponse response) throws IOException {
<del> Queue queue = new Queue.Builder("Queue Demo").build();
<del> Dial dial = new Dial.Builder().queue(queue).build();
<del>
<del> VoiceResponse twiml = new VoiceResponse.Builder().dial(dial).build();
<add> Enqueue enqueue = new Enqueue.Builder().queueName("Queue Demo").build();
<add> VoiceResponse twiml = new VoiceResponse.Builder().enqueue(enqueue).build();
<ide>
<ide> response.setContentType("application/xml");
<ide> |
|
Java | mit | 09bc2db6f7d96f05fe421d631185a75d28b84b69 | 0 | TAV2017GERM/assignment |
import implementation.PhaseOneImpl;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import static org.hamcrest.CoreMatchers.instanceOf;
/**
* implementation.PhaseOneImpl Tester.
*
* @author GeoffreyC
* @version 1.0
* @since <pre>Jan 30, 2017</pre>
*/
public class PhaseOneImplTest {
PhaseOneImpl phaseOne;
@Before
public void before() throws Exception {
phaseOne = new PhaseOneImpl();
}
@After
public void after() throws Exception {
}
/**
* Method: MoveForward()
*/
@Test
public void testMoveForwardOnce() throws Exception {
int i = phaseOne.whereIs();
phaseOne.moveForward();
Assert.assertEquals(i + 1, phaseOne.whereIs());
}
/**
* Method MoveForward()
* Move 500 times,
*
* @throws Exception
*/
@Test
public void testMoveForwardOOB() throws Exception {
int i = phaseOne.whereIs();
for (int j = 0; j < 501; j++) {
phaseOne.moveForward();
}
Assert.assertEquals(500, phaseOne.whereIs());
}
@Test
public void testMoveForwardParkStatus() throws Exception {
phaseOne.moveForward();
int i[] = phaseOne.moveForward();
Assert.assertEquals(0, i[1]);
}
/**
* Method: MoveBackward()
*/
@Test
public void testMoveBackwardOnce() throws Exception {
phaseOne.moveBackward();
Assert.assertEquals(0, phaseOne.whereIs());
}
@Test
public void testMoveBackwardOOB() throws Exception {
int i = phaseOne.whereIs();
phaseOne.moveBackward();
Assert.assertEquals(0, phaseOne.whereIs());
}
/**
* Method: Park()
*/
@Test
public void testPark() throws Exception {
//TODO: Test goes here...
}
/**
* Method: unPark()
*/
@Test
public void testUnPark() throws Exception {
//TODO: Test goes here...
}
/**
* Method: Wherels()
*/
@Test
public void testWhereIs() throws Exception {
Assert.assertEquals(0, phaseOne.whereIs());
Assert.assertThat(phaseOne.whereIs(),instanceOf(Integer.class));
}
/**
* Method: isEmpty()
*/
@Test
public void testIsEmpty() throws Exception {
Assert.assertThat(phaseOne.isEmpty(),instanceOf(Integer.class));
}
}
| src/test/PhaseOneImplTest.java |
import implementation.PhaseOneImpl;
import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import static org.hamcrest.CoreMatchers.instanceOf;
/**
* implementation.PhaseOneImpl Tester.
*
* @author GeoffreyC
* @version 1.0
* @since <pre>Jan 30, 2017</pre>
*/
public class PhaseOneImplTest {
PhaseOneImpl phaseOne;
@Before
public void before() throws Exception {
phaseOne = new PhaseOneImpl();
}
@After
public void after() throws Exception {
}
/**
* Method: MoveForward()
*/
@Test
public void testMoveForwardOnce() throws Exception {
int i = phaseOne.whereIs();
phaseOne.moveForward();
Assert.assertEquals(i + 1, phaseOne.whereIs());
}
/**
* Method MoveForward()
* Move 500 times,
*
* @throws Exception
*/
@Test
public void testMoveForwardOOB() throws Exception {
int i = phaseOne.whereIs();
for (int j = 0; j < 501; j++) {
phaseOne.moveForward();
}
Assert.assertEquals(500, phaseOne.whereIs());
}
/**
* Method: MoveBackward()
*/
@Test
public void testMoveBackwardOnce() throws Exception {
phaseOne.moveBackward();
Assert.assertEquals(0, phaseOne.whereIs());
}
@Test
public void testMoveBackwardOOB() throws Exception {
int i = phaseOne.whereIs();
phaseOne.moveBackward();
Assert.assertEquals(0, phaseOne.whereIs());
}
/**
* Method: Park()
*/
@Test
public void testPark() throws Exception {
//TODO: Test goes here...
}
/**
* Method: unPark()
*/
@Test
public void testUnPark() throws Exception {
//TODO: Test goes here...
}
/**
* Method: Wherels()
*/
@Test
public void testWhereIs() throws Exception {
Assert.assertEquals(0, phaseOne.whereIs());
}
/**
* Method: isEmpty()
*/
@Test
public void testIsEmpty() throws Exception {
Assert.assertThat(phaseOne.isEmpty(),instanceOf(Integer.class));
}
}
| testMoveForwardParkStatus text step1
| src/test/PhaseOneImplTest.java | testMoveForwardParkStatus text step1 | <ide><path>rc/test/PhaseOneImplTest.java
<ide> Assert.assertEquals(500, phaseOne.whereIs());
<ide> }
<ide>
<add> @Test
<add> public void testMoveForwardParkStatus() throws Exception {
<add> phaseOne.moveForward();
<add> int i[] = phaseOne.moveForward();
<add> Assert.assertEquals(0, i[1]);
<add> }
<add>
<ide> /**
<ide> * Method: MoveBackward()
<ide> */
<ide> @Test
<ide> public void testWhereIs() throws Exception {
<ide> Assert.assertEquals(0, phaseOne.whereIs());
<add> Assert.assertThat(phaseOne.whereIs(),instanceOf(Integer.class));
<ide> }
<ide>
<ide> /**
<ide>
<ide> Assert.assertThat(phaseOne.isEmpty(),instanceOf(Integer.class));
<ide>
<del>
<ide> }
<ide>
<ide> } |
|
Java | mit | 5f1499e8b688fc32845eda958971a9c825ff7901 | 0 | skuzzle/TinyPlugz | package de.skuzzle.tinyplugz;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.function.Consumer;
import org.eclipse.jdt.annotation.NonNull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import de.skuzzle.tinyplugz.internal.PluginSourceBuilderImpl;
import de.skuzzle.tinyplugz.internal.ServiceLoaderWrapper;
import de.skuzzle.tinyplugz.internal.TinyPlugzLookUp;
import de.skuzzle.tinyplugz.util.ReflectionUtil;
import de.skuzzle.tinyplugz.util.Require;
/**
* Provides a fluent builder API for configuring an application wide single
* {@link TinyPlugz} instance.
*
* @author Simon Taddiken
*/
public final class TinyPlugzConfigurator {
/** Default resource name of tiny plugz class path configuration */
@NonNull
public static final String TINY_PLUGZ_CONFIG = "tiny-plugz.properties";
private static final Logger LOG = LoggerFactory.getLogger(TinyPlugz.class);
/** Lock which synchronizes every non-trivial access to TinyPlugz.instance. */
protected static final Object DEPLOY_LOCK = new Object();
private TinyPlugzConfigurator() {
// hidden constructor
}
/**
* Sets up a {@link TinyPlugz} instance which uses the current thread's
* context Classloader as parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
*
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setup() {
final ClassLoader cl = Require.nonNull(
Thread.currentThread().getContextClassLoader());
return new Impl(cl);
}
/**
* Sets up a {@link TinyPlugz} instance which uses the given Classloader as
* parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
*
* @param parentClassLoader The parent Classloader to use.
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setupUsingParent(ClassLoader parentClassLoader) {
return new Impl(Require.nonNull(parentClassLoader, "parentClassLoader"));
}
/**
* Sets up a {@link TinyPlugz} instance which uses the Classloader which
* loaded the {@link TinyPlugzConfigurator} class as parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
*
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setupUsingApplicationClassLoader() {
final ClassLoader cl = Require.nonNull(
TinyPlugzConfigurator.class.getClassLoader());
return new Impl(cl);
}
/**
* Part of the fluent configurator API. Used to define configuration
* properties and the plugins to be used.
*
* @author Simon Taddiken
*/
public static interface DefineProperties extends DeployTinyPlugz {
/**
* Adds properties read from {@value #TINY_PLUGZ_CONFIG} file from the
* class path.
*
* @return A fluent builder object for further configuration.
* @throws IllegalStateException If the file can not be found.
*/
DefineProperties withClasspathProperties();
/**
* Adds properties read from the class path using the given resource
* name.
*
* @param resourceName Name of the properties file resource.
* @return A fluent builder object for further configuration.
* @throws IllegalStateException If the file can not be found.
*/
DefineProperties withClasspathProperties(String resourceName);
/**
* Specifies a single property to insert into the map which will be
* passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)} .
*
* @param name Name of the property.
* @param value Value of the property.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperty(String name, Object value);
/**
* Specifies a property without value. It will automatically get
* assigned a non-null value.
*
* @param name Name of the property.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperty(String name);
/**
* Makes all {@link System#getProperties() system properties} available
* in the map passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)}.
*
* @return A fluent builder object for further configuration.
* @since 0.2.0
*/
DefineProperties withSystemProperties();
/**
* Specifies a multiple properties to insert into the map which will be
* passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)} .
*
* @param values Mappings to add.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperties(Map<? extends Object, ? extends Object> values);
/**
* Provides the {@link PluginSourceBuilder} via the given consumer for
* adding plugins which should be deployed.
*
* @param source Consumer for modifying a PluginSourcce.
* @return A fluent builder object for further configuration.
*/
DeployTinyPlugz withPlugins(Consumer<PluginSourceBuilder> source);
/**
* Uses the given plugin source.
*
* @param source The plugins.
* @return A fluent builder object for further configuration.
* @since 0.2.0
*/
DeployTinyPlugz withPlugins(PluginSource source);
/**
* {@inheritDoc}
* <p>
* When calling this method, only plugins from the folder specified
* using the option {@link Options#PLUGIN_FOLDER} will be loaded. If
* this option is not specified, TinyPlugz will be deployed without any
* plugins.
*
* @since 0.2.0
*/
@Override
TinyPlugz deploy();
}
/**
* Part of the fluent configurator API. Represents the final step and allows
* to actually deploy the configured TinyPlugz instance.
*
* @author Simon Taddiken
*/
public interface DeployTinyPlugz {
/**
* Creates a new TinyPlugz instance using the configured values. The
* instance will <b>not</b> be deployed as the unique global instance
* and can be used independently.
*
* @return The configured instance.
* @throws TinyPlugzException When initializing TinyPlugz with the
* current configuration fails.
* @since 0.3.0
*/
TinyPlugz createInstance();
/**
* Finally deploys the {@link TinyPlugz} instance using the configured
* values. The configured instance will be globally accessible using
* {@link TinyPlugz#getInstance()}.
*
* @return The configured instance.
* @throws TinyPlugzException When initializing TinyPlugz with the
* current configuration fails.
*/
TinyPlugz deploy();
}
private static final class Impl implements DefineProperties, DeployTinyPlugz {
@NonNull
private static final Object NON_NULL_VALUE = new Object();
@NonNull
private final Map<Object, Object> properties;
@NonNull
private final ClassLoader parentCl;
private PluginSource source;
private Impl(@NonNull ClassLoader parentCl) {
this.parentCl = parentCl;
this.properties = new HashMap<>();
}
@Override
public DefineProperties withClasspathProperties() {
return withClasspathProperties(TINY_PLUGZ_CONFIG);
}
@Override
public DefineProperties withClasspathProperties(String resourceName) {
Require.nonNull(resourceName, "resourceName");
final URL url = Require.nonNullResult(this.parentCl.getResource(resourceName),
"ClassLoader.getResource");
final Properties props = new Properties();
try (final InputStream in = url.openStream()) {
props.load(in);
} catch (final IOException e) {
throw new IllegalStateException(
String.format("Resource <%s> could not be read", resourceName),
e);
}
this.properties.putAll(props);
return this;
}
@Override
public DefineProperties withProperty(String name, Object value) {
Require.nonNull(name, "name");
this.properties.put(name, value);
return this;
}
@Override
public DefineProperties withProperty(String name) {
return withProperty(name, NON_NULL_VALUE);
}
@Override
public DefineProperties withSystemProperties() {
return withProperties(Require.nonNull(System.getProperties()));
}
@Override
public DefineProperties withProperties(
Map<? extends Object, ? extends Object> values) {
Require.nonNull(values, "values");
this.properties.putAll(values);
return this;
}
@Override
public DeployTinyPlugz withPlugins(Consumer<PluginSourceBuilder> source) {
Require.nonNull(source, "source");
final PluginSourceBuilder builder = PluginSource.builder();
source.accept(builder);
this.source = builder.createSource();
return this;
}
@Override
public DeployTinyPlugz withPlugins(PluginSource source) {
Require.nonNull(source, "source");
this.source = source;
return this;
}
@Override
public TinyPlugz createInstance() {
validateProperties();
final TinyPlugz impl = getInstance();
LOG.debug("Using '{}' TinyPlugz implementation",
impl.getClass().getName());
final PluginSource pluginSource = buildSource();
logProperties();
impl.initialize(pluginSource, this.parentCl,
Collections.unmodifiableMap(this.properties));
return impl;
}
@Override
public TinyPlugz deploy() {
validateProperties();
synchronized (DEPLOY_LOCK) {
// additional synchronized check is required here
Require.state(!TinyPlugz.isDeployed(), "TinyPlugz already deployed");
final TinyPlugz impl = createInstance();
TinyPlugz.deploy(impl);
notifyListeners(impl);
return impl;
}
}
private PluginSource buildSource() {
final PluginSourceBuilder builder = new PluginSourceBuilderImpl();
if (this.properties.get(Options.PLUGIN_FOLDER) != null) {
final String p = this.properties.get(Options.PLUGIN_FOLDER).toString();
final Path path = Paths.get(p);
if (this.source == null) {
builder.addAllPluginJars(path);
} else {
builder.include(this.source).addAllPluginJars(path);
}
} else if (this.source == null) {
// plugins given neither by PlginSourceBuilder nor by property
LOG.warn("TinyPlugz has been configured without specifying any plugin " +
"sources");
} else {
builder.include(this.source);
}
return builder.createSource();
}
private void notifyListeners(TinyPlugz tinyPlugz) {
final Iterator<DeployListener> listeners = tinyPlugz.findDeployListeners(
tinyPlugz.getClassLoader());
Require.nonNullResult(listeners, "TinyPlugz.findDeployListeners");
while (listeners.hasNext()) {
final DeployListener next = Require.nonNullResult(listeners.next(),
"Iterator.next");
try {
next.initialized(tinyPlugz, this.properties);
} catch (final RuntimeException e) {
LOG.error("DeployListener '{}' threw exception", next, e);
}
}
}
private TinyPlugz getInstance() {
final TinyPlugzLookUp lookup;
if (this.properties.get(Options.FORCE_DEFAULT) != null) {
lookup = TinyPlugzLookUp.DEFAULT_INSTANCE_STRATEGY;
} else if (this.properties.get(Options.FORCE_IMPLEMENTATION) != null) {
lookup = TinyPlugzLookUp.STATIC_STRATEGY;
} else {
lookup = TinyPlugzLookUp.SPI_STRATEGY;
}
final ServiceLoaderWrapper serviceLoader;
if (this.properties.get(Options.SERVICE_LOADER_WRAPPER) != null) {
serviceLoader = ReflectionUtil.createInstance(
this.properties.get(Options.SERVICE_LOADER_WRAPPER),
ServiceLoaderWrapper.class,
this.parentCl);
} else {
serviceLoader = ServiceLoaderWrapper.getDefault();
}
LOG.debug("Using '{}' for instantiating TinyPlugz",
lookup.getClass().getName());
return lookup.getInstance(this.parentCl, serviceLoader, this.properties);
}
private void validateProperties() {
final Object forceDefault = this.properties.get(Options.FORCE_DEFAULT);
final Object forceImplementation = this.properties.get(
Options.FORCE_IMPLEMENTATION);
if (forceDefault != null && forceImplementation != null) {
throw new TinyPlugzException("Can not use 'FORCE_IMPLEMENTATION' " +
"together with 'FORCE_DEFAULT'");
}
}
private void logProperties() {
if (!LOG.isDebugEnabled() || this.properties.isEmpty()) {
return;
}
final StringBuilder b = new StringBuilder();
b.append("TinyPlugz configuration options:\n");
this.properties.forEach((k, v) -> {
b.append("\t").append(k);
if (!NON_NULL_VALUE.equals(v)) {
b.append(":\t").append(v);
}
b.append("\n");
});
LOG.debug(b.toString());
}
}
}
| tiny-plugz/src/main/java/de/skuzzle/tinyplugz/TinyPlugzConfigurator.java | package de.skuzzle.tinyplugz;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.ServiceLoader;
import java.util.function.Consumer;
import org.eclipse.jdt.annotation.NonNull;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import de.skuzzle.tinyplugz.internal.PluginSourceBuilderImpl;
import de.skuzzle.tinyplugz.internal.ServiceLoaderWrapper;
import de.skuzzle.tinyplugz.internal.TinyPlugzLookUp;
import de.skuzzle.tinyplugz.util.ReflectionUtil;
import de.skuzzle.tinyplugz.util.Require;
/**
* Provides a fluent builder API for configuring an application wide single
* {@link TinyPlugz} instance.
*
* @author Simon Taddiken
*/
public final class TinyPlugzConfigurator {
/** Default resource name of tiny plugz class path configuration */
@NonNull
public static final String TINY_PLUGZ_CONFIG = "tiny-plugz.properties";
private static final Logger LOG = LoggerFactory.getLogger(TinyPlugz.class);
/** Lock which synchronizes every non-trivial access to TinyPlugz.instance. */
protected static final Object DEPLOY_LOCK = new Object();
private TinyPlugzConfigurator() {
// hidden constructor
}
/**
* Sets up a {@link TinyPlugz} instance which uses the current thread's
* context Classloader as parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
* <p>
* This method will fail immediately if TinyPlugz already has been
* configured.
*
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setup() {
final ClassLoader cl = Require.nonNull(
Thread.currentThread().getContextClassLoader());
return new Impl(cl);
}
/**
* Sets up a {@link TinyPlugz} instance which uses the given Classloader as
* parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
* <p>
* This method will fail immediately if TinyPlugz already has been
* configured.
*
* @param parentClassLoader The parent Classloader to use.
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setupUsingParent(ClassLoader parentClassLoader) {
return new Impl(Require.nonNull(parentClassLoader, "parentClassLoader"));
}
/**
* Sets up a {@link TinyPlugz} instance which uses the Classloader which
* loaded the {@link TinyPlugzConfigurator} class as parent Classloader.
* <p>
* This Classloader will be used for several purposes. First, it serves as
* parent Classloader for the plugin Classloader which is to be created to
* access classes and configurations from plugins. Second, the Classloader
* will be used to look up the TinyPlugz service provider either using the
* {@link ServiceLoader} or by looking up an explicit implementation class.
* <p>
* This method will fail immediately if TinyPlugz already has been
* configured.
*
* @return Fluent builder object for further configuration.
*/
public static DefineProperties setupUsingApplicationClassLoader() {
final ClassLoader cl = Require.nonNull(
TinyPlugzConfigurator.class.getClassLoader());
return new Impl(cl);
}
/**
* Part of the fluent configurator API. Used to define configuration
* properties and the plugins to be used.
*
* @author Simon Taddiken
*/
public static interface DefineProperties extends DeployTinyPlugz {
/**
* Adds properties read from {@value #TINY_PLUGZ_CONFIG} file from the
* class path.
*
* @return A fluent builder object for further configuration.
* @throws IllegalStateException If the file can not be found.
*/
DefineProperties withClasspathProperties();
/**
* Adds properties read from the class path using the given resource
* name.
*
* @param resourceName Name of the properties file resource.
* @return A fluent builder object for further configuration.
* @throws IllegalStateException If the file can not be found.
*/
DefineProperties withClasspathProperties(String resourceName);
/**
* Specifies a single property to insert into the map which will be
* passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)} .
*
* @param name Name of the property.
* @param value Value of the property.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperty(String name, Object value);
/**
* Specifies a property without value. It will automatically get
* assigned a non-null value.
*
* @param name Name of the property.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperty(String name);
/**
* Makes all {@link System#getProperties() system properties} available
* in the map passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)}.
*
* @return A fluent builder object for further configuration.
* @since 0.2.0
*/
DefineProperties withSystemProperties();
/**
* Specifies a multiple properties to insert into the map which will be
* passed to
* {@link TinyPlugz#initialize(PluginSource, ClassLoader, Map)} .
*
* @param values Mappings to add.
* @return A fluent builder object for further configuration.
*/
DefineProperties withProperties(Map<? extends Object, ? extends Object> values);
/**
* Provides the {@link PluginSourceBuilder} via the given consumer for
* adding plugins which should be deployed.
*
* @param source Consumer for modifying a PluginSourcce.
* @return A fluent builder object for further configuration.
*/
DeployTinyPlugz withPlugins(Consumer<PluginSourceBuilder> source);
/**
* Uses the given plugin source.
*
* @param source The plugins.
* @return A fluent builder object for further configuration.
* @since 0.2.0
*/
DeployTinyPlugz withPlugins(PluginSource source);
/**
* {@inheritDoc}
* <p>
* When calling this method, only plugins from the folder specified
* using the option {@link Options#PLUGIN_FOLDER} will be loaded. If
* this option is not specified, TinyPlugz will be deployed without any
* plugins.
*
* @since 0.2.0
*/
@Override
TinyPlugz deploy();
}
/**
* Part of the fluent configurator API. Represents the final step and allows
* to actually deploy the configured TinyPlugz instance.
*
* @author Simon Taddiken
*/
public interface DeployTinyPlugz {
/**
* Creates a new TinyPlugz instance using the configured values. The
* instance will <b>not</b> be deployed as the unique global instance
* and can be used fully independent.
*
* @return The configured instance.
* @throws TinyPlugzException When initializing TinyPlugz with the
* current configuration fails.
* @since 0.3.0
*/
TinyPlugz createInstance();
/**
* Finally deploys the {@link TinyPlugz} instance using the configured
* values. The configured instance will be globally accessible using
* {@link TinyPlugz#getInstance()}.
*
* @return The configured instance.
* @throws TinyPlugzException When initializing TinyPlugz with the
* current configuration fails.
*/
TinyPlugz deploy();
}
private static final class Impl implements DefineProperties, DeployTinyPlugz {
@NonNull
private static final Object NON_NULL_VALUE = new Object();
@NonNull
private final Map<Object, Object> properties;
@NonNull
private final ClassLoader parentCl;
private PluginSource source;
private Impl(@NonNull ClassLoader parentCl) {
this.parentCl = parentCl;
this.properties = new HashMap<>();
}
@Override
public DefineProperties withClasspathProperties() {
return withClasspathProperties(TINY_PLUGZ_CONFIG);
}
@Override
public DefineProperties withClasspathProperties(String resourceName) {
Require.nonNull(resourceName, "resourceName");
final URL url = Require.nonNullResult(this.parentCl.getResource(resourceName),
"ClassLoader.getResource");
final Properties props = new Properties();
try (final InputStream in = url.openStream()) {
props.load(in);
} catch (final IOException e) {
throw new IllegalStateException(
String.format("Resource <%s> could not be read", resourceName),
e);
}
this.properties.putAll(props);
return this;
}
@Override
public DefineProperties withProperty(String name, Object value) {
Require.nonNull(name, "name");
this.properties.put(name, value);
return this;
}
@Override
public DefineProperties withProperty(String name) {
return withProperty(name, NON_NULL_VALUE);
}
@Override
public DefineProperties withSystemProperties() {
return withProperties(Require.nonNull(System.getProperties()));
}
@Override
public DefineProperties withProperties(
Map<? extends Object, ? extends Object> values) {
Require.nonNull(values, "values");
this.properties.putAll(values);
return this;
}
@Override
public DeployTinyPlugz withPlugins(Consumer<PluginSourceBuilder> source) {
Require.nonNull(source, "source");
final PluginSourceBuilder builder = PluginSource.builder();
source.accept(builder);
this.source = builder.createSource();
return this;
}
@Override
public DeployTinyPlugz withPlugins(PluginSource source) {
Require.nonNull(source, "source");
this.source = source;
return this;
}
@Override
public TinyPlugz createInstance() {
validateProperties();
final TinyPlugz impl = getInstance();
LOG.debug("Using '{}' TinyPlugz implementation",
impl.getClass().getName());
final PluginSource pluginSource = buildSource();
logProperties();
impl.initialize(pluginSource, this.parentCl,
Collections.unmodifiableMap(this.properties));
return impl;
}
@Override
public TinyPlugz deploy() {
validateProperties();
synchronized (DEPLOY_LOCK) {
// additional synchronized check is required here
Require.state(!TinyPlugz.isDeployed(), "TinyPlugz already deployed");
final TinyPlugz impl = createInstance();
TinyPlugz.deploy(impl);
notifyListeners(impl);
return impl;
}
}
private PluginSource buildSource() {
final PluginSourceBuilder builder = new PluginSourceBuilderImpl();
if (this.properties.get(Options.PLUGIN_FOLDER) != null) {
final String p = this.properties.get(Options.PLUGIN_FOLDER).toString();
final Path path = Paths.get(p);
if (this.source == null) {
builder.addAllPluginJars(path);
} else {
builder.include(this.source).addAllPluginJars(path);
}
} else if (this.source == null) {
// plugins given neither by PlginSourceBuilder nor by property
LOG.warn("TinyPlugz has been configured without specifying any plugin " +
"sources");
} else {
builder.include(this.source);
}
return builder.createSource();
}
private void notifyListeners(TinyPlugz tinyPlugz) {
final Iterator<DeployListener> listeners = tinyPlugz.findDeployListeners(
tinyPlugz.getClassLoader());
Require.nonNullResult(listeners, "TinyPlugz.findDeployListeners");
while (listeners.hasNext()) {
final DeployListener next = Require.nonNullResult(listeners.next(),
"Iterator.next");
try {
next.initialized(tinyPlugz, this.properties);
} catch (final RuntimeException e) {
LOG.error("DeployListener '{}' threw exception", next, e);
}
}
}
private TinyPlugz getInstance() {
final TinyPlugzLookUp lookup;
if (this.properties.get(Options.FORCE_DEFAULT) != null) {
lookup = TinyPlugzLookUp.DEFAULT_INSTANCE_STRATEGY;
} else if (this.properties.get(Options.FORCE_IMPLEMENTATION) != null) {
lookup = TinyPlugzLookUp.STATIC_STRATEGY;
} else {
lookup = TinyPlugzLookUp.SPI_STRATEGY;
}
final ServiceLoaderWrapper serviceLoader;
if (this.properties.get(Options.SERVICE_LOADER_WRAPPER) != null) {
serviceLoader = ReflectionUtil.createInstance(
this.properties.get(Options.SERVICE_LOADER_WRAPPER),
ServiceLoaderWrapper.class,
this.parentCl);
} else {
serviceLoader = ServiceLoaderWrapper.getDefault();
}
LOG.debug("Using '{}' for instantiating TinyPlugz",
lookup.getClass().getName());
return lookup.getInstance(this.parentCl, serviceLoader, this.properties);
}
private void validateProperties() {
final Object forceDefault = this.properties.get(Options.FORCE_DEFAULT);
final Object forceImplementation = this.properties.get(
Options.FORCE_IMPLEMENTATION);
if (forceDefault != null && forceImplementation != null) {
throw new TinyPlugzException("Can not use 'FORCE_IMPLEMENTATION' " +
"together with 'FORCE_DEFAULT'");
}
}
private void logProperties() {
if (!LOG.isDebugEnabled() || this.properties.isEmpty()) {
return;
}
final StringBuilder b = new StringBuilder();
b.append("TinyPlugz configuration options:\n");
this.properties.forEach((k, v) -> {
b.append("\t").append(k);
if (!NON_NULL_VALUE.equals(v)) {
b.append(":\t").append(v);
}
b.append("\n");
});
LOG.debug(b.toString());
}
}
}
| Improve java doc
| tiny-plugz/src/main/java/de/skuzzle/tinyplugz/TinyPlugzConfigurator.java | Improve java doc | <ide><path>iny-plugz/src/main/java/de/skuzzle/tinyplugz/TinyPlugzConfigurator.java
<ide> * access classes and configurations from plugins. Second, the Classloader
<ide> * will be used to look up the TinyPlugz service provider either using the
<ide> * {@link ServiceLoader} or by looking up an explicit implementation class.
<del> * <p>
<del> * This method will fail immediately if TinyPlugz already has been
<del> * configured.
<ide> *
<ide> * @return Fluent builder object for further configuration.
<ide> */
<ide> * access classes and configurations from plugins. Second, the Classloader
<ide> * will be used to look up the TinyPlugz service provider either using the
<ide> * {@link ServiceLoader} or by looking up an explicit implementation class.
<del> * <p>
<del> * This method will fail immediately if TinyPlugz already has been
<del> * configured.
<ide> *
<ide> * @param parentClassLoader The parent Classloader to use.
<ide> * @return Fluent builder object for further configuration.
<ide> * access classes and configurations from plugins. Second, the Classloader
<ide> * will be used to look up the TinyPlugz service provider either using the
<ide> * {@link ServiceLoader} or by looking up an explicit implementation class.
<del> * <p>
<del> * This method will fail immediately if TinyPlugz already has been
<del> * configured.
<ide> *
<ide> * @return Fluent builder object for further configuration.
<ide> */
<ide> /**
<ide> * Creates a new TinyPlugz instance using the configured values. The
<ide> * instance will <b>not</b> be deployed as the unique global instance
<del> * and can be used fully independent.
<add> * and can be used independently.
<ide> *
<ide> * @return The configured instance.
<ide> * @throws TinyPlugzException When initializing TinyPlugz with the |
|
Java | apache-2.0 | 47e6f0d177b4682eb574982a3475a2528a9b160e | 0 | neo4j/neo4j-java-driver,neo4j/neo4j-java-driver,neo4j/neo4j-java-driver | /*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* 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 neo4j.org.testkit.backend.messages.requests.deserializer;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import static neo4j.org.testkit.backend.messages.responses.serializer.GenUtils.cypherTypeToJavaType;
public class TestkitListDeserializer extends StdDeserializer<List<?>>
{
private final TestkitCypherParamDeserializer mapDeserializer;
public TestkitListDeserializer()
{
super( List.class );
mapDeserializer = new TestkitCypherParamDeserializer();
}
@Override
public List<?> deserialize( JsonParser p, DeserializationContext ctxt ) throws IOException, JsonProcessingException
{
List<Object> result = new ArrayList<>();
JsonToken t = p.getCurrentToken();
if ( t == JsonToken.END_OBJECT )
{
return result;
}
if ( t != JsonToken.START_ARRAY )
{
ctxt.reportWrongTokenException( this, JsonToken.FIELD_NAME, null );
}
JsonToken nextToken = p.nextToken();
// standard list
if ( nextToken == JsonToken.VALUE_STRING )
{
while ( nextToken != JsonToken.END_ARRAY && nextToken != null )
{
result.add( p.readValueAs( String.class ) );
nextToken = p.nextToken();
}
return result;
}
//cypher parameter list
while ( nextToken != JsonToken.END_ARRAY )
{
String paramType = null;
if ( nextToken == JsonToken.START_OBJECT )
{
String fieldName = p.nextFieldName();
if ( fieldName.equals( "name" ) )
{
paramType = p.nextTextValue();
Class<?> mapValueType = cypherTypeToJavaType( paramType );
p.nextFieldName(); // next is data which we can drop
p.nextToken();
p.nextToken();
p.nextToken();
if ( mapValueType == null )
{
result.add( null );
}
else
{
if ( paramType.equals( "CypherMap" ) ) // special recursive case for maps
{
result.add( mapDeserializer.deserialize( p, ctxt ) );
} else {
result.add( p.readValueAs( mapValueType ) );
}
}
}
}
nextToken = p.nextToken();
}
return result;
}
} | testkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/deserializer/TestkitListDeserializer.java | /*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* 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 neo4j.org.testkit.backend.messages.requests.deserializer;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import static neo4j.org.testkit.backend.messages.responses.serializer.GenUtils.cypherTypeToJavaType;
public class TestkitListDeserializer extends StdDeserializer<List<?>>
{
public TestkitListDeserializer()
{
super( List.class );
}
@Override
public List<?> deserialize( JsonParser p, DeserializationContext ctxt ) throws IOException, JsonProcessingException
{
List<Object> result = new ArrayList<>();
JsonToken t = p.getCurrentToken();
if ( t == JsonToken.END_OBJECT )
{
return result;
}
if ( t != JsonToken.START_ARRAY )
{
ctxt.reportWrongTokenException( this, JsonToken.FIELD_NAME, null );
}
JsonToken nextToken = p.nextToken();
// standard list
if ( nextToken == JsonToken.VALUE_STRING )
{
while ( nextToken != JsonToken.END_ARRAY && nextToken != null )
{
result.add( p.readValueAs( String.class ) );
nextToken = p.nextToken();
}
return result;
}
//cypher parameter list
while ( nextToken != JsonToken.END_ARRAY )
{
String paramType = null;
if ( nextToken == JsonToken.START_OBJECT )
{
String fieldName = p.nextFieldName();
if ( fieldName.equals( "name" ) )
{
paramType = p.nextTextValue();
Class<?> mapValueType = cypherTypeToJavaType( paramType );
p.nextFieldName(); // next is data which we can drop
p.nextToken();
p.nextToken();
p.nextToken();
if ( mapValueType == null )
{
result.add( null );
}
else
{
result.add( p.readValueAs( mapValueType ) );
}
}
}
nextToken = p.nextToken();
}
p.nextToken();
p.nextToken();
return result;
}
} | testkit-backend: fix TestkitListDeserializer (#893)
Enabling `list of maps` deserialization by adding a special case for treating this data type.
The extras `nextToken` calls were removed because this was making the deserializer leaves the parent object, this way breaking the `map of lists` deserialization. | testkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/deserializer/TestkitListDeserializer.java | testkit-backend: fix TestkitListDeserializer (#893) | <ide><path>estkit-backend/src/main/java/neo4j/org/testkit/backend/messages/requests/deserializer/TestkitListDeserializer.java
<ide>
<ide> public class TestkitListDeserializer extends StdDeserializer<List<?>>
<ide> {
<add> private final TestkitCypherParamDeserializer mapDeserializer;
<ide>
<ide> public TestkitListDeserializer()
<ide> {
<ide> super( List.class );
<add> mapDeserializer = new TestkitCypherParamDeserializer();
<ide> }
<ide>
<ide> @Override
<ide> }
<ide> else
<ide> {
<del> result.add( p.readValueAs( mapValueType ) );
<add> if ( paramType.equals( "CypherMap" ) ) // special recursive case for maps
<add> {
<add> result.add( mapDeserializer.deserialize( p, ctxt ) );
<add> } else {
<add> result.add( p.readValueAs( mapValueType ) );
<add> }
<ide> }
<ide> }
<ide> }
<ide> nextToken = p.nextToken();
<ide> }
<del> p.nextToken();
<del> p.nextToken();
<ide> return result;
<ide> }
<ide> } |
|
Java | apache-2.0 | 367249322e0f7ce2081b2ad4c96d2775a1c2307d | 0 | apache/incubator-datafu,apache/incubator-datafu,shaohua-zhang/incubator-datafu,shaohua-zhang/incubator-datafu,apache/incubator-datafu,apache/incubator-datafu,shaohua-zhang/incubator-datafu,shaohua-zhang/incubator-datafu,shaohua-zhang/incubator-datafu,apache/incubator-datafu | package datafu.hourglass.test;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Method;
import java.text.ParseException;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import java.util.Properties;
import java.util.TimeZone;
import junit.framework.Assert;
import org.apache.avro.Schema;
import org.apache.avro.Schema.Field;
import org.apache.avro.Schema.Type;
import org.apache.avro.file.DataFileWriter;
import org.apache.avro.generic.GenericDatumWriter;
import org.apache.avro.generic.GenericRecord;
import org.apache.hadoop.fs.Path;
import org.apache.log4j.Logger;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import datafu.hourglass.avro.AvroDateRangeMetadata;
import datafu.hourglass.fs.DatePath;
import datafu.hourglass.fs.DateRange;
import datafu.hourglass.fs.PathUtils;
import datafu.hourglass.jobs.PartitionCollapsingExecutionPlanner;
import datafu.hourglass.test.util.DailyTrackingWriter;
public class PartitionCollapsingExecutionPlannerTests extends TestBase
{
private Logger _log = Logger.getLogger(PartitionCollapsingTests.class);
private Path _inputPath = new Path("/input");
private Path _outputPath = new Path("/output");
private Properties _props;
private static final Schema EVENT_SCHEMA;
private DailyTrackingWriter _eventWriter;
private int _maxDaysToProcess;
private boolean _reusePreviousOutput;
private String _startDate;
private String _endDate;
private Integer _numDays;
private PartitionCollapsingExecutionPlanner _planner;
static
{
EVENT_SCHEMA = Schemas.createRecordSchema(PartitionCollapsingTests.class, "Event",
new Field("id", Schema.create(Type.LONG), "ID", null));
}
public PartitionCollapsingExecutionPlannerTests() throws IOException
{
super();
}
@BeforeClass
public void beforeClass() throws Exception
{
super.beforeClass();
}
@AfterClass
public void afterClass() throws Exception
{
super.afterClass();
}
@BeforeMethod
public void beforeMethod(Method method) throws IOException
{
_log.info("*** Running " + method.getName());
_log.info("*** Cleaning input and output paths");
getFileSystem().delete(_inputPath, true);
getFileSystem().delete(_outputPath, true);
getFileSystem().mkdirs(_inputPath);
getFileSystem().mkdirs(_outputPath);
_maxDaysToProcess = 365;
_numDays = null;
_startDate = null;
_endDate = null;
_reusePreviousOutput = false;
_planner = null;
_eventWriter = new DailyTrackingWriter(_inputPath,EVENT_SCHEMA,getFileSystem());
}
@Test
public void exactlyThreeDays() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 3;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createPlan();
checkInputSize(3);
checkForInput(2012,10,1);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkNewInputSize(3);
checkForNewInput(2012,10,1);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkOldInputSize(0);
checkReusingOutput(false);
}
/**
* Tests that the most recent data is used.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void latestThreeDays() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 3;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createInput(2012,10,4);
createPlan();
checkInputSize(3);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkForInput(2012,10,4);
checkNewInputSize(3);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkForNewInput(2012,10,4);
checkOldInputSize(0);
checkReusingOutput(false);
}
/**
* Tests that the previous output can be reused, even when there are two new days since the previous
* result.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputReuse() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 8;
_reusePreviousOutput = true;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createInput(2012,10,4);
createInput(2012,10,5);
createInput(2012,10,6);
createInput(2012,10,7);
createInput(2012,10,8);
createInput(2012,10,9);
createInput(2012,10,10);
createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
createPlan();
checkNewInputSize(2);
checkForNewInput(2012,10,9);
checkForNewInput(2012,10,10);
checkOldInputSize(2);
checkForOldInput(2012,10,1);
checkForOldInput(2012,10,2);
checkInputSize(4);
checkForInput(2012,10,1);
checkForInput(2012,10,2);
checkForInput(2012,10,9);
checkForInput(2012,10,10);
checkReusingOutput(true);
}
/**
* Tests that the previous output will not be reused when the window size is small.
* It is more work to reuse the previous output in this case because the old input has
* to be subtracted from the previous result.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputNoReuseSmallWindow() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 2;
_reusePreviousOutput = true;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,2)));
createPlan();
checkNewInputSize(2);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkOldInputSize(0);
checkInputSize(2);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkReusingOutput(false);
}
/**
* Tests that the previous output won't be reused when it is too old. This would require subtracting off
* all the old input data, then adding the new data. It is better to just use the new data and not reuse
* the previous output.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputNoReuseTooOld() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 8;
_reusePreviousOutput = true;
for (int i=1; i<=20; i++)
{
createInput(2012,10,i);
}
// previous output too old to be useful
createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
createPlan();
checkNewInputSize(8);
for (int i=13; i<=20; i++)
{
checkForNewInput(2012,10,i);
}
checkOldInputSize(0);
checkInputSize(8);
for (int i=13; i<=20; i++)
{
checkForInput(2012,10,i);
}
checkReusingOutput(false);
}
private void checkForInput(int year, int month, int day)
{
checkForPath(_planner.getInputsToProcess(),year,month,day);
}
private void checkForNewInput(int year, int month, int day)
{
checkForPath(_planner.getNewInputsToProcess(),year,month,day);
}
private void checkForOldInput(int year, int month, int day)
{
checkForPath(_planner.getOldInputsToProcess(),year,month,day);
}
private void checkForPath(List<DatePath> paths, int year, int month, int day)
{
Date date = getDate(year,month,day);
DatePath datePath = DatePath.createNestedDatedPath(_inputPath.makeQualified(getFileSystem()),date);
for (DatePath dp : paths)
{
if (dp.equals(datePath))
{
return;
}
}
Assert.fail(String.format("Could not find %s",datePath));
}
private Date getDate(int year, int month, int day)
{
Calendar cal = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
cal.set(Calendar.YEAR, year);
cal.set(Calendar.MONTH, month-1);
cal.set(Calendar.DAY_OF_MONTH, day);
cal.set(Calendar.HOUR_OF_DAY, 0);
cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MILLISECOND, 0);
return cal.getTime();
}
private void checkInputSize(int size)
{
Assert.assertEquals(size,_planner.getInputsToProcess().size());
}
private void checkNewInputSize(int size)
{
Assert.assertEquals(size,_planner.getNewInputsToProcess().size());
}
private void checkOldInputSize(int size)
{
Assert.assertEquals(size,_planner.getOldInputsToProcess().size());
}
private void checkReusingOutput(boolean reuse)
{
Assert.assertEquals(reuse, _planner.getPreviousOutputToProcess() != null);
}
private void createInput(int year, int month, int day) throws IOException
{
_eventWriter.open(year, month, day);
_eventWriter.close();
}
private void createOutput(DateRange dateRange) throws IOException
{
DataFileWriter<GenericRecord> dataWriter;
OutputStream outputStream;
Path path = new Path(_outputPath,PathUtils.datedPathFormat.format(dateRange.getEndDate()));
Schema ouputSchema = Schemas.createRecordSchema(PartitionCollapsingTests.class, "Output",
new Field("id", Schema.create(Type.LONG), "ID", null));
outputStream = getFileSystem().create(new Path(path, "part-00000.avro"));
GenericDatumWriter<GenericRecord> writer = new GenericDatumWriter<GenericRecord>();
dataWriter = new DataFileWriter<GenericRecord>(writer);
dataWriter.setMeta(AvroDateRangeMetadata.METADATA_DATE_START,
Long.toString(dateRange.getBeginDate().getTime()));
dataWriter.setMeta(AvroDateRangeMetadata.METADATA_DATE_END,
Long.toString(dateRange.getEndDate().getTime()));
dataWriter.create(ouputSchema, outputStream);
// empty file
dataWriter.close();
outputStream.close();
dataWriter = null;
outputStream = null;
}
private void createPlan() throws IOException, InterruptedException, ClassNotFoundException
{
_props = newTestProperties();
_planner = new PartitionCollapsingExecutionPlanner(getFileSystem(),_props);
_planner.setNumDays(_numDays);
_planner.setMaxToProcess(_maxDaysToProcess);
_planner.setInputPaths(Arrays.asList(_inputPath));
_planner.setOutputPath(_outputPath);
_planner.setReusePreviousOutput(_reusePreviousOutput);
if (_startDate != null)
{
try
{
_planner.setStartDate(PathUtils.datedPathFormat.parse(_startDate));
}
catch (ParseException e)
{
Assert.fail(e.toString());
}
}
if (_endDate != null)
{
try
{
_planner.setEndDate(PathUtils.datedPathFormat.parse(_endDate));
}
catch (ParseException e)
{
Assert.fail(e.toString());
}
}
_planner.createPlan();
}
}
| contrib/hourglass/test/java/datafu/hourglass/test/PartitionCollapsingExecutionPlannerTests.java | package datafu.hourglass.test;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.Method;
import java.text.ParseException;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Date;
import java.util.List;
import java.util.Properties;
import java.util.TimeZone;
import junit.framework.Assert;
import org.apache.avro.Schema;
import org.apache.avro.Schema.Field;
import org.apache.avro.Schema.Type;
import org.apache.avro.file.DataFileWriter;
import org.apache.avro.generic.GenericDatumWriter;
import org.apache.avro.generic.GenericRecord;
import org.apache.hadoop.fs.Path;
import org.apache.log4j.Logger;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import datafu.hourglass.avro.AvroDateRangeMetadata;
import datafu.hourglass.fs.DatePath;
import datafu.hourglass.fs.DateRange;
import datafu.hourglass.fs.PathUtils;
import datafu.hourglass.jobs.PartitionCollapsingExecutionPlanner;
import datafu.hourglass.test.util.DailyTrackingWriter;
public class PartitionCollapsingExecutionPlannerTests extends TestBase
{
private Logger _log = Logger.getLogger(PartitionCollapsingTests.class);
private Path _inputPath = new Path("/input");
private Path _outputPath = new Path("/output");
private Properties _props;
private static final Schema EVENT_SCHEMA;
private DailyTrackingWriter _eventWriter;
private int _maxDaysToProcess;
private boolean _reusePreviousOutput;
private String _startDate;
private String _endDate;
private Integer _numDays;
private PartitionCollapsingExecutionPlanner _planner;
static
{
EVENT_SCHEMA = Schemas.createRecordSchema(PartitionCollapsingTests.class, "Event",
new Field("id", Schema.create(Type.LONG), "ID", null));
}
public PartitionCollapsingExecutionPlannerTests() throws IOException
{
super();
}
@BeforeClass
public void beforeClass() throws Exception
{
super.beforeClass();
}
@AfterClass
public void afterClass() throws Exception
{
super.afterClass();
}
@BeforeMethod
public void beforeMethod(Method method) throws IOException
{
_log.info("*** Running " + method.getName());
_log.info("*** Cleaning input and output paths");
getFileSystem().delete(_inputPath, true);
getFileSystem().delete(_outputPath, true);
getFileSystem().mkdirs(_inputPath);
getFileSystem().mkdirs(_outputPath);
_maxDaysToProcess = 365;
_numDays = null;
_startDate = null;
_endDate = null;
_reusePreviousOutput = false;
_planner = null;
_eventWriter = new DailyTrackingWriter(_inputPath,EVENT_SCHEMA,getFileSystem());
}
@Test
public void exactlyThreeDays() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 3;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createPlan();
checkInputSize(3);
checkForInput(2012,10,1);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkNewInputSize(3);
checkForNewInput(2012,10,1);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkOldInputSize(0);
checkReusingOutput(false);
}
/**
* Tests that the most recent data is used.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void latestThreeDays() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 3;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createInput(2012,10,4);
createPlan();
checkInputSize(3);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkForInput(2012,10,4);
checkNewInputSize(3);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkForNewInput(2012,10,4);
checkOldInputSize(0);
checkReusingOutput(false);
}
/**
* Tests that the previous output can be reused, even when there are two new days since the previous
* result.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputReuse() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 8;
_reusePreviousOutput = true;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createInput(2012,10,4);
createInput(2012,10,5);
createInput(2012,10,6);
createInput(2012,10,7);
createInput(2012,10,8);
createInput(2012,10,9);
createInput(2012,10,10);
createOutput(2012,10,8,new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
createPlan();
checkNewInputSize(2);
checkForNewInput(2012,10,9);
checkForNewInput(2012,10,10);
checkOldInputSize(2);
checkForOldInput(2012,10,1);
checkForOldInput(2012,10,2);
checkInputSize(4);
checkForInput(2012,10,1);
checkForInput(2012,10,2);
checkForInput(2012,10,9);
checkForInput(2012,10,10);
checkReusingOutput(true);
}
/**
* Tests that the previous output will not be reused when the window size is small.
* It is more work to reuse the previous output in this case because the old input has
* to be subtracted from the previous result.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputNoReuseSmallWindow() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 2;
_reusePreviousOutput = true;
createInput(2012,10,1);
createInput(2012,10,2);
createInput(2012,10,3);
createOutput(2012,10,2,new DateRange(getDate(2012,10,1),getDate(2012,10,2)));
createPlan();
checkNewInputSize(2);
checkForNewInput(2012,10,2);
checkForNewInput(2012,10,3);
checkOldInputSize(0);
checkInputSize(2);
checkForInput(2012,10,2);
checkForInput(2012,10,3);
checkReusingOutput(false);
}
/**
* Tests that the previous output won't be reused when it is too old. This would require subtracting off
* all the old input data, then adding the new data. It is better to just use the new data and not reuse
* the previous output.
*
* @throws IOException
* @throws InterruptedException
* @throws ClassNotFoundException
*/
@Test
public void previousOutputNoReuseTooOld() throws IOException, InterruptedException, ClassNotFoundException
{
_numDays = 8;
_reusePreviousOutput = true;
for (int i=1; i<=20; i++)
{
createInput(2012,10,i);
}
// previous output too old to be useful
createOutput(2012,10,8,new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
createPlan();
checkNewInputSize(8);
for (int i=13; i<=20; i++)
{
checkForNewInput(2012,10,i);
}
checkOldInputSize(0);
checkInputSize(8);
for (int i=13; i<=20; i++)
{
checkForInput(2012,10,i);
}
checkReusingOutput(false);
}
private void checkForInput(int year, int month, int day)
{
checkForPath(_planner.getInputsToProcess(),year,month,day);
}
private void checkForNewInput(int year, int month, int day)
{
checkForPath(_planner.getNewInputsToProcess(),year,month,day);
}
private void checkForOldInput(int year, int month, int day)
{
checkForPath(_planner.getOldInputsToProcess(),year,month,day);
}
private void checkForPath(List<DatePath> paths, int year, int month, int day)
{
Date date = getDate(year,month,day);
DatePath datePath = DatePath.createNestedDatedPath(_inputPath.makeQualified(getFileSystem()),date);
for (DatePath dp : paths)
{
if (dp.equals(datePath))
{
return;
}
}
Assert.fail(String.format("Could not find %s",datePath));
}
private Date getDate(int year, int month, int day)
{
Calendar cal = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
cal.set(Calendar.YEAR, year);
cal.set(Calendar.MONTH, month-1);
cal.set(Calendar.DAY_OF_MONTH, day);
cal.set(Calendar.HOUR_OF_DAY, 0);
cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MILLISECOND, 0);
return cal.getTime();
}
private void checkInputSize(int size)
{
Assert.assertEquals(size,_planner.getInputsToProcess().size());
}
private void checkNewInputSize(int size)
{
Assert.assertEquals(size,_planner.getNewInputsToProcess().size());
}
private void checkOldInputSize(int size)
{
Assert.assertEquals(size,_planner.getOldInputsToProcess().size());
}
private void checkReusingOutput(boolean reuse)
{
Assert.assertEquals(reuse, _planner.getPreviousOutputToProcess() != null);
}
private void createInput(int year, int month, int day) throws IOException
{
_eventWriter.open(year, month, day);
_eventWriter.close();
}
private void createOutput(int year, int month, int day, DateRange dateRange) throws IOException
{
DataFileWriter<GenericRecord> dataWriter;
OutputStream outputStream;
Path path = new Path(_outputPath,String.format("%04d%02d%02d",year,month,day));
Schema ouputSchema = Schemas.createRecordSchema(PartitionCollapsingTests.class, "Output",
new Field("id", Schema.create(Type.LONG), "ID", null));
outputStream = getFileSystem().create(new Path(path, "part-00000.avro"));
GenericDatumWriter<GenericRecord> writer = new GenericDatumWriter<GenericRecord>();
dataWriter = new DataFileWriter<GenericRecord>(writer);
dataWriter.setMeta(AvroDateRangeMetadata.METADATA_DATE_START,
Long.toString(dateRange.getBeginDate().getTime()));
dataWriter.setMeta(AvroDateRangeMetadata.METADATA_DATE_END,
Long.toString(dateRange.getEndDate().getTime()));
dataWriter.create(ouputSchema, outputStream);
// empty file
dataWriter.close();
outputStream.close();
dataWriter = null;
outputStream = null;
}
private void createPlan() throws IOException, InterruptedException, ClassNotFoundException
{
_props = newTestProperties();
_planner = new PartitionCollapsingExecutionPlanner(getFileSystem(),_props);
_planner.setNumDays(_numDays);
_planner.setMaxToProcess(_maxDaysToProcess);
_planner.setInputPaths(Arrays.asList(_inputPath));
_planner.setOutputPath(_outputPath);
_planner.setReusePreviousOutput(_reusePreviousOutput);
if (_startDate != null)
{
try
{
_planner.setStartDate(PathUtils.datedPathFormat.parse(_startDate));
}
catch (ParseException e)
{
Assert.fail(e.toString());
}
}
if (_endDate != null)
{
try
{
_planner.setEndDate(PathUtils.datedPathFormat.parse(_endDate));
}
catch (ParseException e)
{
Assert.fail(e.toString());
}
}
_planner.createPlan();
}
}
| Implicitly use end of range as path in tests
[ci skip]
| contrib/hourglass/test/java/datafu/hourglass/test/PartitionCollapsingExecutionPlannerTests.java | Implicitly use end of range as path in tests | <ide><path>ontrib/hourglass/test/java/datafu/hourglass/test/PartitionCollapsingExecutionPlannerTests.java
<ide> createInput(2012,10,9);
<ide> createInput(2012,10,10);
<ide>
<del> createOutput(2012,10,8,new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
<add> createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
<ide>
<ide> createPlan();
<ide>
<ide> createInput(2012,10,2);
<ide> createInput(2012,10,3);
<ide>
<del> createOutput(2012,10,2,new DateRange(getDate(2012,10,1),getDate(2012,10,2)));
<add> createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,2)));
<ide>
<ide> createPlan();
<ide>
<ide> }
<ide>
<ide> // previous output too old to be useful
<del> createOutput(2012,10,8,new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
<add> createOutput(new DateRange(getDate(2012,10,1),getDate(2012,10,8)));
<ide>
<ide> createPlan();
<ide>
<ide> _eventWriter.close();
<ide> }
<ide>
<del> private void createOutput(int year, int month, int day, DateRange dateRange) throws IOException
<add> private void createOutput(DateRange dateRange) throws IOException
<ide> {
<ide> DataFileWriter<GenericRecord> dataWriter;
<ide> OutputStream outputStream;
<ide>
<del> Path path = new Path(_outputPath,String.format("%04d%02d%02d",year,month,day));
<add> Path path = new Path(_outputPath,PathUtils.datedPathFormat.format(dateRange.getEndDate()));
<ide>
<ide> Schema ouputSchema = Schemas.createRecordSchema(PartitionCollapsingTests.class, "Output",
<ide> new Field("id", Schema.create(Type.LONG), "ID", null)); |
|
Java | mit | a716a22a3d3639c121eac274c17deefadb9c0f88 | 0 | dhakiki/SimCity201 | package simcity.gui;
import simcity.PersonAgent;
import java.awt.*;
import java.util.HashMap;
import simcity.DRestaurant.DCustomerRole;
public class PersonGui implements Gui {
private PersonAgent agent = null;
public boolean waiterAtFront()
{
if(xPos==-20 && yPos==-20) return true;
else return false;
}
private boolean isPresent = false;
private boolean isHungry = false;
SimCityGui gui;
private int tableGoingTo;
public static final int x_Offset = 100;
private int xPos = 0, yPos = 0;//default waiter position
private int xDestination = 0, yDestination = 0;//default start position
// private int xFoodDestination, yFoodDestination;
private boolean cookedLabelVisible=false;
private boolean foodIsFollowingWaiter=false;
private boolean madeToCashier=false;
private boolean tryingToGetToFront=false;
private boolean madeToFront=true;
//private String foodReady;
// static List<CookLabel> foodz = Collections.synchronizedList(new ArrayList<CookLabel>());
//private int hangout_x = 50, hangout_y=50;
public static final int streetWidth = 30;
public static final int sidewalkWidth = 20;
public static final int housingWidth=30;
public static final int housingLength=35;
public static final int parkingGap = 22;
public static final int yardSpace=11;
HashMap<String, Point> myMap = new HashMap<String, Point>();
//int numPlating=1;
enum Command {none, GoToRestaurant, GoHome, other};
Command command= Command.none;
//public String[] foodReady= new String[nTABLES];
//public boolean[] labelIsShowing = new boolean[nTABLES];
private boolean labelIsShowing=false;
String foodReady;
// private int seatingAt;
private DCustomerRole takingOrderFrom;//, orderFrom;
private int seatingAt_x, seatingAt_y;
private int tablegoingto_x, tablegoingto_y;
//f private void setSeatingAt(int t) { seatingAt=t; }
public PersonGui(PersonAgent agent, SimCityGui g) {
gui=g;
this.agent = agent;
madeToFront=true;
// for(int i=0; i<labelIsShowing.length;i++)
// labelIsShowing[i]=false;
//coordinates are from citypanel, find the building you want to ppl to go to and copy/paste coordinates to this map
myMap.put("Restaurant 1", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+sidewalkWidth));
myMap.put("Restaurant 2", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Restaurant 3", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+sidewalkWidth));
myMap.put("Restaurant 4", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+sidewalkWidth));
myMap.put("Restaurant 5", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Restaurant 6", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("House 1", new Point(yardSpace+30, streetWidth+sidewalkWidth));
myMap.put("House 2", new Point(yardSpace+30, streetWidth+sidewalkWidth+2*housingLength+ 2*parkingGap));
myMap.put("House 3", new Point(yardSpace+30, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
myMap.put("House 4", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+housingLength+ sidewalkWidth + parkingGap));
myMap.put("House 5", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 6", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("House 7", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 8", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 9", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("House 10", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 11", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 12", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 13", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 14", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 15", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 1", new Point(yardSpace+30, streetWidth+sidewalkWidth+housingLength+ parkingGap));
myMap.put("Apartment 2", new Point(yardSpace+30, streetWidth+sidewalkWidth+3*housingLength+ 3*parkingGap));
myMap.put("Apartment 3", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 4", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+housingLength + sidewalkWidth+ parkingGap));
myMap.put("Apartment 5", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 6", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 7", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("Apartment 8", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 9", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 10", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 11", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+sidewalkWidth));
myMap.put("Apartment 12", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Homeless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Bank 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
myMap.put("Bank 2", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+sidewalkWidth));
myMap.put("Market 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+sidewalkWidth));
myMap.put("Market 2", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Market 3", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+sidewalkWidth));
myMap.put("Market 4", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
//Figuring out where the person starts off when created
String personAddress=agent.homeAddress;
if(personAddress.contains("Apartment")) {
// System.err.println("need to truncate");
personAddress=personAddress.substring(0, personAddress.length()-1);
//System.err.println(personAddress);
}
if (personAddress.equals("House 1") || personAddress.equals("House 2") || personAddress.equals("Apartment 1")
|| personAddress.equals("House 3") || personAddress.equals("Apartment 2") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Market 1") || personAddress.equals("House 4") || personAddress.equals("Apartment 3")
|| personAddress.equals("House 5") || personAddress.equals("Bank 1") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 1") || personAddress.equals("Aparment 4") || personAddress.equals("Apartment 5")
|| personAddress.equals("House 6") || personAddress.equals("Restaurant 2") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 3") || personAddress.equals("House 7") || personAddress.equals("Apartment 6")
|| personAddress.equals("House 8") || personAddress.equals("Market 2") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 4") || personAddress.equals("Apartment 7") || personAddress.equals("House 9")
|| personAddress.equals("Apartment 8") || personAddress.equals("Restaurant 5") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Market 3") || personAddress.equals("House 10") || personAddress.equals("Apartment 9")
|| personAddress.equals("House 11") || personAddress.equals("Restaurant 6") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Bank 2") || personAddress.equals("House 12") || personAddress.equals("Apartment 10")
|| personAddress.equals("House 13") || personAddress.equals("Market 4") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Apartment 11") || personAddress.equals("House 14") || personAddress.equals("Apartment 12")
|| personAddress.equals("House 15") || personAddress.equals("Homeless Shelter") ) {
xPos = myMap.get(personAddress).x;
yPos = myMap.get(personAddress).y;
}
xDestination=xPos;
yDestination=yPos;
}
@Override
public void updatePosition() {
//System.out.println("x pos: "+ xPos + " // y pos: "+ yPos+" // xDestination: " + xDestination + " // yDestination: " + yDestination);
/**
if (xPos < xDestination)
xPos++;
else if (xPos > xDestination)
xPos--;
*/
if (xPos != xDestination && yPos != yDestination) {
if (yPos == 30 || yPos == 335) {
if (xPos < xDestination)
xPos++;
else if (xPos > xDestination)
xPos--;
}
else if (335 - yPos < 0 )
yPos++;
else
yPos--;
}
if (xPos == xDestination && yPos != yDestination) {
if (yPos < yDestination)
yPos++;
else if (yPos > yDestination)
yPos--;
}
if (xPos == xDestination && yPos == yDestination)
{
if(command==Command.GoToRestaurant ||command==Command.GoHome||command==Command.other) {
agent.msgAnimationArivedAtRestaurant();
System.out.println("msgArrivedat");
}
command=Command.none;
}
}
@Override
public void draw(Graphics2D g) {
g.setColor(Color.magenta);
g.fillRect(xPos, yPos, 10, 10);
// if(labelIsShowing) {
// g.setColor(Color.BLACK);
// g.drawString(foodReady.substring(0,2),xFood, yFood);
//
// }
//
}
@Override
public boolean isPresent() {
return true;
}
public void setHungry() {
isHungry = true;
// agent.gotHungry();
setPresent(true);
}
public void setPresent(boolean p) {
isPresent = p;
}
public int getXPos() {
return xPos;
}
public int getYPos() {
return yPos;
}
public void DoGoTo(String destination) {
if(destination.contains("Restaurant")) {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoToRestaurant;
}
if(destination.contains("Bank")) {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoToRestaurant;
}
if(destination.contains("House") || destination.contains("Apartment")) {
if(destination.contains("Apartment")) {
destination=destination.substring(0, destination.length()-1);
//System.err.println(destination);
}
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoHome;
}
else {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.other;
}
}
// static class CookLabel {
// String food;
// int xPos, yPos;
// boolean isFollowing;
// enum LabelState {ingredient, cooking, cooked, plating, plated};
// LabelState state;
// CookLabel(String f, int x, int y) {
//// System.err.println(f);
// food=f;
// xPos=x;
// yPos=y;
// isFollowing=true;
// state=LabelState.ingredient;
//// System.err.println("added");
// }
// }
}
| src/simcity/gui/PersonGui.java | package simcity.gui;
import simcity.PersonAgent;
import java.awt.*;
import java.util.HashMap;
import simcity.DRestaurant.DCustomerRole;
public class PersonGui implements Gui {
private PersonAgent agent = null;
public boolean waiterAtFront()
{
if(xPos==-20 && yPos==-20) return true;
else return false;
}
private boolean isPresent = false;
private boolean isHungry = false;
SimCityGui gui;
private int tableGoingTo;
public static final int x_Offset = 100;
private int xPos = 0, yPos = 0;//default waiter position
private int xDestination = 0, yDestination = 0;//default start position
// private int xFoodDestination, yFoodDestination;
private boolean cookedLabelVisible=false;
private boolean foodIsFollowingWaiter=false;
private boolean madeToCashier=false;
private boolean tryingToGetToFront=false;
private boolean madeToFront=true;
//private String foodReady;
// static List<CookLabel> foodz = Collections.synchronizedList(new ArrayList<CookLabel>());
//private int hangout_x = 50, hangout_y=50;
public static final int streetWidth = 30;
public static final int sidewalkWidth = 20;
public static final int housingWidth=30;
public static final int housingLength=35;
public static final int parkingGap = 22;
public static final int yardSpace=11;
HashMap<String, Point> myMap = new HashMap<String, Point>();
//int numPlating=1;
enum Command {none, GoToRestaurant, GoHome, other};
Command command= Command.none;
//public String[] foodReady= new String[nTABLES];
//public boolean[] labelIsShowing = new boolean[nTABLES];
private boolean labelIsShowing=false;
String foodReady;
// private int seatingAt;
private DCustomerRole takingOrderFrom;//, orderFrom;
private int seatingAt_x, seatingAt_y;
private int tablegoingto_x, tablegoingto_y;
//f private void setSeatingAt(int t) { seatingAt=t; }
public PersonGui(PersonAgent agent, SimCityGui g) {
gui=g;
this.agent = agent;
madeToFront=true;
// for(int i=0; i<labelIsShowing.length;i++)
// labelIsShowing[i]=false;
//coordinates are from citypanel, find the building you want to ppl to go to and copy/paste coordinates to this map
myMap.put("Restaurant 1", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth));
myMap.put("Restaurant 2", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Restaurant 3", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+sidewalkWidth));
myMap.put("Restaurant 4", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+sidewalkWidth));
myMap.put("Restaurant 5", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Restaurant 6", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("House 1", new Point(yardSpace, streetWidth+sidewalkWidth));
myMap.put("House 2", new Point(yardSpace, streetWidth+sidewalkWidth+2*housingLength+ 2*parkingGap));
myMap.put("House 3", new Point(yardSpace, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
myMap.put("House 4", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+housingLength+ sidewalkWidth + parkingGap));
myMap.put("House 5", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 6", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("House 7", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 8", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 9", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("House 10", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 11", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 12", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 13", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("House 14", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("House 15", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 1", new Point(yardSpace, streetWidth+sidewalkWidth+housingLength+ parkingGap));
myMap.put("Apartment 2", new Point(yardSpace, streetWidth+sidewalkWidth+3*housingLength+ 3*parkingGap));
myMap.put("Apartment 3", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 4", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+housingLength + sidewalkWidth+ parkingGap));
myMap.put("Apartment 5", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 6", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 7", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
myMap.put("Apartment 8", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
myMap.put("Apartment 9", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 10", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Apartment 11", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+sidewalkWidth));
myMap.put("Apartment 12", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
myMap.put("Homeless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Bank 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
myMap.put("Bank 2", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+sidewalkWidth));
myMap.put("Market 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth));
myMap.put("Market 2", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Market 3", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+sidewalkWidth));
myMap.put("Market 4", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
myMap.put("Homless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
String personAddress=agent.homeAddress;
if(personAddress.contains("Apartment")) {
// System.err.println("need to truncate");
personAddress=personAddress.substring(0, personAddress.length()-1);
//System.err.println(personAddress);
}
if (personAddress.equals("House 1") || personAddress.equals("House 2") || personAddress.equals("Apartment 1")
|| personAddress.equals("House 3") || personAddress.equals("Apartment 2") ) {
xPos = myMap.get(personAddress).x + 30;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Market 1") || personAddress.equals("House 4") || personAddress.equals("Apartment 3")
|| personAddress.equals("House 5") || personAddress.equals("Bank 1") ) {
xPos = myMap.get(personAddress).x - 10;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 1") || personAddress.equals("Aparment 4") || personAddress.equals("Apartment 5")
|| personAddress.equals("House 6") || personAddress.equals("Restaurant 2") ) {
xPos = myMap.get(personAddress).x + 30;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 3") || personAddress.equals("House 7") || personAddress.equals("Apartment 6")
|| personAddress.equals("House 8") || personAddress.equals("Market 2") ) {
xPos = myMap.get(personAddress).x - 10;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Restaurant 4") || personAddress.equals("Apartment 7") || personAddress.equals("House 9")
|| personAddress.equals("Apartment 8") || personAddress.equals("Restaurant 5") ) {
xPos = myMap.get(personAddress).x + 30;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Market 3") || personAddress.equals("House 10") || personAddress.equals("Apartment 9")
|| personAddress.equals("House 11") || personAddress.equals("Restaurant 6") ) {
xPos = myMap.get(personAddress).x - 10;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Bank 2") || personAddress.equals("House 12") || personAddress.equals("Apartment 10")
|| personAddress.equals("House 13") || personAddress.equals("Market 4") ) {
xPos = myMap.get(personAddress).x + 30;
yPos = myMap.get(personAddress).y;
}
else if (personAddress.equals("Apartment 11") || personAddress.equals("House 14") || personAddress.equals("Apartment 12")
|| personAddress.equals("House 15") || personAddress.equals("Homeless Shelter") ) {
xPos = myMap.get(personAddress).x - 10;
yPos = myMap.get(personAddress).y;
}
xDestination=xPos;
yDestination=yPos;
}
@Override
public void updatePosition() {
//System.out.println("x pos: "+ xPos + " // y pos: "+ yPos+" // xDestination: " + xDestination + " // yDestination: " + yDestination);
/**
if (xPos < xDestination)
xPos++;
else if (xPos > xDestination)
xPos--;
*/
if (xPos != xDestination && yPos != yDestination) {
if (yPos == 30 || yPos == 335) {
if (xPos < xDestination)
xPos++;
else if (xPos > xDestination)
xPos--;
}
else if (335 - yPos < 0 )
yPos++;
else
yPos--;
}
if (xPos == xDestination && yPos != yDestination) {
if (yPos < yDestination)
yPos++;
else if (yPos > yDestination)
yPos--;
}
if (xPos == xDestination && yPos == yDestination)
{
if(command==Command.GoToRestaurant ||command==Command.GoHome||command==Command.other) {
agent.msgAnimationArivedAtRestaurant();
System.out.println("msgArrivedat");
}
command=Command.none;
}
}
@Override
public void draw(Graphics2D g) {
g.setColor(Color.magenta);
g.fillRect(xPos, yPos, 10, 10);
// if(labelIsShowing) {
// g.setColor(Color.BLACK);
// g.drawString(foodReady.substring(0,2),xFood, yFood);
//
// }
//
}
@Override
public boolean isPresent() {
return true;
}
public void setHungry() {
isHungry = true;
// agent.gotHungry();
setPresent(true);
}
public void setPresent(boolean p) {
isPresent = p;
}
public int getXPos() {
return xPos;
}
public int getYPos() {
return yPos;
}
public void DoGoTo(String destination) {
if(destination.contains("Restaurant")) {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoToRestaurant;
}
if(destination.contains("Bank")) {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoToRestaurant;
}
if(destination.contains("House") || destination.contains("Apartment")) {
if(destination.contains("Apartment")) {
destination=destination.substring(0, destination.length()-1);
//System.err.println(destination);
}
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.GoHome;
}
else {
Point myDest = myMap.get(destination);
xDestination = myDest.x;
yDestination = myDest.y;
command=Command.other;
}
}
// static class CookLabel {
// String food;
// int xPos, yPos;
// boolean isFollowing;
// enum LabelState {ingredient, cooking, cooked, plating, plated};
// LabelState state;
// CookLabel(String f, int x, int y) {
//// System.err.println(f);
// food=f;
// xPos=x;
// yPos=y;
// isFollowing=true;
// state=LabelState.ingredient;
//// System.err.println("added");
// }
// }
}
| fix walking people
| src/simcity/gui/PersonGui.java | fix walking people | <ide><path>rc/simcity/gui/PersonGui.java
<ide> // labelIsShowing[i]=false;
<ide>
<ide> //coordinates are from citypanel, find the building you want to ppl to go to and copy/paste coordinates to this map
<del> myMap.put("Restaurant 1", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Restaurant 2", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del> myMap.put("Restaurant 3", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Restaurant 4", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Restaurant 5", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del> myMap.put("Restaurant 6", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del>
<del> myMap.put("House 1", new Point(yardSpace, streetWidth+sidewalkWidth));
<del> myMap.put("House 2", new Point(yardSpace, streetWidth+sidewalkWidth+2*housingLength+ 2*parkingGap));
<del> myMap.put("House 3", new Point(yardSpace, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
<del> myMap.put("House 4", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+housingLength+ sidewalkWidth + parkingGap));
<del> myMap.put("House 5", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("House 6", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("House 7", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<del> myMap.put("House 8", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("House 9", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("House 10", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<del> myMap.put("House 11", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("House 12", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<del> myMap.put("House 13", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("House 14", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<del> myMap.put("House 15", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("Apartment 1", new Point(yardSpace, streetWidth+sidewalkWidth+housingLength+ parkingGap));
<del> myMap.put("Apartment 2", new Point(yardSpace, streetWidth+sidewalkWidth+3*housingLength+ 3*parkingGap));
<del> myMap.put("Apartment 3", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("Apartment 4", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+housingLength + sidewalkWidth+ parkingGap));
<del> myMap.put("Apartment 5", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("Apartment 6", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("Apartment 7", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<del> myMap.put("Apartment 8", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<del> myMap.put("Apartment 9", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("Apartment 10", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("Apartment 11", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Apartment 12", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<del> myMap.put("Homeless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del>
<del> myMap.put("Bank 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
<del> myMap.put("Bank 2", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+sidewalkWidth));
<del>
<del> myMap.put("Market 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Market 2", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del> myMap.put("Market 3", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+sidewalkWidth));
<del> myMap.put("Market 4", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del>
<del> myMap.put("Homless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<del>
<del>
<add> myMap.put("Restaurant 1", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+sidewalkWidth));
<add> myMap.put("Restaurant 2", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add> myMap.put("Restaurant 3", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+sidewalkWidth));
<add> myMap.put("Restaurant 4", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+sidewalkWidth));
<add> myMap.put("Restaurant 5", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add> myMap.put("Restaurant 6", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add>
<add> myMap.put("House 1", new Point(yardSpace+30, streetWidth+sidewalkWidth));
<add> myMap.put("House 2", new Point(yardSpace+30, streetWidth+sidewalkWidth+2*housingLength+ 2*parkingGap));
<add> myMap.put("House 3", new Point(yardSpace+30, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
<add> myMap.put("House 4", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+housingLength+ sidewalkWidth + parkingGap));
<add> myMap.put("House 5", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("House 6", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("House 7", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<add> myMap.put("House 8", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("House 9", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("House 10", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<add> myMap.put("House 11", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("House 12", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<add> myMap.put("House 13", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("House 14", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<add> myMap.put("House 15", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("Apartment 1", new Point(yardSpace+30, streetWidth+sidewalkWidth+housingLength+ parkingGap));
<add> myMap.put("Apartment 2", new Point(yardSpace+30, streetWidth+sidewalkWidth+3*housingLength+ 3*parkingGap));
<add> myMap.put("Apartment 3", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("Apartment 4", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+housingLength + sidewalkWidth+ parkingGap));
<add> myMap.put("Apartment 5", new Point(2*yardSpace+2*housingWidth+2*sidewalkWidth+streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("Apartment 6", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("Apartment 7", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+housingLength+ sidewalkWidth+ parkingGap));
<add> myMap.put("Apartment 8", new Point(3*yardSpace+4*housingWidth+4*sidewalkWidth+2*streetWidth+30, streetWidth+3*housingLength+ sidewalkWidth+ 3*parkingGap));
<add> myMap.put("Apartment 9", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("Apartment 10", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("Apartment 11", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+sidewalkWidth));
<add> myMap.put("Apartment 12", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+2*housingLength+ sidewalkWidth+ 2*parkingGap));
<add> myMap.put("Homeless Shelter", new Point(4*yardSpace+7*housingWidth+8*sidewalkWidth+4*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add>
<add> myMap.put("Bank 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+sidewalkWidth+4*housingLength+ 5*parkingGap));
<add> myMap.put("Bank 2", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+sidewalkWidth));
<add>
<add> myMap.put("Market 1", new Point(yardSpace+housingWidth+2*sidewalkWidth+streetWidth-10, streetWidth+sidewalkWidth));
<add> myMap.put("Market 2", new Point(2*yardSpace+3*housingWidth+4*sidewalkWidth+2*streetWidth-10, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add> myMap.put("Market 3", new Point(3*yardSpace+5*housingWidth+6*sidewalkWidth+3*streetWidth-10, streetWidth+sidewalkWidth));
<add> myMap.put("Market 4", new Point(4*yardSpace+6*housingWidth+6*sidewalkWidth+3*streetWidth+30, streetWidth+4*housingLength+ sidewalkWidth+ 5*parkingGap));
<add>
<add>
<add>
<add> //Figuring out where the person starts off when created
<add>
<ide> String personAddress=agent.homeAddress;
<ide> if(personAddress.contains("Apartment")) {
<ide> // System.err.println("need to truncate");
<ide>
<ide> if (personAddress.equals("House 1") || personAddress.equals("House 2") || personAddress.equals("Apartment 1")
<ide> || personAddress.equals("House 3") || personAddress.equals("Apartment 2") ) {
<del> xPos = myMap.get(personAddress).x + 30;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide> else if (personAddress.equals("Market 1") || personAddress.equals("House 4") || personAddress.equals("Apartment 3")
<ide> || personAddress.equals("House 5") || personAddress.equals("Bank 1") ) {
<del> xPos = myMap.get(personAddress).x - 10;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide> else if (personAddress.equals("Restaurant 1") || personAddress.equals("Aparment 4") || personAddress.equals("Apartment 5")
<ide> || personAddress.equals("House 6") || personAddress.equals("Restaurant 2") ) {
<del> xPos = myMap.get(personAddress).x + 30;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide> else if (personAddress.equals("Restaurant 3") || personAddress.equals("House 7") || personAddress.equals("Apartment 6")
<ide> || personAddress.equals("House 8") || personAddress.equals("Market 2") ) {
<del> xPos = myMap.get(personAddress).x - 10;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide> else if (personAddress.equals("Restaurant 4") || personAddress.equals("Apartment 7") || personAddress.equals("House 9")
<ide> || personAddress.equals("Apartment 8") || personAddress.equals("Restaurant 5") ) {
<del> xPos = myMap.get(personAddress).x + 30;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide>
<ide> else if (personAddress.equals("Market 3") || personAddress.equals("House 10") || personAddress.equals("Apartment 9")
<ide> || personAddress.equals("House 11") || personAddress.equals("Restaurant 6") ) {
<del> xPos = myMap.get(personAddress).x - 10;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide>
<ide> else if (personAddress.equals("Bank 2") || personAddress.equals("House 12") || personAddress.equals("Apartment 10")
<ide> || personAddress.equals("House 13") || personAddress.equals("Market 4") ) {
<del> xPos = myMap.get(personAddress).x + 30;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide>
<ide> else if (personAddress.equals("Apartment 11") || personAddress.equals("House 14") || personAddress.equals("Apartment 12")
<ide> || personAddress.equals("House 15") || personAddress.equals("Homeless Shelter") ) {
<del> xPos = myMap.get(personAddress).x - 10;
<add> xPos = myMap.get(personAddress).x;
<ide> yPos = myMap.get(personAddress).y;
<ide> }
<ide> |
|
Java | apache-2.0 | 54aa3ff0b9972354c58cacc7a2e01f9404a7e6fe | 0 | p3et/gradoop,s1ck/gradoop,niklasteichmann/gradoop,galpha/gradoop,galpha/gradoop,rostam/gradoop,dbs-leipzig/gradoop,s1ck/gradoop,dbs-leipzig/gradoop,smee/gradoop,niklasteichmann/gradoop,smee/gradoop,rostam/gradoop,p3et/gradoop | package org.gradoop.storage.hbase;
import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HTableDescriptor;
import org.apache.hadoop.hbase.client.HBaseAdmin;
import org.apache.hadoop.hbase.client.Put;
import org.apache.hadoop.hbase.client.Result;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.log4j.Logger;
import org.gradoop.GConstants;
import org.gradoop.model.Edge;
import org.gradoop.model.GraphElement;
import org.gradoop.model.Vertex;
import org.gradoop.model.impl.EdgeFactory;
import org.gradoop.model.impl.VertexFactory;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
/**
* Used to read and write an EPG vertex from/to a HBase table.
*/
public class EPGVertexHandler extends BasicHandler implements VertexHandler {
/**
* Logger
*/
private static Logger LOG = Logger.getLogger(EPGVertexHandler.class);
/**
* Byte array representation of the outgoing edges column family.
*/
private static final byte[] CF_OUT_EDGES_BYTES =
Bytes.toBytes(GConstants.CF_OUT_EDGES);
/**
* Byte array representation of the incoming edges column family.
*/
private static final byte[] CF_IN_EDGES_BYTES =
Bytes.toBytes(GConstants.CF_IN_EDGES);
/**
* Byte array representation of the graphs column family.
*/
private static final byte[] CF_GRAPHS_BYTES =
Bytes.toBytes(GConstants.CF_GRAPHS);
/**
* Separates a property string into tokens.
*/
private static final String PROPERTY_TOKEN_SEPARATOR_STRING = " ";
/**
* Separates a property string into tokens.
*/
private static final Pattern PROPERTY_TOKEN_SEPARATOR_PATTERN =
Pattern.compile(" ");
/**
* {@inheritDoc}
*/
@Override
public void createTable(final HBaseAdmin admin,
final HTableDescriptor tableDescriptor) throws IOException {
LOG.info("creating table " + tableDescriptor.getNameAsString());
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_LABELS));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_PROPERTIES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_OUT_EDGES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_IN_EDGES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_GRAPHS));
admin.createTable(tableDescriptor);
}
/**
* {@inheritDoc}
*/
@Override
public byte[] getRowKey(final Long vertexID) {
if (vertexID == null) {
throw new IllegalArgumentException("vertexID must not be null");
}
return Bytes.toBytes(vertexID.toString());
}
/**
* {@inheritDoc}
*/
@Override
public Long getVertexID(final byte[] rowKey) {
if (rowKey == null) {
throw new IllegalArgumentException("rowKey must not be null");
}
return Long.valueOf(Bytes.toString(rowKey));
}
/**
* {@inheritDoc}
*/
@Override
public Put writeOutgoingEdges(final Put put,
final Iterable<? extends Edge> edges) {
return writeEdges(put, CF_OUT_EDGES_BYTES, edges);
}
/**
* {@inheritDoc}
*/
@Override
public Put writeIncomingEdges(final Put put,
final Iterable<? extends Edge> edges) {
return writeEdges(put, CF_IN_EDGES_BYTES, edges);
}
/**
* {@inheritDoc}
*/
@Override
public Put writeGraphs(final Put put, final GraphElement graphElement) {
for (Long graphID : graphElement.getGraphs()) {
put.add(CF_GRAPHS_BYTES, Bytes.toBytes(graphID), null);
}
return put;
}
/**
* {@inheritDoc}
*/
@Override
public Put writeVertex(final Put put, final Vertex vertex) {
writeLabels(put, vertex);
writeProperties(put, vertex);
writeOutgoingEdges(put, vertex.getOutgoingEdges());
writeIncomingEdges(put, vertex.getIncomingEdges());
writeGraphs(put, vertex);
return put;
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Edge> readOutgoingEdges(final Result res) {
return readEdges(res, CF_OUT_EDGES_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Edge> readIncomingEdges(final Result res) {
return readEdges(res, CF_IN_EDGES_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Long> readGraphs(final Result res) {
return getColumnKeysFromFamiliy(res, CF_GRAPHS_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Vertex readVertex(final Result res) {
return VertexFactory
.createDefaultVertex(Long.valueOf(Bytes.toString(res.getRow())),
readLabels(res), readProperties(res), readOutgoingEdges(res),
readIncomingEdges(res), readGraphs(res));
}
/**
* Adds edges to the the given HBase put.
*
* @param put {@link org.apache.hadoop.hbase.client.Put} to
* write the
* edges to
* @param columnFamily CF where the edges shall be stored
* @param edges edges to store
* @return the updated put
*/
private Put writeEdges(Put put, final byte[] columnFamily,
final Iterable<? extends Edge> edges) {
if (edges != null) {
for (Edge edge : edges) {
put = writeEdge(put, columnFamily, edge);
}
}
return put;
}
/**
* Writes a single edge to a given put.
*
* @param put {@link org.apache.hadoop.hbase.client.Put} to
* write the
* edge to
* @param columnFamily CF where the edges shall be stored
* @param edge edge to store
* @return the updated put
*/
private Put writeEdge(final Put put, final byte[] columnFamily,
final Edge edge) {
byte[] edgeKey = createEdgeIdentifier(edge);
String properties = createEdgePropertiesString(edge);
byte[] propertiesBytes = Bytes.toBytes(properties);
put.add(columnFamily, edgeKey, propertiesBytes);
return put;
}
/**
* Serializes an edge to an edge identifier in the following format:
* <p/>
* <edge-identifier> ::= <otherID><index><label>
*
* @param edge edge to create identifier for
* @return string representation of the edge identifier
*/
private byte[] createEdgeIdentifier(final Edge edge) {
byte[] labelBytes = Bytes.toBytes(edge.getLabel());
byte[] edgeKey = new byte[2 * Bytes.SIZEOF_LONG + labelBytes.length];
Bytes.putLong(edgeKey, 0, edge.getOtherID());
Bytes.putLong(edgeKey, Bytes.SIZEOF_LONG, edge.getIndex());
Bytes.putBytes(edgeKey, Bytes.SIZEOF_LONG * 2, labelBytes, 0,
labelBytes.length);
return edgeKey;
}
/**
* Creates a string representation of edge properties which are stored as
* column value for the edge identifier.
*
* @param edge edge to create property string for
* @return string representation of the edge properties
*/
private String createEdgePropertiesString(final Edge edge) {
String result = "";
Iterable<String> propertyKeys = edge.getPropertyKeys();
if (propertyKeys != null) {
final List<String> propertyStrings = Lists.newArrayList();
for (String propertyKey : propertyKeys) {
Object propertyValue = edge.getProperty(propertyKey);
String propertyString = String
.format("%s%s%d%s%s", propertyKey, PROPERTY_TOKEN_SEPARATOR_STRING,
getType(propertyValue), PROPERTY_TOKEN_SEPARATOR_STRING,
propertyValue);
propertyStrings.add(propertyString);
}
result = Joiner.on(PROPERTY_TOKEN_SEPARATOR_STRING).join(propertyStrings);
}
return result;
}
/**
* Reads edges from a given HBase row result.
*
* @param res {@link org.apache.hadoop.hbase.client.Result} to read
* edges from
* @param columnFamily column family where the edges are stored
* @return edges
*/
private Iterable<Edge> readEdges(final Result res,
final byte[] columnFamily) {
final List<Edge> edges = Lists.newArrayList();
for (Map.Entry<byte[], byte[]> edgeColumn : res.getFamilyMap(columnFamily)
.entrySet()) {
byte[] edgeKey = edgeColumn.getKey();
Map<String, Object> edgeProperties = null;
String propertyString = Bytes.toString(edgeColumn.getValue());
if (propertyString.length() > 0) {
edgeProperties = new HashMap<>();
String[] tokens =
PROPERTY_TOKEN_SEPARATOR_PATTERN.split(propertyString);
for (int i = 0; i < tokens.length; i += 3) {
String propertyKey = tokens[i];
byte propertyType = Byte.parseByte(tokens[i + 1]);
Object propertyValue =
decodeValueFromString(propertyType, tokens[i + 2]);
edgeProperties.put(propertyKey, propertyValue);
}
}
edges.add(readEdge(edgeKey, edgeProperties));
}
return edges;
}
/**
* Creates an edge object based on the given key and properties. The given
* edge key is deserialized and used to create a new {@link
* org.gradoop.model.impl.DefaultEdge} instance.
*
* @param edgeKey string representation of edge key
* @param properties key-value-map
* @return Edge object
*/
private Edge readEdge(final byte[] edgeKey,
final Map<String, Object> properties) {
Long otherID = Bytes.toLong(edgeKey);
Long edgeIndex = Bytes.toLong(edgeKey, Bytes.SIZEOF_LONG);
String edgeLabel = Bytes.toString(edgeKey, 2 * Bytes.SIZEOF_LONG,
edgeKey.length - (2 * Bytes.SIZEOF_LONG));
return EdgeFactory
.createDefaultEdge(otherID, edgeLabel, edgeIndex, properties);
}
}
| gradoop-core/src/main/java/org/gradoop/storage/hbase/EPGVertexHandler.java | package org.gradoop.storage.hbase;
import com.google.common.base.Joiner;
import com.google.common.collect.Lists;
import org.apache.hadoop.hbase.HColumnDescriptor;
import org.apache.hadoop.hbase.HTableDescriptor;
import org.apache.hadoop.hbase.client.HBaseAdmin;
import org.apache.hadoop.hbase.client.Put;
import org.apache.hadoop.hbase.client.Result;
import org.apache.hadoop.hbase.util.Bytes;
import org.apache.log4j.Logger;
import org.gradoop.GConstants;
import org.gradoop.model.Edge;
import org.gradoop.model.GraphElement;
import org.gradoop.model.Vertex;
import org.gradoop.model.impl.EdgeFactory;
import org.gradoop.model.impl.VertexFactory;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
/**
* Used to read and write an EPG vertex from/to a HBase table.
*/
public class EPGVertexHandler extends BasicHandler implements VertexHandler {
/**
* Logger
*/
private static Logger LOG = Logger.getLogger(EPGVertexHandler.class);
/**
* Byte array representation of the outgoing edges column family.
*/
private static final byte[] CF_OUT_EDGES_BYTES =
Bytes.toBytes(GConstants.CF_OUT_EDGES);
/**
* Byte array representation of the incoming edges column family.
*/
private static final byte[] CF_IN_EDGES_BYTES =
Bytes.toBytes(GConstants.CF_IN_EDGES);
/**
* Byte array representation of the graphs column family.
*/
private static final byte[] CF_GRAPHS_BYTES =
Bytes.toBytes(GConstants.CF_GRAPHS);
/**
* Separates a property string into tokens.
*/
private static final String PROPERTY_TOKEN_SEPARATOR_STRING = " ";
/**
* Separates a property string into tokens.
*/
private static final Pattern PROPERTY_TOKEN_SEPARATOR_PATTERN =
Pattern.compile(" ");
/**
* Separates an edge key into tokens.
*/
private static final String EDGE_KEY_TOKEN_SEPARATOR_STRING = ".";
/**
* Separates an edge key into tokens.
*/
private static final Pattern EDGE_KEY_TOKEN_SEPARATOR_PATTERN =
Pattern.compile("\\.");
/**
* {@inheritDoc}
*/
@Override
public void createTable(final HBaseAdmin admin,
final HTableDescriptor tableDescriptor) throws IOException {
LOG.info("creating table " + tableDescriptor.getNameAsString());
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_LABELS));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_PROPERTIES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_OUT_EDGES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_IN_EDGES));
tableDescriptor.addFamily(new HColumnDescriptor(GConstants.CF_GRAPHS));
admin.createTable(tableDescriptor);
}
/**
* {@inheritDoc}
*/
@Override
public byte[] getRowKey(final Long vertexID) {
if (vertexID == null) {
throw new IllegalArgumentException("vertexID must not be null");
}
return Bytes.toBytes(vertexID.toString());
}
/**
* {@inheritDoc}
*/
@Override
public Long getVertexID(final byte[] rowKey) {
if (rowKey == null) {
throw new IllegalArgumentException("rowKey must not be null");
}
return Long.valueOf(Bytes.toString(rowKey));
}
/**
* {@inheritDoc}
*/
@Override
public Put writeOutgoingEdges(final Put put,
final Iterable<? extends Edge> edges) {
return writeEdges(put, CF_OUT_EDGES_BYTES, edges);
}
/**
* {@inheritDoc}
*/
@Override
public Put writeIncomingEdges(final Put put,
final Iterable<? extends Edge> edges) {
return writeEdges(put, CF_IN_EDGES_BYTES, edges);
}
/**
* {@inheritDoc}
*/
@Override
public Put writeGraphs(final Put put, final GraphElement graphElement) {
for (Long graphID : graphElement.getGraphs()) {
put.add(CF_GRAPHS_BYTES, Bytes.toBytes(graphID), null);
}
return put;
}
/**
* {@inheritDoc}
*/
@Override
public Put writeVertex(final Put put, final Vertex vertex) {
writeLabels(put, vertex);
writeProperties(put, vertex);
writeOutgoingEdges(put, vertex.getOutgoingEdges());
writeIncomingEdges(put, vertex.getIncomingEdges());
writeGraphs(put, vertex);
return put;
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Edge> readOutgoingEdges(final Result res) {
return readEdges(res, CF_OUT_EDGES_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Edge> readIncomingEdges(final Result res) {
return readEdges(res, CF_IN_EDGES_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Iterable<Long> readGraphs(final Result res) {
return getColumnKeysFromFamiliy(res, CF_GRAPHS_BYTES);
}
/**
* {@inheritDoc}
*/
@Override
public Vertex readVertex(final Result res) {
return VertexFactory
.createDefaultVertex(Long.valueOf(Bytes.toString(res.getRow())),
readLabels(res), readProperties(res), readOutgoingEdges(res),
readIncomingEdges(res), readGraphs(res));
}
/**
* Adds edges to the the given HBase put.
*
* @param put {@link org.apache.hadoop.hbase.client.Put} to
* write the
* edges to
* @param columnFamily CF where the edges shall be stored
* @param edges edges to store
* @return the updated put
*/
private Put writeEdges(Put put, final byte[] columnFamily,
final Iterable<? extends Edge> edges) {
if (edges != null) {
for (Edge edge : edges) {
put = writeEdge(put, columnFamily, edge);
}
}
return put;
}
/**
* Writes a single edge to a given put.
*
* @param put {@link org.apache.hadoop.hbase.client.Put} to
* write the
* edge to
* @param columnFamily CF where the edges shall be stored
* @param edge edge to store
* @return the updated put
*/
private Put writeEdge(final Put put, final byte[] columnFamily,
final Edge edge) {
String edgeKey = createEdgeIdentifier(edge);
byte[] edgeKeyBytes = Bytes.toBytes(edgeKey);
String properties = createEdgePropertiesString(edge);
byte[] propertiesBytes = Bytes.toBytes(properties);
put.add(columnFamily, edgeKeyBytes, propertiesBytes);
return put;
}
/**
* Creates a vertex centric edge identifier from the given edge. Edge keys
* have the following format:
* <p/>
* <edge-identifier> ::= <label>.<otherID>.<index>
*
* @param edge edge to create identifier for
* @return string representation of the edge identifier
*/
private String createEdgeIdentifier(final Edge edge) {
return String
.format("%s%s%d%s%d", edge.getLabel(), EDGE_KEY_TOKEN_SEPARATOR_STRING,
edge.getOtherID(), EDGE_KEY_TOKEN_SEPARATOR_STRING, edge.getIndex());
}
/**
* Creates a string representation of edge properties which are stored as
* column value for the edge identifier.
*
* @param edge edge to create property string for
* @return string representation of the edge properties
*/
private String createEdgePropertiesString(final Edge edge) {
String result = "";
Iterable<String> propertyKeys = edge.getPropertyKeys();
if (propertyKeys != null) {
final List<String> propertyStrings = Lists.newArrayList();
for (String propertyKey : propertyKeys) {
Object propertyValue = edge.getProperty(propertyKey);
String propertyString = String
.format("%s%s%d%s%s", propertyKey, PROPERTY_TOKEN_SEPARATOR_STRING,
getType(propertyValue), PROPERTY_TOKEN_SEPARATOR_STRING,
propertyValue);
propertyStrings.add(propertyString);
}
result = Joiner.on(PROPERTY_TOKEN_SEPARATOR_STRING).join(propertyStrings);
}
return result;
}
/**
* Reads edges from a given HBase row result.
*
* @param res {@link org.apache.hadoop.hbase.client.Result} to read
* edges from
* @param columnFamily column family where the edges are stored
* @return edges
*/
private Iterable<Edge> readEdges(final Result res,
final byte[] columnFamily) {
final List<Edge> edges = Lists.newArrayList();
for (Map.Entry<byte[], byte[]> edgeColumn : res.getFamilyMap(columnFamily)
.entrySet()) {
String edgeKey = Bytes.toString(edgeColumn.getKey());
Map<String, Object> edgeProperties = null;
String propertyString = Bytes.toString(edgeColumn.getValue());
if (propertyString.length() > 0) {
edgeProperties = new HashMap<>();
String[] tokens =
PROPERTY_TOKEN_SEPARATOR_PATTERN.split(propertyString);
for (int i = 0; i < tokens.length; i += 3) {
String propertyKey = tokens[i];
byte propertyType = Byte.parseByte(tokens[i + 1]);
Object propertyValue =
decodeValueFromString(propertyType, tokens[i + 2]);
edgeProperties.put(propertyKey, propertyValue);
}
}
edges.add(readEdge(edgeKey, edgeProperties));
}
return edges;
}
/**
* Creates an edge object based on the given key and properties. The given
* edge key is separated into tokens and used to create a new {@link
* org.gradoop.model.impl.DefaultEdge} instance.
*
* @param edgeKey string representation of edge key
* @param properties key-value-map
* @return Edge object
*/
private Edge readEdge(final String edgeKey,
final Map<String, Object> properties) {
String[] keyTokens = EDGE_KEY_TOKEN_SEPARATOR_PATTERN.split(edgeKey);
String edgeLabel = keyTokens[0];
Long otherID = Long.valueOf(keyTokens[1]);
Long edgeIndex = Long.valueOf(keyTokens[2]);
return EdgeFactory
.createDefaultEdge(otherID, edgeLabel, edgeIndex, properties);
}
}
| changed edge serialization, fixes #27
* edge identifiers are not separated by a token anymore
* serialized as Long Long String to byte[]
| gradoop-core/src/main/java/org/gradoop/storage/hbase/EPGVertexHandler.java | changed edge serialization, fixes #27 | <ide><path>radoop-core/src/main/java/org/gradoop/storage/hbase/EPGVertexHandler.java
<ide> */
<ide> private static final Pattern PROPERTY_TOKEN_SEPARATOR_PATTERN =
<ide> Pattern.compile(" ");
<del> /**
<del> * Separates an edge key into tokens.
<del> */
<del> private static final String EDGE_KEY_TOKEN_SEPARATOR_STRING = ".";
<del> /**
<del> * Separates an edge key into tokens.
<del> */
<del> private static final Pattern EDGE_KEY_TOKEN_SEPARATOR_PATTERN =
<del> Pattern.compile("\\.");
<ide>
<ide> /**
<ide> * {@inheritDoc}
<ide> */
<ide> private Put writeEdge(final Put put, final byte[] columnFamily,
<ide> final Edge edge) {
<del> String edgeKey = createEdgeIdentifier(edge);
<del> byte[] edgeKeyBytes = Bytes.toBytes(edgeKey);
<add> byte[] edgeKey = createEdgeIdentifier(edge);
<ide> String properties = createEdgePropertiesString(edge);
<ide> byte[] propertiesBytes = Bytes.toBytes(properties);
<del> put.add(columnFamily, edgeKeyBytes, propertiesBytes);
<add> put.add(columnFamily, edgeKey, propertiesBytes);
<ide> return put;
<ide> }
<ide>
<ide> /**
<del> * Creates a vertex centric edge identifier from the given edge. Edge keys
<del> * have the following format:
<add> * Serializes an edge to an edge identifier in the following format:
<ide> * <p/>
<del> * <edge-identifier> ::= <label>.<otherID>.<index>
<add> * <edge-identifier> ::= <otherID><index><label>
<ide> *
<ide> * @param edge edge to create identifier for
<ide> * @return string representation of the edge identifier
<ide> */
<del> private String createEdgeIdentifier(final Edge edge) {
<del> return String
<del> .format("%s%s%d%s%d", edge.getLabel(), EDGE_KEY_TOKEN_SEPARATOR_STRING,
<del> edge.getOtherID(), EDGE_KEY_TOKEN_SEPARATOR_STRING, edge.getIndex());
<add> private byte[] createEdgeIdentifier(final Edge edge) {
<add> byte[] labelBytes = Bytes.toBytes(edge.getLabel());
<add> byte[] edgeKey = new byte[2 * Bytes.SIZEOF_LONG + labelBytes.length];
<add> Bytes.putLong(edgeKey, 0, edge.getOtherID());
<add> Bytes.putLong(edgeKey, Bytes.SIZEOF_LONG, edge.getIndex());
<add> Bytes.putBytes(edgeKey, Bytes.SIZEOF_LONG * 2, labelBytes, 0,
<add> labelBytes.length);
<add> return edgeKey;
<ide> }
<ide>
<ide> /**
<ide> final List<Edge> edges = Lists.newArrayList();
<ide> for (Map.Entry<byte[], byte[]> edgeColumn : res.getFamilyMap(columnFamily)
<ide> .entrySet()) {
<del> String edgeKey = Bytes.toString(edgeColumn.getKey());
<add> byte[] edgeKey = edgeColumn.getKey();
<ide> Map<String, Object> edgeProperties = null;
<ide> String propertyString = Bytes.toString(edgeColumn.getValue());
<ide> if (propertyString.length() > 0) {
<ide>
<ide> /**
<ide> * Creates an edge object based on the given key and properties. The given
<del> * edge key is separated into tokens and used to create a new {@link
<add> * edge key is deserialized and used to create a new {@link
<ide> * org.gradoop.model.impl.DefaultEdge} instance.
<ide> *
<ide> * @param edgeKey string representation of edge key
<ide> * @param properties key-value-map
<ide> * @return Edge object
<ide> */
<del> private Edge readEdge(final String edgeKey,
<add> private Edge readEdge(final byte[] edgeKey,
<ide> final Map<String, Object> properties) {
<del> String[] keyTokens = EDGE_KEY_TOKEN_SEPARATOR_PATTERN.split(edgeKey);
<del> String edgeLabel = keyTokens[0];
<del> Long otherID = Long.valueOf(keyTokens[1]);
<del> Long edgeIndex = Long.valueOf(keyTokens[2]);
<add> Long otherID = Bytes.toLong(edgeKey);
<add> Long edgeIndex = Bytes.toLong(edgeKey, Bytes.SIZEOF_LONG);
<add> String edgeLabel = Bytes.toString(edgeKey, 2 * Bytes.SIZEOF_LONG,
<add> edgeKey.length - (2 * Bytes.SIZEOF_LONG));
<ide> return EdgeFactory
<ide> .createDefaultEdge(otherID, edgeLabel, edgeIndex, properties);
<ide> } |
|
Java | bsd-3-clause | 824d7b726f930de4b05d48c9f74935a897bc4997 | 0 | NCIP/catissue-core,krishagni/openspecimen,krishagni/openspecimen,asamgir/openspecimen,asamgir/openspecimen,asamgir/openspecimen,NCIP/catissue-core,krishagni/openspecimen,NCIP/catissue-core | /**
* <p>Title: SpecimenCollectionGroupAction Class>
* <p>Description: SpecimenCollectionGroupAction initializes the fields in the
* New Specimen Collection Group page.</p>
* Copyright: Copyright (c) year
* Company: Washington University, School of Medicine, St. Louis.
* @author Ajay Sharma
* @version 1.00
*/
package edu.wustl.catissuecore.action;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.Globals;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import edu.wustl.catissuecore.actionForm.SpecimenCollectionGroupForm;
import edu.wustl.catissuecore.bizlogic.BizLogicFactory;
import edu.wustl.catissuecore.bizlogic.CollectionProtocolBizLogic;
import edu.wustl.catissuecore.bizlogic.CollectionProtocolRegistrationBizLogic;
import edu.wustl.catissuecore.bizlogic.SpecimenCollectionGroupBizLogic;
import edu.wustl.catissuecore.domain.CollectionProtocol;
import edu.wustl.catissuecore.domain.CollectionProtocolEvent;
import edu.wustl.catissuecore.domain.CollectionProtocolRegistration;
import edu.wustl.catissuecore.domain.ConsentTier;
import edu.wustl.catissuecore.domain.ConsentTierResponse;
import edu.wustl.catissuecore.domain.ConsentTierStatus;
import edu.wustl.catissuecore.domain.Participant;
import edu.wustl.catissuecore.domain.ParticipantMedicalIdentifier;
import edu.wustl.catissuecore.domain.Site;
import edu.wustl.catissuecore.domain.SpecimenCollectionGroup;
import edu.wustl.catissuecore.domain.User;
import edu.wustl.catissuecore.util.global.Constants;
import edu.wustl.catissuecore.util.global.Utility;
import edu.wustl.catissuecore.util.global.Variables;
import edu.wustl.common.action.SecureAction;
import edu.wustl.common.beans.NameValueBean;
import edu.wustl.common.bizlogic.CDEBizLogic;
import edu.wustl.common.bizlogic.IBizLogic;
import edu.wustl.common.cde.CDE;
import edu.wustl.common.cde.CDEManager;
import edu.wustl.common.util.dbManager.DAOException;
import edu.wustl.common.util.logger.Logger;
/**
* SpecimenCollectionGroupAction initializes the fields in the
* New Specimen Collection Group page.
* @author ajay_sharma
*/
public class SpecimenCollectionGroupAction extends SecureAction
{
/**
* Overrides the execute method of Action class.
*/
public ActionForward executeSecureAction(ActionMapping mapping, ActionForm form,
HttpServletRequest request, HttpServletResponse response) throws Exception
{
SpecimenCollectionGroupForm specimenCollectionGroupForm = (SpecimenCollectionGroupForm)form;
Logger.out.debug("SCGA : " + specimenCollectionGroupForm.getId() );
// set the menu selection
request.setAttribute(Constants.MENU_SELECTED, "14" );
//pageOf and operation attributes required for Advance Query Object view.
String pageOf = request.getParameter(Constants.PAGEOF);
//Gets the value of the operation parameter.
String operation = (String)request.getParameter(Constants.OPERATION);
//Sets the operation attribute to be used in the Edit/View Specimen Collection Group Page in Advance Search Object View.
request.setAttribute(Constants.OPERATION,operation);
if(operation.equalsIgnoreCase(Constants.ADD ) )
{
specimenCollectionGroupForm.setId(0);
Logger.out.debug("SCGA : set to 0 "+ specimenCollectionGroupForm.getId() );
}
boolean isOnChange = false;
String str = request.getParameter("isOnChange");
if(str!=null)
{
if(str.equals("true"))
isOnChange = true;
}
//For Consent Tracking Virender Mehta
int index=1;
String id=null;
String indexType=null;
String cp_id=String.valueOf(specimenCollectionGroupForm.getCollectionProtocolId());
if(cp_id.equalsIgnoreCase("0"))
{
Map forwardToHashMap = (Map)request.getAttribute("forwardToHashMap");
if(forwardToHashMap!=null)
{
cp_id=forwardToHashMap.get("collectionProtocolId").toString();
id=forwardToHashMap.get("participantId").toString();
indexType="participantId";
if(id==null||id.equalsIgnoreCase("0"))
{
id=forwardToHashMap.get("participantProtocolId").toString();
indexType="protocolParticipantIdentifier";
}
}
}
if(!cp_id.equals("-1"))
{
String showConsents = request.getParameter(Constants.SHOW_CONSENTS);
if(showConsents!=null && showConsents.equalsIgnoreCase(Constants.YES))
{
if(id==null)
{
index=(int)specimenCollectionGroupForm.getCheckedButton();
if(index==1)
{
id=Long.toString(specimenCollectionGroupForm.getParticipantId());
indexType="participantId";
}
else
{
id=specimenCollectionGroupForm.getProtocolParticipantIdentifier();
indexType="protocolParticipantIdentifier";
}
}
//If participant and Participant ProtocolIdentifier is not selected
if(!id.equalsIgnoreCase("-1"))
{
//Get CollectionprotocolRegistration Object
CollectionProtocolRegistration collectionProtocolRegistration=getcollectionProtocolRegistrationObj(id,cp_id,indexType);
User witness= collectionProtocolRegistration.getConsentWitness();
if(witness==null||witness.getFirstName()==null)
{
String witnessName="";
specimenCollectionGroupForm.setWitnessName(witnessName);
}
else
{
String witnessFullName = witness.getLastName()+", "+witness.getFirstName();
specimenCollectionGroupForm.setWitnessName(witnessFullName);
}
String getConsentDate=Utility.parseDateToString(collectionProtocolRegistration.getConsentSignatureDate(), Constants.DATE_PATTERN_MM_DD_YYYY);
specimenCollectionGroupForm.setConsentDate(getConsentDate);
String getSignedConsentURL=Utility.toString(collectionProtocolRegistration.getSignedConsentDocumentURL());
specimenCollectionGroupForm.setSignedConsentUrl(getSignedConsentURL);
//Set witnessName,ConsentDate and SignedConsentURL
Set participantResponseSet = (Set)collectionProtocolRegistration.getConsentTierResponseCollection();
List participantResponseList= new ArrayList(participantResponseSet);
if(operation.equalsIgnoreCase(Constants.ADD))
{
ActionErrors errors = (ActionErrors) request.getAttribute(Globals.ERROR_KEY);
if(errors == null)
{
String protocolEventID = request.getParameter("protocolEventId");
if(protocolEventID==null||protocolEventID.equalsIgnoreCase(Constants.FALSE))
{
Map tempMap=prepareConsentMap(participantResponseList);
specimenCollectionGroupForm.setConsentResponseForScgValues(tempMap);
}
}
specimenCollectionGroupForm.setConsentTierCounter(participantResponseList.size());
}
else
{
String scgID = String.valueOf(specimenCollectionGroupForm.getId());
SpecimenCollectionGroup specimenCollectionGroup = getSCGObj(scgID);
Collection consentResponse = specimenCollectionGroup.getCollectionProtocolRegistration().getConsentTierResponseCollection();
Collection consentResponseStatuslevel= specimenCollectionGroup.getConsentTierStatusCollection();
Map tempMap=prepareSCGResponseMap(consentResponseStatuslevel, consentResponse);
specimenCollectionGroupForm.setConsentResponseForScgValues(tempMap);
specimenCollectionGroupForm.setConsentTierCounter(participantResponseList.size());
}
}
List specimenCollectionGroupResponseList =Utility.responceList(operation);
request.setAttribute("specimenCollectionGroupResponseList", specimenCollectionGroupResponseList);
}
}
//For Consent Tracking Virender Mehta
// get list of Protocol title.
SpecimenCollectionGroupBizLogic bizLogic = (SpecimenCollectionGroupBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.SPECIMEN_COLLECTION_GROUP_FORM_ID);
//populating protocolist bean.
String sourceObjectName = CollectionProtocol.class.getName();
String [] displayNameFields = {"title"};
String valueField = Constants.SYSTEM_IDENTIFIER;
List list = bizLogic.getList(sourceObjectName,displayNameFields,valueField, true);
request.setAttribute(Constants.PROTOCOL_LIST, list);
//Populating the Site Type bean
sourceObjectName = Site.class.getName();
String siteDisplaySiteFields[] = {"name"};
list = bizLogic.getList(sourceObjectName,siteDisplaySiteFields,valueField, true);
request.setAttribute(Constants.SITELIST, list);
//Populating the participants registered to a given protocol
loadPaticipants(specimenCollectionGroupForm.getCollectionProtocolId() , bizLogic, request);
//Populating the protocol participants id registered to a given protocol
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
String protocolParticipantId = specimenCollectionGroupForm.getProtocolParticipantIdentifier();
//Populating the participants Medical Identifier for a given participant
loadParticipantMedicalIdentifier(specimenCollectionGroupForm.getParticipantId(),bizLogic, request);
//Load Clinical status for a given study calander event point
List calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(isOnChange && !calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
// populating clinical Diagnosis field
CDE cde = CDEManager.getCDEManager().getCDE(Constants.CDE_NAME_CLINICAL_DIAGNOSIS);
CDEBizLogic cdeBizLogic = (CDEBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.CDE_FORM_ID);
List clinicalDiagnosisList = new ArrayList();
clinicalDiagnosisList.add(new NameValueBean(Constants.SELECT_OPTION,""+Constants.SELECT_OPTION_VALUE));
cdeBizLogic.getFilteredCDE(cde.getPermissibleValues(),clinicalDiagnosisList);
request.setAttribute(Constants.CLINICAL_DIAGNOSIS_LIST, clinicalDiagnosisList);
// populating clinical Status field
// NameValueBean undefinedVal = new NameValueBean(Constants.UNDEFINED,Constants.UNDEFINED);
List clinicalStatusList = CDEManager.getCDEManager().getPermissibleValueList(Constants.CDE_NAME_CLINICAL_STATUS,null);
request.setAttribute(Constants.CLINICAL_STATUS_LIST, clinicalStatusList);
//Sets the activityStatusList attribute to be used in the Site Add/Edit Page.
request.setAttribute(Constants.ACTIVITYSTATUSLIST, Constants.ACTIVITY_STATUS_VALUES);
Logger.out.debug("CP ID in SCG Action======>"+specimenCollectionGroupForm.getCollectionProtocolId());
Logger.out.debug("Participant ID in SCG Action=====>"+specimenCollectionGroupForm.getParticipantId()+" "+specimenCollectionGroupForm.getProtocolParticipantIdentifier());
if( (request.getAttribute(Constants.SUBMITTED_FOR) !=null) &&(request.getAttribute(Constants.SUBMITTED_FOR).equals("Default")))
{
Logger.out.debug("Populating CP and Participant in SCG ==== AddNew operation loop");
Long cprId =new Long(specimenCollectionGroupForm.getCollectionProtocolRegistrationId());
if(cprId != null)
{
List collectionProtocolRegistrationList = bizLogic.retrieve(CollectionProtocolRegistration.class.getName(),
Constants.SYSTEM_IDENTIFIER,cprId);
if(!collectionProtocolRegistrationList.isEmpty())
{
Object obj = collectionProtocolRegistrationList.get(0 );
CollectionProtocolRegistration cpr = (CollectionProtocolRegistration)obj;
long cpID = cpr.getCollectionProtocol().getId().longValue();
long pID = cpr.getParticipant().getId().longValue();
String ppID = cpr.getProtocolParticipantIdentifier();
Logger.out.debug("cpID : "+ cpID + " || pID : " + pID + " || ppID : " + ppID );
specimenCollectionGroupForm.setCollectionProtocolId(cpID);
//Populating the participants registered to a given protocol
loadPaticipants(cpID , bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
String firstName = Utility.toString(cpr.getParticipant().getFirstName());;
String lastName = Utility.toString(cpr.getParticipant().getLastName());
String birthDate = Utility.toString(cpr.getParticipant().getBirthDate());
String ssn = Utility.toString(cpr.getParticipant().getSocialSecurityNumber());
if(firstName.trim().length()>0 || lastName.trim().length()>0 || birthDate.trim().length()>0 || ssn.trim().length()>0)
{
specimenCollectionGroupForm.setParticipantId(pID );
specimenCollectionGroupForm.setCheckedButton(1);
}
//Populating the protocol participants id registered to a given protocol
else if(cpr.getProtocolParticipantIdentifier() != null)
{
specimenCollectionGroupForm.setProtocolParticipantIdentifier(ppID );
specimenCollectionGroupForm.setCheckedButton(2);
}
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Load Clinical status for a given study calander event point
calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(isOnChange && !calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
}
}
request.setAttribute(Constants.SUBMITTED_FOR, "Default");
}
//************* ForwardTo implementation *************
HashMap forwardToHashMap=(HashMap)request.getAttribute("forwardToHashMap");
if(forwardToHashMap !=null)
{
Long collectionProtocolId = (Long)forwardToHashMap.get("collectionProtocolId");
if(collectionProtocolId == null && request.getParameter("cpId") != null && !request.getParameter("cpId").equals("null"))
{
collectionProtocolId = new Long(request.getParameter("cpId"));
}
Long participantId=(Long)forwardToHashMap.get("participantId");
String participantProtocolId = (String) forwardToHashMap.get("participantProtocolId");
specimenCollectionGroupForm.setCollectionProtocolId(collectionProtocolId.longValue());
if(participantId != null && participantId.longValue() != 0)
{
//Populating the participants registered to a given protocol
loadPaticipants(collectionProtocolId.longValue(), bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
specimenCollectionGroupForm.setParticipantId(participantId.longValue());
specimenCollectionGroupForm.setCheckedButton(1);
request.setAttribute(Constants.CP_SEARCH_PARTICIPANT_ID,participantId.toString());
}
else if(participantProtocolId != null)
{
//Populating the participants registered to a given protocol
loadPaticipants(collectionProtocolId.longValue(), bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
specimenCollectionGroupForm.setProtocolParticipantIdentifier(participantProtocolId);
specimenCollectionGroupForm.setCheckedButton(2);
String cpParticipantId = getParticipantIdForProtocolId(participantProtocolId,bizLogic);
if(cpParticipantId != null)
{
request.setAttribute(Constants.CP_SEARCH_PARTICIPANT_ID,cpParticipantId);
}
}
//Bug 1915:SpecimenCollectionGroup.Study Calendar Event Point not populated when page is loaded through proceedTo
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Load Clinical status for a given study calander event point
calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(!calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
Logger.out.debug("CollectionProtocolID found in forwardToHashMap========>>>>>>"+collectionProtocolId);
Logger.out.debug("ParticipantID found in forwardToHashMap========>>>>>>"+participantId);
Logger.out.debug("ParticipantProtocolID found in forwardToHashMap========>>>>>>"+participantProtocolId);
}
//************* ForwardTo implementation *************
//Populate the group name field with default value in the form of
//<Collection Protocol Name>_<Participant ID>_<Group Id>
int groupNumber=bizLogic.getNextGroupNumber();
//Get the collection protocol title for the collection protocol Id selected
String collectionProtocolTitle = "";
list = bizLogic.retrieve(CollectionProtocol.class.getName(),valueField,new Long(specimenCollectionGroupForm.getCollectionProtocolId()));
if(!list.isEmpty())
{
CollectionProtocol collectionProtocol = (CollectionProtocol)list.get(0);
collectionProtocolTitle=collectionProtocol.getTitle();
}
long groupParticipantId = specimenCollectionGroupForm.getParticipantId();
//check if the reset name link was clicked
String resetName = request.getParameter(Constants.RESET_NAME);
//Set the name to default if reset name link was clicked or page is loading for first time
//through add link or forward to link
if(forwardToHashMap !=null || (specimenCollectionGroupForm.getName()!=null && specimenCollectionGroupForm.getName().equals(""))
|| (resetName!=null && resetName.equals("Yes")))
{
if(!collectionProtocolTitle.equals("")&& (groupParticipantId>0 ||
(protocolParticipantId!=null && !protocolParticipantId.equals(""))))
{
//Poornima:Bug 2833 - Error thrown when adding a specimen collection group
//Max length of CP is 150 and Max length of SCG is 55, in Oracle the name does not truncate
//and it is giving error. So the title is truncated in case it is longer than 30 .
String maxCollTitle = collectionProtocolTitle;
if(collectionProtocolTitle.length()>30)
{
maxCollTitle = collectionProtocolTitle.substring(0,29);
}
//During add operation the id to set in the default name is generated
if(operation.equals(Constants.ADD))
{
//if participant is selected from the list
if(groupParticipantId>0)
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+groupNumber);
}
//else if participant protocol Id is selected
else
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+groupNumber);
}
}
//During edit operation the id to set in the default name using the id
else if(operation.equals(Constants.EDIT) && (resetName!=null && resetName.equals("Yes")))
{
if(groupParticipantId>0)
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+
specimenCollectionGroupForm.getId());
}
else
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+protocolParticipantId+"_"+
specimenCollectionGroupForm.getId());
}
}
}
}
request.setAttribute(Constants.PAGEOF,pageOf);
Logger.out.debug("page of in Specimen coll grp action:"+request.getParameter(Constants.PAGEOF));
// -------called from Collection Protocol Registration end -------------------------------
return mapping.findForward(pageOf);
}
private void loadPaticipants(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String [] displayParticipantFields = {"participant.id"};
String valueField = "participant."+Constants.SYSTEM_IDENTIFIER;
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER,"participant.id"};
String whereColumnCondition[];
Object[] whereColumnValue;
if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
{
whereColumnCondition = new String[]{"=","is not"};
whereColumnValue=new Object[]{new Long(protocolID),null};
}
else
{
// for ORACLE
whereColumnCondition = new String[]{"=",Constants.IS_NOT_NULL};
whereColumnValue=new Object[]{new Long(protocolID),""};
}
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = ", ";
List list = bizLogic.getList(sourceObjectName, displayParticipantFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, true);
//get list of Participant's names
valueField = Constants.SYSTEM_IDENTIFIER;
sourceObjectName = Participant.class.getName();
String[] participantsFields = {"lastName","firstName","birthDate","socialSecurityNumber"};
String[] whereColumnName2 = {"lastName","firstName","birthDate","socialSecurityNumber"};
String[] whereColumnCondition2 = {"!=","!=","is not","is not"};
Object[] whereColumnValue2 = {"","",null,null};
if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
{
whereColumnCondition2 = new String[]{"!=","!=","is not","is not"};
whereColumnValue2=new String[]{"","",null,null};
}
else
{
// for ORACLE
whereColumnCondition2 = new String[]{Constants.IS_NOT_NULL,Constants.IS_NOT_NULL,Constants.IS_NOT_NULL,Constants.IS_NOT_NULL};
whereColumnValue2=new String[]{"","","",""};
}
String joinCondition2 = Constants.OR_JOIN_CONDITION;
String separatorBetweenFields2 = ", ";
List listOfParticipants = bizLogic.getList(sourceObjectName, participantsFields, valueField, whereColumnName2,
whereColumnCondition2, whereColumnValue2, joinCondition2, separatorBetweenFields, false);
// removing blank participants from the list of Participants
list=removeBlankParticipant(list, listOfParticipants);
//Mandar bug id:1628 :- sort participant dropdown list
Collections.sort(list );
Logger.out.debug("Paticipants List"+list);
request.setAttribute(Constants.PARTICIPANT_LIST, list);
}
private List removeBlankParticipant(List list, List listOfParticipants)
{
List listOfActiveParticipant=new ArrayList();
for(int i=0; i<list.size(); i++)
{
NameValueBean nameValueBean =(NameValueBean)list.get(i);
if(Long.parseLong(nameValueBean.getValue()) == -1)
{
listOfActiveParticipant.add(list.get(i));
continue;
}
for(int j=0; j<listOfParticipants.size(); j++)
{
if(Long.parseLong(((NameValueBean)listOfParticipants.get(j)).getValue()) == -1)
continue;
NameValueBean participantsBean = (NameValueBean)listOfParticipants.get(j);
if( nameValueBean.getValue().equals(participantsBean.getValue()) )
{
listOfActiveParticipant.add(listOfParticipants.get(j));
break;
}
}
}
Logger.out.debug("No.Of Active Participants Registered with Protocol~~~~~~~~~~~~~~~~~~~~~~~>"+listOfActiveParticipant.size());
return listOfActiveParticipant;
}
private void loadPaticipantNumberList(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String displayParticipantNumberFields[] = {"protocolParticipantIdentifier"};
String valueField = "protocolParticipantIdentifier";
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER, "protocolParticipantIdentifier"};
String whereColumnCondition[];// = {"=","!="};
Object[] whereColumnValue;// = {new Long(protocolID),"null"};
// if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
// {
whereColumnCondition = new String[]{"=","!="};
whereColumnValue = new Object[]{new Long(protocolID),"null"};
// }
// else
// {
// whereColumnCondition = new String[]{"=","!=null"};
// whereColumnValue = new Object[]{new Long(protocolID),""};
// }
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayParticipantNumberFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, true);
Logger.out.debug("Paticipant Number List"+list);
request.setAttribute(Constants.PROTOCOL_PARTICIPANT_NUMBER_LIST, list);
}
private void loadCollectionProtocolEvent(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
String sourceObjectName = CollectionProtocolEvent.class.getName();
String displayEventFields[] = {"studyCalendarEventPoint"};
String valueField = "id";
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER};
String whereColumnCondition[] = {"="};
Object[] whereColumnValue = {new Long(protocolID)};
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayEventFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, false);
request.setAttribute(Constants.STUDY_CALENDAR_EVENT_POINT_LIST, list);
}
private void loadParticipantMedicalIdentifier(long participantID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = ParticipantMedicalIdentifier.class.getName();
String displayEventFields[] = {"medicalRecordNumber"};
String valueField = Constants.SYSTEM_IDENTIFIER;
String whereColumnName[] = {"participant."+Constants.SYSTEM_IDENTIFIER, "medicalRecordNumber"};
String whereColumnCondition[] = {"=","!="};
Object[] whereColumnValue = {new Long(participantID),"null"};
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayEventFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, false);
request.setAttribute(Constants.PARTICIPANT_MEDICAL_IDNETIFIER_LIST, list);
}
private String getParticipantIdForProtocolId(String participantProtocolId,IBizLogic bizLogic) throws Exception
{
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String selectColumnName[] = {"participant.id"};
String whereColumnName[] = {"protocolParticipantIdentifier"};
String whereColumnCondition[] = {"="};
Object[] whereColumnValue = {participantProtocolId};
List participantList = bizLogic.retrieve(sourceObjectName,selectColumnName,whereColumnName,whereColumnCondition,whereColumnValue,Constants.AND_JOIN_CONDITION);
if(participantList != null && !participantList.isEmpty())
{
String participantId = ((Long) participantList.get(0)).toString();
return participantId;
}
return null;
}
//Consent Tracking Virender Mehta
/**
* @param idOfSelectedRadioButton Id for selected radio button.
* @param cp_id CollectionProtocolID CollectionProtocolID selected by dropdown
* @param indexType i.e Which Radio button is selected participantId or protocolParticipantIdentifier
* @return collectionProtocolRegistration CollectionProtocolRegistration object
*/
private CollectionProtocolRegistration getcollectionProtocolRegistrationObj(String idOfSelectedRadioButton,String cp_id,String indexType) throws DAOException
{
CollectionProtocolRegistrationBizLogic collectionProtocolRegistrationBizLogic = (CollectionProtocolRegistrationBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.COLLECTION_PROTOCOL_REGISTRATION_FORM_ID);
String[] colName= new String[2];
if(indexType.equalsIgnoreCase("participantId"))
{
colName[0] = "participant.id";
colName[1] = "collectionProtocol.id";
}
else
{
colName[0] = "protocolParticipantIdentifier";
colName[1] = "collectionProtocol.id";
}
String[] colCondition = {"=","="};
String[] val = new String[2];
val[0]= idOfSelectedRadioButton;
val[1]= cp_id;
List collProtRegObj=collectionProtocolRegistrationBizLogic.retrieve(CollectionProtocolRegistration.class.getName(), colName, colCondition,val,null);
CollectionProtocolRegistration collectionProtocolRegistration = (CollectionProtocolRegistration)collProtRegObj.get(0);
return collectionProtocolRegistration;
}
/**
* For ConsentTracking Preparing consentResponseForScgValues for populating Dynamic contents on the UI
* @param partiResponseCollection This Containes the collection of ConsentTier Response at CPR level
* @param statusResponseCollection This Containes the collection of ConsentTier Response at Specimen level
* @return tempMap
*/
private Map prepareSCGResponseMap(Collection statusResponseCollection, Collection partiResponseCollection)
{
Map tempMap = new HashMap();
Long consentTierID;
Long consentID;
if(partiResponseCollection!=null ||statusResponseCollection!=null)
{
int i = 0;
Iterator statusResponsIter = statusResponseCollection.iterator();
while(statusResponsIter.hasNext())
{
ConsentTierStatus consentTierstatus=(ConsentTierStatus)statusResponsIter.next();
consentTierID=consentTierstatus.getConsentTier().getId();
Iterator participantResponseIter = partiResponseCollection.iterator();
while(participantResponseIter.hasNext())
{
ConsentTierResponse consentTierResponse=(ConsentTierResponse)participantResponseIter.next();
consentID=consentTierResponse.getConsentTier().getId();
if(consentTierID.longValue()==consentID.longValue())
{
ConsentTier consent = consentTierResponse.getConsentTier();
String idKey="ConsentBean:"+i+"_consentTierID";
String statementKey="ConsentBean:"+i+"_statement";
String participantResponsekey = "ConsentBean:"+i+"_participantResponse";
String participantResponceIdKey="ConsentBean:"+i+"_participantResponseID";
String scgResponsekey = "ConsentBean:"+i+"_specimenCollectionGroupLevelResponse";
String scgResponseIDkey ="ConsentBean:"+i+"_specimenCollectionGroupLevelResponseID";
tempMap.put(idKey, consent.getId());
tempMap.put(statementKey,consent.getStatement());
tempMap.put(participantResponsekey, consentTierResponse.getResponse());
tempMap.put(participantResponceIdKey, consentTierResponse.getId());
tempMap.put(scgResponsekey, consentTierstatus.getStatus());
tempMap.put(scgResponseIDkey, consentTierstatus.getId());
i++;
break;
}
}
}
return tempMap;
}
else
{
return null;
}
}
/**
* Prepare Map for Consent tiers
* @param participantResponseList This list will be iterated to map to populate participant Response status.
* @return tempMap
*/
private Map prepareConsentMap(List participantResponseList)
{
Map tempMap = new HashMap();
if(participantResponseList!=null)
{
int i = 0;
Iterator consentResponseCollectionIter = participantResponseList.iterator();
while(consentResponseCollectionIter.hasNext())
{
ConsentTierResponse consentTierResponse = (ConsentTierResponse)consentResponseCollectionIter.next();
ConsentTier consent = consentTierResponse.getConsentTier();
String idKey="ConsentBean:"+i+"_consentTierID";
String statementKey="ConsentBean:"+i+"_statement";
String responseKey="ConsentBean:"+i+"_participantResponse";
String participantResponceIdKey="ConsentBean:"+i+"_participantResponseID";
String scgResponsekey = "ConsentBean:"+i+"_specimenCollectionGroupLevelResponse";
String scgResponseIDkey ="ConsentBean:"+i+"_specimenCollectionGroupLevelResponseID";
tempMap.put(idKey, consent.getId());
tempMap.put(statementKey,consent.getStatement());
tempMap.put(responseKey,consentTierResponse.getResponse());
tempMap.put(participantResponceIdKey, consentTierResponse.getId());
tempMap.put(scgResponsekey, consentTierResponse.getResponse());
tempMap.put(scgResponseIDkey,null);
i++;
}
}
return tempMap;
}
/**
* This function will return CollectionProtocolRegistration object
* @param scg_id Selected SpecimenCollectionGroup ID
* @return collectionProtocolRegistration
*/
private SpecimenCollectionGroup getSCGObj(String scg_id) throws DAOException
{
SpecimenCollectionGroupBizLogic specimenCollectionBizLogic = (SpecimenCollectionGroupBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.SPECIMEN_COLLECTION_GROUP_FORM_ID);
String colName = "id";
List getSCGIdFromDB = specimenCollectionBizLogic.retrieve(SpecimenCollectionGroup.class.getName(), colName, scg_id);
SpecimenCollectionGroup specimenCollectionGroupObject = (SpecimenCollectionGroup)getSCGIdFromDB.get(0);
return specimenCollectionGroupObject;
}
//Consent Tracking Virender Mehta
}
| WEB-INF/src/edu/wustl/catissuecore/action/SpecimenCollectionGroupAction.java | /**
* <p>Title: SpecimenCollectionGroupAction Class>
* <p>Description: SpecimenCollectionGroupAction initializes the fields in the
* New Specimen Collection Group page.</p>
* Copyright: Copyright (c) year
* Company: Washington University, School of Medicine, St. Louis.
* @author Ajay Sharma
* @version 1.00
*/
package edu.wustl.catissuecore.action;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.struts.Globals;
import org.apache.struts.action.ActionErrors;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import edu.wustl.catissuecore.actionForm.SpecimenCollectionGroupForm;
import edu.wustl.catissuecore.bizlogic.BizLogicFactory;
import edu.wustl.catissuecore.bizlogic.CollectionProtocolBizLogic;
import edu.wustl.catissuecore.bizlogic.CollectionProtocolRegistrationBizLogic;
import edu.wustl.catissuecore.bizlogic.SpecimenCollectionGroupBizLogic;
import edu.wustl.catissuecore.domain.CollectionProtocol;
import edu.wustl.catissuecore.domain.CollectionProtocolEvent;
import edu.wustl.catissuecore.domain.CollectionProtocolRegistration;
import edu.wustl.catissuecore.domain.ConsentTier;
import edu.wustl.catissuecore.domain.ConsentTierResponse;
import edu.wustl.catissuecore.domain.ConsentTierStatus;
import edu.wustl.catissuecore.domain.Participant;
import edu.wustl.catissuecore.domain.ParticipantMedicalIdentifier;
import edu.wustl.catissuecore.domain.Site;
import edu.wustl.catissuecore.domain.SpecimenCollectionGroup;
import edu.wustl.catissuecore.domain.User;
import edu.wustl.catissuecore.util.global.Constants;
import edu.wustl.catissuecore.util.global.Utility;
import edu.wustl.catissuecore.util.global.Variables;
import edu.wustl.common.action.SecureAction;
import edu.wustl.common.beans.NameValueBean;
import edu.wustl.common.bizlogic.CDEBizLogic;
import edu.wustl.common.bizlogic.IBizLogic;
import edu.wustl.common.cde.CDE;
import edu.wustl.common.cde.CDEManager;
import edu.wustl.common.util.dbManager.DAOException;
import edu.wustl.common.util.logger.Logger;
/**
* SpecimenCollectionGroupAction initializes the fields in the
* New Specimen Collection Group page.
* @author ajay_sharma
*/
public class SpecimenCollectionGroupAction extends SecureAction
{
/**
* Overrides the execute method of Action class.
*/
public ActionForward executeSecureAction(ActionMapping mapping, ActionForm form,
HttpServletRequest request, HttpServletResponse response) throws Exception
{
SpecimenCollectionGroupForm specimenCollectionGroupForm = (SpecimenCollectionGroupForm)form;
Logger.out.debug("SCGA : " + specimenCollectionGroupForm.getId() );
// set the menu selection
request.setAttribute(Constants.MENU_SELECTED, "14" );
//pageOf and operation attributes required for Advance Query Object view.
String pageOf = request.getParameter(Constants.PAGEOF);
//Gets the value of the operation parameter.
String operation = (String)request.getParameter(Constants.OPERATION);
//Sets the operation attribute to be used in the Edit/View Specimen Collection Group Page in Advance Search Object View.
request.setAttribute(Constants.OPERATION,operation);
if(operation.equalsIgnoreCase(Constants.ADD ) )
{
specimenCollectionGroupForm.setId(0);
Logger.out.debug("SCGA : set to 0 "+ specimenCollectionGroupForm.getId() );
}
boolean isOnChange = false;
String str = request.getParameter("isOnChange");
if(str!=null)
{
if(str.equals("true"))
isOnChange = true;
}
//For Consent Tracking Virender Mehta
int index=1;
String id=null;
String indexType=null;
String cp_id=String.valueOf(specimenCollectionGroupForm.getCollectionProtocolId());
if(cp_id.equalsIgnoreCase("0"))
{
Map forwardToHashMap = (Map)request.getAttribute("forwardToHashMap");
if(forwardToHashMap!=null)
{
cp_id=forwardToHashMap.get("collectionProtocolId").toString();
id=forwardToHashMap.get("participantId").toString();
indexType="participantId";
if(id==null||id.equalsIgnoreCase("0"))
{
id=forwardToHashMap.get("participantProtocolId").toString();
indexType="protocolParticipantIdentifier";
}
}
}
if(!cp_id.equals("-1"))
{
String showConsents = request.getParameter(Constants.SHOW_CONSENTS);
if(showConsents!=null && showConsents.equalsIgnoreCase(Constants.YES))
{
if(id==null)
{
index=(int)specimenCollectionGroupForm.getCheckedButton();
if(index==1)
{
id=Long.toString(specimenCollectionGroupForm.getParticipantId());
indexType="participantId";
}
else
{
id=specimenCollectionGroupForm.getProtocolParticipantIdentifier();
indexType="protocolParticipantIdentifier";
}
}
//If participant and Participant ProtocolIdentifier is not selected
if(!id.equalsIgnoreCase("-1"))
{
//Get CollectionprotocolRegistration Object
CollectionProtocolRegistration collectionProtocolRegistration=getcollectionProtocolRegistrationObj(id,cp_id,indexType);
User witness= collectionProtocolRegistration.getConsentWitness();
if(witness==null||witness.getFirstName()==null)
{
String witnessName="";
specimenCollectionGroupForm.setWitnessName(witnessName);
}
else
{
String witnessFullName = witness.getLastName()+", "+witness.getFirstName();
specimenCollectionGroupForm.setWitnessName(witnessFullName);
}
String getConsentDate=Utility.parseDateToString(collectionProtocolRegistration.getConsentSignatureDate(), Constants.DATE_PATTERN_MM_DD_YYYY);
specimenCollectionGroupForm.setConsentDate(getConsentDate);
String getSignedConsentURL=Utility.toString(collectionProtocolRegistration.getSignedConsentDocumentURL());
specimenCollectionGroupForm.setSignedConsentUrl(getSignedConsentURL);
//Set witnessName,ConsentDate and SignedConsentURL
Set participantResponseSet = (Set)collectionProtocolRegistration.getConsentTierResponseCollection();
List participantResponseList= new ArrayList(participantResponseSet);
if(operation.equalsIgnoreCase(Constants.ADD))
{
ActionErrors errors = (ActionErrors) request.getAttribute(Globals.ERROR_KEY);
if(errors == null)
{
String protocolEventID = request.getParameter("protocolEventId");
if(protocolEventID==null||protocolEventID.equalsIgnoreCase(Constants.FALSE))
{
Map tempMap=prepareConsentMap(participantResponseList);
specimenCollectionGroupForm.setConsentResponseForScgValues(tempMap);
}
}
specimenCollectionGroupForm.setConsentTierCounter(participantResponseList.size());
}
else
{
String scgID = String.valueOf(specimenCollectionGroupForm.getId());
SpecimenCollectionGroup specimenCollectionGroup = getSCGObj(scgID);
Collection consentResponse = specimenCollectionGroup.getCollectionProtocolRegistration().getConsentTierResponseCollection();
Collection consentResponseStatuslevel= specimenCollectionGroup.getConsentTierStatusCollection();
Map tempMap=prepareSCGResponseMap(consentResponseStatuslevel, consentResponse);
specimenCollectionGroupForm.setConsentResponseForScgValues(tempMap);
specimenCollectionGroupForm.setConsentTierCounter(participantResponseList.size());
}
}
List specimenCollectionGroupResponseList =Utility.responceList(operation);
request.setAttribute("specimenCollectionGroupResponseList", specimenCollectionGroupResponseList);
}
}
//For Consent Tracking Virender Mehta
// get list of Protocol title.
SpecimenCollectionGroupBizLogic bizLogic = (SpecimenCollectionGroupBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.SPECIMEN_COLLECTION_GROUP_FORM_ID);
//populating protocolist bean.
String sourceObjectName = CollectionProtocol.class.getName();
String [] displayNameFields = {"title"};
String valueField = Constants.SYSTEM_IDENTIFIER;
List list = bizLogic.getList(sourceObjectName,displayNameFields,valueField, true);
request.setAttribute(Constants.PROTOCOL_LIST, list);
//Populating the Site Type bean
sourceObjectName = Site.class.getName();
String siteDisplaySiteFields[] = {"name"};
list = bizLogic.getList(sourceObjectName,siteDisplaySiteFields,valueField, true);
request.setAttribute(Constants.SITELIST, list);
//Populating the participants registered to a given protocol
loadPaticipants(specimenCollectionGroupForm.getCollectionProtocolId() , bizLogic, request);
//Populating the protocol participants id registered to a given protocol
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
String protocolParticipantId = specimenCollectionGroupForm.getProtocolParticipantIdentifier();
//Populating the participants Medical Identifier for a given participant
loadParticipantMedicalIdentifier(specimenCollectionGroupForm.getParticipantId(),bizLogic, request);
//Load Clinical status for a given study calander event point
List calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(isOnChange && !calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
// populating clinical Diagnosis field
CDE cde = CDEManager.getCDEManager().getCDE(Constants.CDE_NAME_CLINICAL_DIAGNOSIS);
CDEBizLogic cdeBizLogic = (CDEBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.CDE_FORM_ID);
List clinicalDiagnosisList = new ArrayList();
clinicalDiagnosisList.add(new NameValueBean(Constants.SELECT_OPTION,""+Constants.SELECT_OPTION_VALUE));
cdeBizLogic.getFilteredCDE(cde.getPermissibleValues(),clinicalDiagnosisList);
request.setAttribute(Constants.CLINICAL_DIAGNOSIS_LIST, clinicalDiagnosisList);
// populating clinical Status field
// NameValueBean undefinedVal = new NameValueBean(Constants.UNDEFINED,Constants.UNDEFINED);
List clinicalStatusList = CDEManager.getCDEManager().getPermissibleValueList(Constants.CDE_NAME_CLINICAL_STATUS,null);
request.setAttribute(Constants.CLINICAL_STATUS_LIST, clinicalStatusList);
//Sets the activityStatusList attribute to be used in the Site Add/Edit Page.
request.setAttribute(Constants.ACTIVITYSTATUSLIST, Constants.ACTIVITY_STATUS_VALUES);
Logger.out.debug("CP ID in SCG Action======>"+specimenCollectionGroupForm.getCollectionProtocolId());
Logger.out.debug("Participant ID in SCG Action=====>"+specimenCollectionGroupForm.getParticipantId()+" "+specimenCollectionGroupForm.getProtocolParticipantIdentifier());
if( (request.getAttribute(Constants.SUBMITTED_FOR) !=null) &&(request.getAttribute(Constants.SUBMITTED_FOR).equals("Default")))
{
Logger.out.debug("Populating CP and Participant in SCG ==== AddNew operation loop");
Long cprId =new Long(specimenCollectionGroupForm.getCollectionProtocolRegistrationId());
if(cprId != null)
{
List collectionProtocolRegistrationList = bizLogic.retrieve(CollectionProtocolRegistration.class.getName(),
Constants.SYSTEM_IDENTIFIER,cprId);
if(!collectionProtocolRegistrationList.isEmpty())
{
Object obj = collectionProtocolRegistrationList.get(0 );
CollectionProtocolRegistration cpr = (CollectionProtocolRegistration)obj;
long cpID = cpr.getCollectionProtocol().getId().longValue();
long pID = cpr.getParticipant().getId().longValue();
String ppID = cpr.getProtocolParticipantIdentifier();
Logger.out.debug("cpID : "+ cpID + " || pID : " + pID + " || ppID : " + ppID );
specimenCollectionGroupForm.setCollectionProtocolId(cpID);
//Populating the participants registered to a given protocol
loadPaticipants(cpID , bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
String firstName = Utility.toString(cpr.getParticipant().getFirstName());;
String lastName = Utility.toString(cpr.getParticipant().getLastName());
String birthDate = Utility.toString(cpr.getParticipant().getBirthDate());
String ssn = Utility.toString(cpr.getParticipant().getSocialSecurityNumber());
if(firstName.trim().length()>0 || lastName.trim().length()>0 || birthDate.trim().length()>0 || ssn.trim().length()>0)
{
specimenCollectionGroupForm.setParticipantId(pID );
specimenCollectionGroupForm.setCheckedButton(1);
}
//Populating the protocol participants id registered to a given protocol
else if(cpr.getProtocolParticipantIdentifier() != null)
{
specimenCollectionGroupForm.setProtocolParticipantIdentifier(ppID );
specimenCollectionGroupForm.setCheckedButton(2);
}
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Load Clinical status for a given study calander event point
calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(isOnChange && !calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
}
}
request.setAttribute(Constants.SUBMITTED_FOR, "Default");
}
//************* ForwardTo implementation *************
HashMap forwardToHashMap=(HashMap)request.getAttribute("forwardToHashMap");
if(forwardToHashMap !=null)
{
Long collectionProtocolId = (Long)forwardToHashMap.get("collectionProtocolId");
if(collectionProtocolId == null && request.getParameter("cpId") != null && !request.getParameter("cpId").equals("null"))
{
collectionProtocolId = new Long(request.getParameter("cpId"));
}
Long participantId=(Long)forwardToHashMap.get("participantId");
String participantProtocolId = (String) forwardToHashMap.get("participantProtocolId");
specimenCollectionGroupForm.setCollectionProtocolId(collectionProtocolId.longValue());
if(participantId != null && participantId.longValue() != 0)
{
//Populating the participants registered to a given protocol
loadPaticipants(collectionProtocolId.longValue(), bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
specimenCollectionGroupForm.setParticipantId(participantId.longValue());
specimenCollectionGroupForm.setCheckedButton(1);
request.setAttribute(Constants.CP_SEARCH_PARTICIPANT_ID,participantId.toString());
}
else if(participantProtocolId != null)
{
//Populating the participants registered to a given protocol
loadPaticipants(collectionProtocolId.longValue(), bizLogic, request);
loadPaticipantNumberList(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
specimenCollectionGroupForm.setProtocolParticipantIdentifier(participantProtocolId);
specimenCollectionGroupForm.setCheckedButton(2);
String cpParticipantId = getParticipantIdForProtocolId(participantProtocolId,bizLogic);
if(cpParticipantId != null)
{
request.setAttribute(Constants.CP_SEARCH_PARTICIPANT_ID,cpParticipantId);
}
}
//Bug 1915:SpecimenCollectionGroup.Study Calendar Event Point not populated when page is loaded through proceedTo
//Populating the Collection Protocol Events
loadCollectionProtocolEvent(specimenCollectionGroupForm.getCollectionProtocolId(),bizLogic,request);
//Load Clinical status for a given study calander event point
calendarEventPointList = bizLogic.retrieve(CollectionProtocolEvent.class.getName(),
Constants.SYSTEM_IDENTIFIER,
new Long(specimenCollectionGroupForm.getCollectionProtocolEventId()));
if(!calendarEventPointList.isEmpty())
{
CollectionProtocolEvent collectionProtocolEvent = (CollectionProtocolEvent)calendarEventPointList.get(0);
specimenCollectionGroupForm.setClinicalStatus(collectionProtocolEvent.getClinicalStatus());
}
Logger.out.debug("CollectionProtocolID found in forwardToHashMap========>>>>>>"+collectionProtocolId);
Logger.out.debug("ParticipantID found in forwardToHashMap========>>>>>>"+participantId);
Logger.out.debug("ParticipantProtocolID found in forwardToHashMap========>>>>>>"+participantProtocolId);
}
//************* ForwardTo implementation *************
//Populate the group name field with default value in the form of
//<Collection Protocol Name>_<Participant ID>_<Group Id>
int groupNumber=bizLogic.getNextGroupNumber();
//Get the collection protocol title for the collection protocol Id selected
String collectionProtocolTitle = "";
list = bizLogic.retrieve(CollectionProtocol.class.getName(),valueField,new Long(specimenCollectionGroupForm.getCollectionProtocolId()));
if(!list.isEmpty())
{
CollectionProtocol collectionProtocol = (CollectionProtocol)list.get(0);
collectionProtocolTitle=collectionProtocol.getTitle();
}
long groupParticipantId = specimenCollectionGroupForm.getParticipantId();
//check if the reset name link was clicked
String resetName = request.getParameter(Constants.RESET_NAME);
//Set the name to default if reset name link was clicked or page is loading for first time
//through add link or forward to link
if(forwardToHashMap !=null || (specimenCollectionGroupForm.getName()!=null && specimenCollectionGroupForm.getName().equals(""))
|| (resetName!=null && resetName.equals("Yes")))
{
if(!collectionProtocolTitle.equals("")&& (groupParticipantId>0 ||
(protocolParticipantId!=null && !protocolParticipantId.equals(""))))
{
//Poornima:Bug 2833 - Error thrown when adding a specimen collection group
//Max length of CP is 150 and Max length of SCG is 55, in Oracle the name does not truncate
//and it is giving error. So the title is truncated in case it is longer than 30 .
String maxCollTitle = collectionProtocolTitle;
if(collectionProtocolTitle.length()>30)
{
maxCollTitle = collectionProtocolTitle.substring(0,29);
}
//During add operation the id to set in the default name is generated
if(operation.equals(Constants.ADD))
{
//if participant is selected from the list
if(groupParticipantId>0)
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+groupNumber);
}
//else if participant protocol Id is selected
else
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+groupNumber);
}
}
//During edit operation the id to set in the default name using the id
else if(operation.equals(Constants.EDIT) && (resetName!=null && resetName.equals("Yes")))
{
if(groupParticipantId>0)
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+groupParticipantId+"_"+
specimenCollectionGroupForm.getId());
}
else
{
specimenCollectionGroupForm.setName(maxCollTitle+"_"+protocolParticipantId+"_"+
specimenCollectionGroupForm.getId());
}
}
}
}
request.setAttribute(Constants.PAGEOF,pageOf);
Logger.out.debug("page of in Specimen coll grp action:"+request.getParameter(Constants.PAGEOF));
// -------called from Collection Protocol Registration end -------------------------------
return mapping.findForward(pageOf);
}
private void loadPaticipants(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String [] displayParticipantFields = {"participant.id"};
String valueField = "participant."+Constants.SYSTEM_IDENTIFIER;
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER,"participant.id"};
String whereColumnCondition[];
Object[] whereColumnValue;
if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
{
whereColumnCondition = new String[]{"=","is not"};
whereColumnValue=new Object[]{new Long(protocolID),null};
}
else
{
// for ORACLE
whereColumnCondition = new String[]{"=",Constants.IS_NOT_NULL};
whereColumnValue=new Object[]{new Long(protocolID),""};
}
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = ", ";
List list = bizLogic.getList(sourceObjectName, displayParticipantFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, true);
//get list of Participant's names
valueField = Constants.SYSTEM_IDENTIFIER;
sourceObjectName = Participant.class.getName();
String[] participantsFields = {"lastName","firstName","birthDate","socialSecurityNumber"};
String[] whereColumnName2 = {"lastName","firstName","birthDate","socialSecurityNumber"};
String[] whereColumnCondition2 = {"!=","!=","is not","is not"};
Object[] whereColumnValue2 = {"","",null,null};
if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
{
whereColumnCondition2 = new String[]{"!=","!=","is not","is not"};
whereColumnValue2=new String[]{"","",null,null};
}
else
{
// for ORACLE
whereColumnCondition2 = new String[]{Constants.IS_NOT_NULL,Constants.IS_NOT_NULL,Constants.IS_NOT_NULL,Constants.IS_NOT_NULL};
whereColumnValue2=new String[]{"","","",""};
}
String joinCondition2 = Constants.OR_JOIN_CONDITION;
String separatorBetweenFields2 = ", ";
List listOfParticipants = bizLogic.getList(sourceObjectName, participantsFields, valueField, whereColumnName2,
whereColumnCondition2, whereColumnValue2, joinCondition2, separatorBetweenFields, false);
// removing blank participants from the list of Participants
list=removeBlankParticipant(list, listOfParticipants);
//Mandar bug id:1628 :- sort participant dropdown list
Collections.sort(list );
Logger.out.debug("Paticipants List"+list);
request.setAttribute(Constants.PARTICIPANT_LIST, list);
}
private List removeBlankParticipant(List list, List listOfParticipants)
{
List listOfActiveParticipant=new ArrayList();
for(int i=0; i<list.size(); i++)
{
NameValueBean nameValueBean =(NameValueBean)list.get(i);
if(Long.parseLong(nameValueBean.getValue()) == -1)
{
listOfActiveParticipant.add(list.get(i));
continue;
}
for(int j=0; j<listOfParticipants.size(); j++)
{
if(Long.parseLong(((NameValueBean)listOfParticipants.get(j)).getValue()) == -1)
continue;
NameValueBean participantsBean = (NameValueBean)listOfParticipants.get(j);
if( nameValueBean.getValue().equals(participantsBean.getValue()) )
{
listOfActiveParticipant.add(listOfParticipants.get(j));
break;
}
}
}
Logger.out.debug("No.Of Active Participants Registered with Protocol~~~~~~~~~~~~~~~~~~~~~~~>"+listOfActiveParticipant.size());
return listOfActiveParticipant;
}
private void loadPaticipantNumberList(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String displayParticipantNumberFields[] = {"protocolParticipantIdentifier"};
String valueField = "protocolParticipantIdentifier";
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER, "protocolParticipantIdentifier"};
String whereColumnCondition[];// = {"=","!="};
Object[] whereColumnValue;// = {new Long(protocolID),"null"};
// if(Variables.databaseName.equals(Constants.MYSQL_DATABASE))
// {
whereColumnCondition = new String[]{"=","!="};
whereColumnValue = new Object[]{new Long(protocolID),"null"};
// }
// else
// {
// whereColumnCondition = new String[]{"=","!=null"};
// whereColumnValue = new Object[]{new Long(protocolID),""};
// }
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayParticipantNumberFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, true);
Logger.out.debug("Paticipant Number List"+list);
request.setAttribute(Constants.PROTOCOL_PARTICIPANT_NUMBER_LIST, list);
}
private void loadCollectionProtocolEvent(long protocolID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
String sourceObjectName = CollectionProtocolEvent.class.getName();
String displayEventFields[] = {"studyCalendarEventPoint"};
String valueField = "id";
String whereColumnName[] = {"collectionProtocol."+Constants.SYSTEM_IDENTIFIER};
String whereColumnCondition[] = {"="};
Object[] whereColumnValue = {new Long(protocolID)};
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayEventFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, false);
request.setAttribute(Constants.STUDY_CALENDAR_EVENT_POINT_LIST, list);
}
private void loadParticipantMedicalIdentifier(long participantID, IBizLogic bizLogic, HttpServletRequest request) throws Exception
{
//get list of Participant's names
String sourceObjectName = ParticipantMedicalIdentifier.class.getName();
String displayEventFields[] = {"medicalRecordNumber"};
String valueField = Constants.SYSTEM_IDENTIFIER;
String whereColumnName[] = {"participant."+Constants.SYSTEM_IDENTIFIER, "medicalRecordNumber"};
String whereColumnCondition[] = {"=","!="};
Object[] whereColumnValue = {new Long(participantID),"null"};
String joinCondition = Constants.AND_JOIN_CONDITION;
String separatorBetweenFields = "";
List list = bizLogic.getList(sourceObjectName, displayEventFields, valueField, whereColumnName,
whereColumnCondition, whereColumnValue, joinCondition, separatorBetweenFields, false);
request.setAttribute(Constants.PARTICIPANT_MEDICAL_IDNETIFIER_LIST, list);
}
private String getParticipantIdForProtocolId(String participantProtocolId,IBizLogic bizLogic) throws Exception
{
String sourceObjectName = CollectionProtocolRegistration.class.getName();
String selectColumnName[] = {"participant.id"};
String whereColumnName[] = {"protocolParticipantIdentifier"};
String whereColumnCondition[] = {"="};
Object[] whereColumnValue = {participantProtocolId};
List participantList = bizLogic.retrieve(sourceObjectName,selectColumnName,whereColumnName,whereColumnCondition,whereColumnValue,Constants.AND_JOIN_CONDITION);
if(participantList != null && !participantList.isEmpty())
{
String participantId = ((Long) participantList.get(0)).toString();
return participantId;
}
return null;
}
//Consent Tracking Virender Mehta
/**
* @param idOfSelectedRadioButton Id for selected radio button.
* @param cp_id CollectionProtocolID CollectionProtocolID selected by dropdown
* @param indexType i.e Which Radio button is selected participantId or protocolParticipantIdentifier
* @return collectionProtocolRegistration CollectionProtocolRegistration object
*/
private CollectionProtocolRegistration getcollectionProtocolRegistrationObj(String idOfSelectedRadioButton,String cp_id,String indexType) throws DAOException
{
CollectionProtocolRegistrationBizLogic collectionProtocolRegistrationBizLogic = (CollectionProtocolRegistrationBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.COLLECTION_PROTOCOL_REGISTRATION_FORM_ID);
String[] colName= new String[2];
if(indexType.equalsIgnoreCase("participantId"))
{
colName[0] = "participant.id";
colName[1] = "collectionProtocol.id";
}
else
{
colName[0] = "protocolParticipantIdentifier";
colName[1] = "collectionProtocol.id";
}
String[] colCondition = {"=","="};
String[] val = new String[2];
val[0]= idOfSelectedRadioButton;
val[1]= cp_id;
List collProtRegObj=collectionProtocolRegistrationBizLogic.retrieve(CollectionProtocolRegistration.class.getName(), colName, colCondition,val,null);
CollectionProtocolRegistration collectionProtocolRegistration = (CollectionProtocolRegistration)collProtRegObj.get(0);
return collectionProtocolRegistration;
}
/**
* For ConsentTracking Preparing consentResponseForScgValues for populating Dynamic contents on the UI
* @param partiResponseCollection This Containes the collection of ConsentTier Response at CPR level
* @param statusResponseCollection This Containes the collection of ConsentTier Response at Specimen level
* @return tempMap
*/
private Map prepareSCGResponseMap(Collection statusResponseCollection, Collection partiResponseCollection)
{
Map tempMap = new HashMap();
Long consentTierID;
Long consentID;
if(partiResponseCollection!=null ||statusResponseCollection!=null)
{
int i = 0;
Iterator statusResponsIter = statusResponseCollection.iterator();
while(statusResponsIter.hasNext())
{
ConsentTierStatus consentTierstatus=(ConsentTierStatus)statusResponsIter.next();
consentTierID=consentTierstatus.getConsentTier().getId();
Iterator participantResponseIter = partiResponseCollection.iterator();
while(participantResponseIter.hasNext())
{
ConsentTierResponse consentTierResponse=(ConsentTierResponse)participantResponseIter.next();
consentID=consentTierResponse.getConsentTier().getId();
if(consentTierID.longValue()==consentID.longValue())
{
ConsentTier consent = consentTierResponse.getConsentTier();
String idKey="ConsentBean:"+i+"_consentTierID";
String statementKey="ConsentBean:"+i+"_statement";
String participantResponsekey = "ConsentBean:"+i+"_participantResponse";
String participantResponceIdKey="ConsentBean:"+i+"_participantResponseID";
String scgResponsekey = "ConsentBean:"+i+"_specimenCollectionGroupLevelResponse";
String scgResponseIDkey ="ConsentBean:"+i+"_specimenCollectionGroupLevelResponseID";
tempMap.put(idKey, consent.getId());
tempMap.put(statementKey,consent.getStatement());
tempMap.put(participantResponsekey, consentTierResponse.getResponse());
tempMap.put(participantResponceIdKey, consentTierResponse.getId());
tempMap.put(scgResponsekey, consentTierstatus.getStatus());
tempMap.put(scgResponseIDkey, consentTierstatus.getId());
i++;
break;
}
}
}
return tempMap;
}
else
{
return null;
}
}
/**
* Prepare Map for Consent tiers
* @param participantResponseList This list will be iterated to map to populate participant Response status.
* @return tempMap
*/
private Map prepareConsentMap(List participantResponseList)
{
Map tempMap = new HashMap();
if(participantResponseList!=null)
{
int i = 0;
Iterator consentResponseCollectionIter = participantResponseList.iterator();
while(consentResponseCollectionIter.hasNext())
{
ConsentTierResponse consentTierResponse = (ConsentTierResponse)consentResponseCollectionIter.next();
ConsentTier consent = consentTierResponse.getConsentTier();
String idKey="ConsentBean:"+i+"_consentTierID";
String statementKey="ConsentBean:"+i+"_statement";
String responseKey="ConsentBean:"+i+"_participantResponse";
String participantResponceIdKey="ConsentBean:"+i+"_participantResponseID";
tempMap.put(idKey, consent.getId());
tempMap.put(statementKey,consent.getStatement());
tempMap.put(responseKey,consentTierResponse.getResponse());
tempMap.put(participantResponceIdKey, consentTierResponse.getId());
i++;
}
}
return tempMap;
}
/**
* This function will return CollectionProtocolRegistration object
* @param scg_id Selected SpecimenCollectionGroup ID
* @return collectionProtocolRegistration
*/
private SpecimenCollectionGroup getSCGObj(String scg_id) throws DAOException
{
SpecimenCollectionGroupBizLogic specimenCollectionBizLogic = (SpecimenCollectionGroupBizLogic)BizLogicFactory.getInstance().getBizLogic(Constants.SPECIMEN_COLLECTION_GROUP_FORM_ID);
String colName = "id";
List getSCGIdFromDB = specimenCollectionBizLogic.retrieve(SpecimenCollectionGroup.class.getName(), colName, scg_id);
SpecimenCollectionGroup specimenCollectionGroupObject = (SpecimenCollectionGroup)getSCGIdFromDB.get(0);
return specimenCollectionGroupObject;
}
//Consent Tracking Virender Mehta
}
| Solved bug #3777
SVN-Revision: 7255
| WEB-INF/src/edu/wustl/catissuecore/action/SpecimenCollectionGroupAction.java | Solved bug #3777 | <ide><path>EB-INF/src/edu/wustl/catissuecore/action/SpecimenCollectionGroupAction.java
<ide> Map tempMap=prepareSCGResponseMap(consentResponseStatuslevel, consentResponse);
<ide> specimenCollectionGroupForm.setConsentResponseForScgValues(tempMap);
<ide> specimenCollectionGroupForm.setConsentTierCounter(participantResponseList.size());
<del>
<ide> }
<ide> }
<ide> List specimenCollectionGroupResponseList =Utility.responceList(operation);
<ide> String statementKey="ConsentBean:"+i+"_statement";
<ide> String responseKey="ConsentBean:"+i+"_participantResponse";
<ide> String participantResponceIdKey="ConsentBean:"+i+"_participantResponseID";
<del>
<add> String scgResponsekey = "ConsentBean:"+i+"_specimenCollectionGroupLevelResponse";
<add> String scgResponseIDkey ="ConsentBean:"+i+"_specimenCollectionGroupLevelResponseID";
<add>
<ide> tempMap.put(idKey, consent.getId());
<ide> tempMap.put(statementKey,consent.getStatement());
<ide> tempMap.put(responseKey,consentTierResponse.getResponse());
<ide> tempMap.put(participantResponceIdKey, consentTierResponse.getId());
<add> tempMap.put(scgResponsekey, consentTierResponse.getResponse());
<add> tempMap.put(scgResponseIDkey,null);
<ide> i++;
<ide> }
<ide> } |
|
Java | apache-2.0 | d6312c6c86466c1f611a7de5bdb912996cc2fae8 | 0 | osmdroid/osmdroid,osmdroid/osmdroid,osmdroid/osmdroid,osmdroid/osmdroid | package org.osmdroid.config;
import android.content.Context;
import android.content.SharedPreferences;
import android.os.Build;
import android.util.Log;
import org.osmdroid.api.IMapView;
import org.osmdroid.tileprovider.modules.SqlTileWriter;
import org.osmdroid.tileprovider.util.StorageUtils;
import java.io.File;
import java.net.Proxy;
import java.text.SimpleDateFormat;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import static org.osmdroid.tileprovider.constants.OpenStreetMapTileProviderConstants.HTTP_EXPIRES_HEADER_FORMAT;
/**
* Default configuration provider for osmdroid
* <a href="https://github.com/osmdroid/osmdroid/issues/481">Issue 481</a>
* Created on 11/29/2016.
* @author Alex O'Ree
* @see IConfigurationProvider
* @see Configuration
*/
public class DefaultConfigurationProvider implements IConfigurationProvider {
protected long gpsWaitTime =20000;
protected boolean debugMode= false;
protected boolean debugMapView = false;
protected boolean debugTileProviders = false;
protected boolean debugMapTileDownloader=false;
protected boolean isMapViewHardwareAccelerated=true;
protected String userAgentValue="osmdroid";
protected String userAgentHttpHeader = "User-Agent";
private final Map<String, String> mAdditionalHttpRequestProperties = new HashMap<>();
protected short cacheMapTileCount = 9;
protected short tileDownloadThreads = 2;
protected short tileFileSystemThreads = 8;
protected short tileDownloadMaxQueueSize = 40;
protected short tileFileSystemMaxQueueSize = 40;
protected long tileFileSystemCacheMaxBytes = 600L * 1024 * 1024;
protected long tileFileSystemCacheTrimBytes = 500L * 1024 * 1024;
protected SimpleDateFormat httpHeaderDateTimeFormat = new SimpleDateFormat(HTTP_EXPIRES_HEADER_FORMAT, Locale.US);
protected File osmdroidBasePath;
protected File osmdroidTileCache;
protected long expirationAdder = 0;
protected Long expirationOverride=null;
protected Proxy httpProxy=null;
protected int animationSpeedDefault =1000;
protected int animationSpeedShort =500;
protected boolean mapViewRecycler=true;
public DefaultConfigurationProvider(){
}
/**
* default is 20 seconds
* @return time in ms
*/
@Override
public long getGpsWaitTime() {
return gpsWaitTime;
}
@Override
public void setGpsWaitTime(long gpsWaitTime) {
this.gpsWaitTime = gpsWaitTime;
}
@Override
public boolean isDebugMode() {
return debugMode;
}
@Override
public void setDebugMode(boolean debugMode) {
this.debugMode = debugMode;
}
@Override
public boolean isDebugMapView() {
return debugMapView;
}
@Override
public void setDebugMapView(boolean debugMapView) {
this.debugMapView = debugMapView;
}
@Override
public boolean isDebugTileProviders() {
return debugTileProviders;
}
@Override
public void setDebugTileProviders(boolean debugTileProviders) {
this.debugTileProviders = debugTileProviders;
}
@Override
public boolean isDebugMapTileDownloader() {
return debugMapTileDownloader;
}
@Override
public void setDebugMapTileDownloader(boolean debugMapTileDownloader) {
this.debugMapTileDownloader = debugMapTileDownloader;
}
@Override
public boolean isMapViewHardwareAccelerated() {
return isMapViewHardwareAccelerated;
}
@Override
public void setMapViewHardwareAccelerated(boolean mapViewHardwareAccelerated) {
isMapViewHardwareAccelerated = mapViewHardwareAccelerated;
}
@Override
public String getUserAgentValue() {
return userAgentValue;
}
@Override
public void setUserAgentValue(String userAgentValue) {
this.userAgentValue = userAgentValue;
}
@Override
public Map<String, String> getAdditionalHttpRequestProperties() {
return mAdditionalHttpRequestProperties;
}
@Override
public short getCacheMapTileCount() {
return cacheMapTileCount;
}
@Override
public void setCacheMapTileCount(short cacheMapTileCount) {
this.cacheMapTileCount = cacheMapTileCount;
}
@Override
public short getTileDownloadThreads() {
return tileDownloadThreads;
}
@Override
public void setTileDownloadThreads(short tileDownloadThreads) {
this.tileDownloadThreads = tileDownloadThreads;
}
@Override
public short getTileFileSystemThreads() {
return tileFileSystemThreads;
}
@Override
public void setTileFileSystemThreads(short tileFileSystemThreads) {
this.tileFileSystemThreads = tileFileSystemThreads;
}
@Override
public short getTileDownloadMaxQueueSize() {
return tileDownloadMaxQueueSize;
}
@Override
public void setTileDownloadMaxQueueSize(short tileDownloadMaxQueueSize) {
this.tileDownloadMaxQueueSize = tileDownloadMaxQueueSize;
}
@Override
public short getTileFileSystemMaxQueueSize() {
return tileFileSystemMaxQueueSize;
}
@Override
public void setTileFileSystemMaxQueueSize(short tileFileSystemMaxQueueSize) {
this.tileFileSystemMaxQueueSize = tileFileSystemMaxQueueSize;
}
@Override
public long getTileFileSystemCacheMaxBytes() {
return tileFileSystemCacheMaxBytes;
}
@Override
public void setTileFileSystemCacheMaxBytes(long tileFileSystemCacheMaxBytes) {
this.tileFileSystemCacheMaxBytes = tileFileSystemCacheMaxBytes;
}
@Override
public long getTileFileSystemCacheTrimBytes() {
return tileFileSystemCacheTrimBytes;
}
@Override
public void setTileFileSystemCacheTrimBytes(long tileFileSystemCacheTrimBytes) {
this.tileFileSystemCacheTrimBytes = tileFileSystemCacheTrimBytes;
}
@Override
public SimpleDateFormat getHttpHeaderDateTimeFormat() {
return httpHeaderDateTimeFormat;
}
@Override
public void setHttpHeaderDateTimeFormat(SimpleDateFormat httpHeaderDateTimeFormat) {
this.httpHeaderDateTimeFormat = httpHeaderDateTimeFormat;
}
@Override
public Proxy getHttpProxy() {
return httpProxy;
}
@Override
public void setHttpProxy(Proxy httpProxy) {
this.httpProxy = httpProxy;
}
@Override
public File getOsmdroidBasePath() {
if (osmdroidBasePath==null)
osmdroidBasePath = new File(StorageUtils.getStorage().getAbsolutePath(), "osmdroid");
try {
osmdroidBasePath.mkdirs();
}catch (Exception ex){
Log.d(IMapView.LOGTAG, "Unable to create base path at " + osmdroidBasePath.getAbsolutePath(), ex);
//IO/permissions issue
//trap for android studio layout editor and some for certain devices
//see https://github.com/osmdroid/osmdroid/issues/508
}
return osmdroidBasePath;
}
@Override
public void setOsmdroidBasePath(File osmdroidBasePath) {
this.osmdroidBasePath = osmdroidBasePath;
}
@Override
public File getOsmdroidTileCache() {
if (osmdroidTileCache==null)
osmdroidTileCache = new File(getOsmdroidBasePath(), "tiles");
try {
osmdroidTileCache.mkdirs();
}catch (Exception ex){
Log.d(IMapView.LOGTAG, "Unable to create tile cache path at " + osmdroidTileCache.getAbsolutePath(), ex);
//IO/permissions issue
//trap for android studio layout editor and some for certain devices
//see https://github.com/osmdroid/osmdroid/issues/508
}
return osmdroidTileCache;
}
@Override
public void setOsmdroidTileCache(File osmdroidTileCache) {
this.osmdroidTileCache = osmdroidTileCache;
}
@Override
public String getUserAgentHttpHeader() {
return userAgentHttpHeader;
}
@Override
public void setUserAgentHttpHeader(String userAgentHttpHeader) {
this.userAgentHttpHeader = userAgentHttpHeader;
}
//</editor-fold>
@Override
public void load(Context ctx, SharedPreferences prefs) {
//cache management starts here
//check to see if the shared preferences is set for the tile cache
if (!prefs.contains("osmdroid.basePath")){
//this is the first time startup. run the discovery bit
File discoveredBestPath = getOsmdroidBasePath();
File discoveredCachPath = getOsmdroidTileCache();
if (!discoveredBestPath.exists() || !StorageUtils.isWritable(discoveredBestPath)) {
//this should always be writable...
discoveredCachPath=discoveredBestPath=new File("/data/data/" + ctx.getPackageName() + "/osmdroid/");
discoveredCachPath.mkdirs();
}
SharedPreferences.Editor edit = prefs.edit();
edit.putString("osmdroid.basePath",discoveredBestPath.getAbsolutePath());
edit.putString("osmdroid.cachePath",discoveredCachPath.getAbsolutePath());
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
edit.apply();
} else {
edit.commit();
}
setOsmdroidBasePath(discoveredBestPath);
setOsmdroidTileCache(discoveredCachPath);
setUserAgentValue(ctx.getPackageName());
save(ctx,prefs);
} else {
//normal startup, load user preferences and populate the config object
setOsmdroidBasePath(new File(prefs.getString("osmdroid.basePath", getOsmdroidBasePath().getAbsolutePath())));
setOsmdroidTileCache(new File(prefs.getString("osmdroid.cachePath", getOsmdroidTileCache().getAbsolutePath())));
setDebugMode(prefs.getBoolean("osmdroid.DebugMode",false));
setDebugMapTileDownloader(prefs.getBoolean("osmdroid.DebugDownloading", false));
setDebugMapView(prefs.getBoolean("osmdroid.DebugMapView", false));
setDebugTileProviders(prefs.getBoolean("osmdroid.DebugTileProvider",false));
setMapViewHardwareAccelerated(prefs.getBoolean("osmdroid.HardwareAcceleration",true));
setUserAgentValue(prefs.getString("osmdroid.userAgentValue",ctx.getPackageName()));
load(prefs, mAdditionalHttpRequestProperties, "osmdroid.additionalHttpRequestProperty.");
setGpsWaitTime(prefs.getLong("osmdroid.gpsWaitTime", gpsWaitTime));
setTileDownloadThreads((short)(prefs.getInt("osmdroid.tileDownloadThreads",tileDownloadThreads)));
setTileFileSystemThreads((short)(prefs.getInt("osmdroid.tileFileSystemThreads",tileFileSystemThreads)));
setTileDownloadMaxQueueSize((short)(prefs.getInt("osmdroid.tileDownloadMaxQueueSize",tileDownloadMaxQueueSize)));
setTileFileSystemMaxQueueSize((short)(prefs.getInt("osmdroid.tileFileSystemMaxQueueSize",tileFileSystemMaxQueueSize)));
setExpirationExtendedDuration((long)prefs.getLong("osmdroid.ExpirationExtendedDuration", expirationAdder));
setMapViewRecyclerFriendly((boolean)prefs.getBoolean("osmdroid.mapViewRecycler", mapViewRecycler));
setAnimationSpeedDefault(prefs.getInt("osmdroid.ZoomSpeedDefault", animationSpeedDefault));
setAnimationSpeedShort(prefs.getInt("osmdroid.animationSpeedShort", animationSpeedShort));
if (prefs.contains("osmdroid.ExpirationOverride")) {
expirationOverride = prefs.getLong("osmdroid.ExpirationOverride",-1);
if (expirationOverride!=null && expirationOverride==-1)
expirationOverride=null;
}
}
if (Build.VERSION.SDK_INT >= 9) {
//unfortunately API 8 doesn't support File.length()
//https://github/osmdroid/osmdroid/issues/435
//On startup, we auto set the max cache size to be the current cache size + free disk space
//this reduces the chance of osmdroid completely filling up the storage device
//if the default max cache size is greater than the available free space
//reduce it to 95% of the available free space + the size of the cache
long cacheSize = 0;
File dbFile = new File(getOsmdroidTileCache().getAbsolutePath() + File.separator + SqlTileWriter.DATABASE_FILENAME);
if (dbFile.exists()) {
cacheSize = dbFile.length();
}
long freeSpace = getOsmdroidTileCache().getFreeSpace();
//Log.i(TAG, "Current cache size is " + cacheSize + " free space is " + freeSpace);
if (getTileFileSystemCacheMaxBytes() > (freeSpace + cacheSize)){
setTileFileSystemCacheMaxBytes((long)((freeSpace + cacheSize) * 0.95));
setTileFileSystemCacheTrimBytes((long)((freeSpace + cacheSize) * 0.90));
}
}
}
@Override
public void save(Context ctx, SharedPreferences prefs) {
SharedPreferences.Editor edit = prefs.edit();
edit.putString("osmdroid.basePath",getOsmdroidBasePath().getAbsolutePath());
edit.putString("osmdroid.cachePath",getOsmdroidTileCache().getAbsolutePath());
edit.putBoolean("osmdroid.DebugMode",isDebugMode());
edit.putBoolean("osmdroid.DebugDownloading",isDebugMapTileDownloader());
edit.putBoolean("osmdroid.DebugMapView",isDebugMapView());
edit.putBoolean("osmdroid.DebugTileProvider",isDebugTileProviders());
edit.putBoolean("osmdroid.HardwareAcceleration", isMapViewHardwareAccelerated());
edit.putString("osmdroid.userAgentValue", getUserAgentValue());
save(prefs, edit, mAdditionalHttpRequestProperties, "osmdroid.additionalHttpRequestProperty.");
edit.putLong("osmdroid.gpsWaitTime",gpsWaitTime);
edit.putInt("osmdroid.cacheMapTileCount", cacheMapTileCount);
edit.putInt("osmdroid.tileDownloadThreads", tileDownloadThreads);
edit.putInt("osmdroid.tileFileSystemThreads",tileFileSystemThreads);
edit.putInt("osmdroid.tileDownloadMaxQueueSize",tileDownloadMaxQueueSize);
edit.putInt("osmdroid.tileFileSystemMaxQueueSize",tileFileSystemMaxQueueSize);
edit.putLong("osmdroid.ExpirationExtendedDuration",expirationAdder);
if (expirationOverride!=null)
edit.putLong("osmdroid.ExpirationOverride",expirationOverride);
//TODO save other fields?
edit.putInt("osmdroid.ZoomSpeedDefault", animationSpeedDefault);
edit.putInt("osmdroid.animationSpeedShort", animationSpeedShort);
edit.putBoolean("osmdroid.mapViewRecycler", mapViewRecycler);
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
edit.apply();
} else {
edit.commit();
} }
/**
* Loading a map from preferences, using a prefix for the prefs keys
*
* @since 5.6.5
* @param pPrefs
* @param pMap
* @param pPrefix
*/
private static void load(final SharedPreferences pPrefs,
final Map<String, String> pMap, final String pPrefix) {
pMap.clear();
for (final String key : pPrefs.getAll().keySet()) {
if (key.startsWith(pPrefix)) {
pMap.put(key.substring(pPrefix.length()), pPrefs.getString(key, null));
}
}
}
/**
* Saving a map into preferences, using a prefix for the prefs keys
*
* @since 5.6.5
* @param pPrefs
* @param pEdit
* @param pMap
* @param pPrefix
*/
private static void save(final SharedPreferences pPrefs, final SharedPreferences.Editor pEdit,
final Map<String, String> pMap, final String pPrefix) {
for (final String key : pPrefs.getAll().keySet()) {
if (key.startsWith(pPrefix)) {
pEdit.remove(key);
}
}
for (final Map.Entry<String, String> entry : pMap.entrySet()) {
final String key = pPrefix + entry.getKey();
pEdit.putString(key, entry.getValue());
}
}
@Override
public long getExpirationExtendedDuration() {
return expirationAdder ;
}
@Override
public void setExpirationExtendedDuration(final long period) {
if (period < 0)
expirationAdder=0;
else
expirationAdder=period;
}
@Override
public void setExpirationOverrideDuration(Long period) {
expirationOverride=period;
}
@Override
public Long getExpirationOverrideDuration() {
return expirationOverride;
}
@Override
public void setAnimationSpeedDefault(int durationsMilliseconds) {
this.animationSpeedDefault =durationsMilliseconds;
}
@Override
public int getAnimationSpeedDefault() {
return animationSpeedDefault;
}
@Override
public void setAnimationSpeedShort(int durationsMilliseconds) {
this.animationSpeedShort = durationsMilliseconds;
}
@Override
public int getAnimationSpeedShort() {
return animationSpeedShort;
}
@Override
public boolean isMapViewRecyclerFriendly() {
return mapViewRecycler;
}
@Override
public void setMapViewRecyclerFriendly(boolean enabled) {
this.mapViewRecycler=enabled;
}
}
| osmdroid-android/src/main/java/org/osmdroid/config/DefaultConfigurationProvider.java | package org.osmdroid.config;
import android.content.Context;
import android.content.SharedPreferences;
import android.os.Build;
import android.util.Log;
import org.osmdroid.api.IMapView;
import org.osmdroid.tileprovider.modules.SqlTileWriter;
import org.osmdroid.tileprovider.util.StorageUtils;
import java.io.File;
import java.net.Proxy;
import java.text.SimpleDateFormat;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import static org.osmdroid.tileprovider.constants.OpenStreetMapTileProviderConstants.HTTP_EXPIRES_HEADER_FORMAT;
/**
* Default configuration provider for osmdroid
* <a href="https://github.com/osmdroid/osmdroid/issues/481">Issue 481</a>
* Created on 11/29/2016.
* @author Alex O'Ree
* @see IConfigurationProvider
* @see Configuration
*/
public class DefaultConfigurationProvider implements IConfigurationProvider {
protected long gpsWaitTime =20000;
protected boolean debugMode= false;
protected boolean debugMapView = false;
protected boolean debugTileProviders = false;
protected boolean debugMapTileDownloader=false;
protected boolean isMapViewHardwareAccelerated=true;
protected String userAgentValue="osmdroid";
protected String userAgentHttpHeader = "User-Agent";
private final Map<String, String> mAdditionalHttpRequestProperties = new HashMap<>();
protected short cacheMapTileCount = 9;
protected short tileDownloadThreads = 2;
protected short tileFileSystemThreads = 8;
protected short tileDownloadMaxQueueSize = 40;
protected short tileFileSystemMaxQueueSize = 40;
protected long tileFileSystemCacheMaxBytes = 600L * 1024 * 1024;
protected long tileFileSystemCacheTrimBytes = 500L * 1024 * 1024;
protected SimpleDateFormat httpHeaderDateTimeFormat = new SimpleDateFormat(HTTP_EXPIRES_HEADER_FORMAT, Locale.US);
protected File osmdroidBasePath;
protected File osmdroidTileCache;
protected long expirationAdder = 0;
protected Long expirationOverride=null;
protected Proxy httpProxy=null;
protected int animationSpeedDefault =1000;
protected int animationSpeedShort =500;
protected boolean mapViewRecycler=true;
public DefaultConfigurationProvider(){
}
/**
* default is 20 seconds
* @return time in ms
*/
@Override
public long getGpsWaitTime() {
return gpsWaitTime;
}
@Override
public void setGpsWaitTime(long gpsWaitTime) {
this.gpsWaitTime = gpsWaitTime;
}
@Override
public boolean isDebugMode() {
return debugMode;
}
@Override
public void setDebugMode(boolean debugMode) {
this.debugMode = debugMode;
}
@Override
public boolean isDebugMapView() {
return debugMapView;
}
@Override
public void setDebugMapView(boolean debugMapView) {
this.debugMapView = debugMapView;
}
@Override
public boolean isDebugTileProviders() {
return debugTileProviders;
}
@Override
public void setDebugTileProviders(boolean debugTileProviders) {
this.debugTileProviders = debugTileProviders;
}
@Override
public boolean isDebugMapTileDownloader() {
return debugMapTileDownloader;
}
@Override
public void setDebugMapTileDownloader(boolean debugMapTileDownloader) {
this.debugMapTileDownloader = debugMapTileDownloader;
}
@Override
public boolean isMapViewHardwareAccelerated() {
return isMapViewHardwareAccelerated;
}
@Override
public void setMapViewHardwareAccelerated(boolean mapViewHardwareAccelerated) {
isMapViewHardwareAccelerated = mapViewHardwareAccelerated;
}
@Override
public String getUserAgentValue() {
return userAgentValue;
}
@Override
public void setUserAgentValue(String userAgentValue) {
this.userAgentValue = userAgentValue;
}
@Override
public Map<String, String> getAdditionalHttpRequestProperties() {
return mAdditionalHttpRequestProperties;
}
@Override
public short getCacheMapTileCount() {
return cacheMapTileCount;
}
@Override
public void setCacheMapTileCount(short cacheMapTileCount) {
this.cacheMapTileCount = cacheMapTileCount;
}
@Override
public short getTileDownloadThreads() {
return tileDownloadThreads;
}
@Override
public void setTileDownloadThreads(short tileDownloadThreads) {
this.tileDownloadThreads = tileDownloadThreads;
}
@Override
public short getTileFileSystemThreads() {
return tileFileSystemThreads;
}
@Override
public void setTileFileSystemThreads(short tileFileSystemThreads) {
this.tileFileSystemThreads = tileFileSystemThreads;
}
@Override
public short getTileDownloadMaxQueueSize() {
return tileDownloadMaxQueueSize;
}
@Override
public void setTileDownloadMaxQueueSize(short tileDownloadMaxQueueSize) {
this.tileDownloadMaxQueueSize = tileDownloadMaxQueueSize;
}
@Override
public short getTileFileSystemMaxQueueSize() {
return tileFileSystemMaxQueueSize;
}
@Override
public void setTileFileSystemMaxQueueSize(short tileFileSystemMaxQueueSize) {
this.tileFileSystemMaxQueueSize = tileFileSystemMaxQueueSize;
}
@Override
public long getTileFileSystemCacheMaxBytes() {
return tileFileSystemCacheMaxBytes;
}
@Override
public void setTileFileSystemCacheMaxBytes(long tileFileSystemCacheMaxBytes) {
this.tileFileSystemCacheMaxBytes = tileFileSystemCacheMaxBytes;
}
@Override
public long getTileFileSystemCacheTrimBytes() {
return tileFileSystemCacheTrimBytes;
}
@Override
public void setTileFileSystemCacheTrimBytes(long tileFileSystemCacheTrimBytes) {
this.tileFileSystemCacheTrimBytes = tileFileSystemCacheTrimBytes;
}
@Override
public SimpleDateFormat getHttpHeaderDateTimeFormat() {
return httpHeaderDateTimeFormat;
}
@Override
public void setHttpHeaderDateTimeFormat(SimpleDateFormat httpHeaderDateTimeFormat) {
this.httpHeaderDateTimeFormat = httpHeaderDateTimeFormat;
}
@Override
public Proxy getHttpProxy() {
return httpProxy;
}
@Override
public void setHttpProxy(Proxy httpProxy) {
this.httpProxy = httpProxy;
}
@Override
public File getOsmdroidBasePath() {
if (osmdroidBasePath==null)
osmdroidBasePath = new File(StorageUtils.getStorage().getAbsolutePath(), "osmdroid");
try {
osmdroidBasePath.mkdirs();
}catch (Exception ex){
Log.d(IMapView.LOGTAG, "Unable to create base path at " + osmdroidBasePath.getAbsolutePath(), ex);
//IO/permissions issue
//trap for android studio layout editor and some for certain devices
//see https://github.com/osmdroid/osmdroid/issues/508
}
return osmdroidBasePath;
}
@Override
public void setOsmdroidBasePath(File osmdroidBasePath) {
this.osmdroidBasePath = osmdroidBasePath;
}
@Override
public File getOsmdroidTileCache() {
if (osmdroidTileCache==null)
osmdroidTileCache = new File(getOsmdroidBasePath(), "tiles");
try {
osmdroidTileCache.mkdirs();
}catch (Exception ex){
Log.d(IMapView.LOGTAG, "Unable to create tile cache path at " + osmdroidTileCache.getAbsolutePath(), ex);
//IO/permissions issue
//trap for android studio layout editor and some for certain devices
//see https://github.com/osmdroid/osmdroid/issues/508
}
return osmdroidTileCache;
}
@Override
public void setOsmdroidTileCache(File osmdroidTileCache) {
this.osmdroidTileCache = osmdroidTileCache;
}
@Override
public String getUserAgentHttpHeader() {
return userAgentHttpHeader;
}
@Override
public void setUserAgentHttpHeader(String userAgentHttpHeader) {
this.userAgentHttpHeader = userAgentHttpHeader;
}
//</editor-fold>
@Override
public void load(Context ctx, SharedPreferences prefs) {
//cache management starts here
//check to see if the shared preferences is set for the tile cache
if (!prefs.contains("osmdroid.basePath")){
//this is the first time startup. run the discovery bit
File discoveredBestPath = getOsmdroidBasePath();
File discoveredCachPath = getOsmdroidTileCache();
if (!discoveredBestPath.exists() || !StorageUtils.isWritable(discoveredBestPath)) {
//this should always be writable...
discoveredCachPath=discoveredBestPath=new File("/data/data/" + ctx.getPackageName() + "/osmdroid/");
discoveredCachPath.mkdirs();
}
SharedPreferences.Editor edit = prefs.edit();
edit.putString("osmdroid.basePath",discoveredBestPath.getAbsolutePath());
edit.putString("osmdroid.cachePath",discoveredCachPath.getAbsolutePath());
edit.commit();
setOsmdroidBasePath(discoveredBestPath);
setOsmdroidTileCache(discoveredCachPath);
setUserAgentValue(ctx.getPackageName());
save(ctx,prefs);
} else {
//normal startup, load user preferences and populate the config object
setOsmdroidBasePath(new File(prefs.getString("osmdroid.basePath", getOsmdroidBasePath().getAbsolutePath())));
setOsmdroidTileCache(new File(prefs.getString("osmdroid.cachePath", getOsmdroidTileCache().getAbsolutePath())));
setDebugMode(prefs.getBoolean("osmdroid.DebugMode",false));
setDebugMapTileDownloader(prefs.getBoolean("osmdroid.DebugDownloading", false));
setDebugMapView(prefs.getBoolean("osmdroid.DebugMapView", false));
setDebugTileProviders(prefs.getBoolean("osmdroid.DebugTileProvider",false));
setMapViewHardwareAccelerated(prefs.getBoolean("osmdroid.HardwareAcceleration",true));
setUserAgentValue(prefs.getString("osmdroid.userAgentValue",ctx.getPackageName()));
load(prefs, mAdditionalHttpRequestProperties, "osmdroid.additionalHttpRequestProperty.");
setGpsWaitTime(prefs.getLong("osmdroid.gpsWaitTime", gpsWaitTime));
setTileDownloadThreads((short)(prefs.getInt("osmdroid.tileDownloadThreads",tileDownloadThreads)));
setTileFileSystemThreads((short)(prefs.getInt("osmdroid.tileFileSystemThreads",tileFileSystemThreads)));
setTileDownloadMaxQueueSize((short)(prefs.getInt("osmdroid.tileDownloadMaxQueueSize",tileDownloadMaxQueueSize)));
setTileFileSystemMaxQueueSize((short)(prefs.getInt("osmdroid.tileFileSystemMaxQueueSize",tileFileSystemMaxQueueSize)));
setExpirationExtendedDuration((long)prefs.getLong("osmdroid.ExpirationExtendedDuration", expirationAdder));
setMapViewRecyclerFriendly((boolean)prefs.getBoolean("osmdroid.mapViewRecycler", mapViewRecycler));
setAnimationSpeedDefault(prefs.getInt("osmdroid.ZoomSpeedDefault", animationSpeedDefault));
setAnimationSpeedShort(prefs.getInt("osmdroid.animationSpeedShort", animationSpeedShort));
if (prefs.contains("osmdroid.ExpirationOverride")) {
expirationOverride = prefs.getLong("osmdroid.ExpirationOverride",-1);
if (expirationOverride!=null && expirationOverride==-1)
expirationOverride=null;
}
}
if (Build.VERSION.SDK_INT >= 9) {
//unfortunately API 8 doesn't support File.length()
//https://github/osmdroid/osmdroid/issues/435
//On startup, we auto set the max cache size to be the current cache size + free disk space
//this reduces the chance of osmdroid completely filling up the storage device
//if the default max cache size is greater than the available free space
//reduce it to 95% of the available free space + the size of the cache
long cacheSize = 0;
File dbFile = new File(getOsmdroidTileCache().getAbsolutePath() + File.separator + SqlTileWriter.DATABASE_FILENAME);
if (dbFile.exists()) {
cacheSize = dbFile.length();
}
long freeSpace = getOsmdroidTileCache().getFreeSpace();
//Log.i(TAG, "Current cache size is " + cacheSize + " free space is " + freeSpace);
if (getTileFileSystemCacheMaxBytes() > (freeSpace + cacheSize)){
setTileFileSystemCacheMaxBytes((long)((freeSpace + cacheSize) * 0.95));
setTileFileSystemCacheTrimBytes((long)((freeSpace + cacheSize) * 0.90));
}
}
}
@Override
public void save(Context ctx, SharedPreferences prefs) {
SharedPreferences.Editor edit = prefs.edit();
edit.putString("osmdroid.basePath",getOsmdroidBasePath().getAbsolutePath());
edit.putString("osmdroid.cachePath",getOsmdroidTileCache().getAbsolutePath());
edit.putBoolean("osmdroid.DebugMode",isDebugMode());
edit.putBoolean("osmdroid.DebugDownloading",isDebugMapTileDownloader());
edit.putBoolean("osmdroid.DebugMapView",isDebugMapView());
edit.putBoolean("osmdroid.DebugTileProvider",isDebugTileProviders());
edit.putBoolean("osmdroid.HardwareAcceleration", isMapViewHardwareAccelerated());
edit.putString("osmdroid.userAgentValue", getUserAgentValue());
save(prefs, edit, mAdditionalHttpRequestProperties, "osmdroid.additionalHttpRequestProperty.");
edit.putLong("osmdroid.gpsWaitTime",gpsWaitTime);
edit.putInt("osmdroid.cacheMapTileCount", cacheMapTileCount);
edit.putInt("osmdroid.tileDownloadThreads", tileDownloadThreads);
edit.putInt("osmdroid.tileFileSystemThreads",tileFileSystemThreads);
edit.putInt("osmdroid.tileDownloadMaxQueueSize",tileDownloadMaxQueueSize);
edit.putInt("osmdroid.tileFileSystemMaxQueueSize",tileFileSystemMaxQueueSize);
edit.putLong("osmdroid.ExpirationExtendedDuration",expirationAdder);
if (expirationOverride!=null)
edit.putLong("osmdroid.ExpirationOverride",expirationOverride);
//TODO save other fields?
edit.putInt("osmdroid.ZoomSpeedDefault", animationSpeedDefault);
edit.putInt("osmdroid.animationSpeedShort", animationSpeedShort);
edit.putBoolean("osmdroid.mapViewRecycler", mapViewRecycler);
edit.commit();
}
/**
* Loading a map from preferences, using a prefix for the prefs keys
*
* @since 5.6.5
* @param pPrefs
* @param pMap
* @param pPrefix
*/
private static void load(final SharedPreferences pPrefs,
final Map<String, String> pMap, final String pPrefix) {
pMap.clear();
for (final String key : pPrefs.getAll().keySet()) {
if (key.startsWith(pPrefix)) {
pMap.put(key.substring(pPrefix.length()), pPrefs.getString(key, null));
}
}
}
/**
* Saving a map into preferences, using a prefix for the prefs keys
*
* @since 5.6.5
* @param pPrefs
* @param pEdit
* @param pMap
* @param pPrefix
*/
private static void save(final SharedPreferences pPrefs, final SharedPreferences.Editor pEdit,
final Map<String, String> pMap, final String pPrefix) {
for (final String key : pPrefs.getAll().keySet()) {
if (key.startsWith(pPrefix)) {
pEdit.remove(key);
}
}
for (final Map.Entry<String, String> entry : pMap.entrySet()) {
final String key = pPrefix + entry.getKey();
pEdit.putString(key, entry.getValue());
}
}
@Override
public long getExpirationExtendedDuration() {
return expirationAdder ;
}
@Override
public void setExpirationExtendedDuration(final long period) {
if (period < 0)
expirationAdder=0;
else
expirationAdder=period;
}
@Override
public void setExpirationOverrideDuration(Long period) {
expirationOverride=period;
}
@Override
public Long getExpirationOverrideDuration() {
return expirationOverride;
}
@Override
public void setAnimationSpeedDefault(int durationsMilliseconds) {
this.animationSpeedDefault =durationsMilliseconds;
}
@Override
public int getAnimationSpeedDefault() {
return animationSpeedDefault;
}
@Override
public void setAnimationSpeedShort(int durationsMilliseconds) {
this.animationSpeedShort = durationsMilliseconds;
}
@Override
public int getAnimationSpeedShort() {
return animationSpeedShort;
}
@Override
public boolean isMapViewRecyclerFriendly() {
return mapViewRecycler;
}
@Override
public void setMapViewRecyclerFriendly(boolean enabled) {
this.mapViewRecycler=enabled;
}
}
| Use apply on SharedPreferences. More efficient. Also,otherwise Robolectric tests fail.
| osmdroid-android/src/main/java/org/osmdroid/config/DefaultConfigurationProvider.java | Use apply on SharedPreferences. More efficient. Also,otherwise Robolectric tests fail. | <ide><path>smdroid-android/src/main/java/org/osmdroid/config/DefaultConfigurationProvider.java
<ide> SharedPreferences.Editor edit = prefs.edit();
<ide> edit.putString("osmdroid.basePath",discoveredBestPath.getAbsolutePath());
<ide> edit.putString("osmdroid.cachePath",discoveredCachPath.getAbsolutePath());
<del> edit.commit();
<add> if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
<add> edit.apply();
<add> } else {
<add> edit.commit();
<add> }
<ide> setOsmdroidBasePath(discoveredBestPath);
<ide> setOsmdroidTileCache(discoveredCachPath);
<ide> setUserAgentValue(ctx.getPackageName());
<ide> edit.putInt("osmdroid.animationSpeedShort", animationSpeedShort);
<ide> edit.putBoolean("osmdroid.mapViewRecycler", mapViewRecycler);
<ide>
<del> edit.commit();
<del> }
<add> if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
<add> edit.apply();
<add> } else {
<add> edit.commit();
<add> } }
<ide>
<ide> /**
<ide> * Loading a map from preferences, using a prefix for the prefs keys |
|
JavaScript | mit | 86e03e6c1996d14ae08c155320bbee513914c90b | 0 | VictorQueiroz/renderer | function NodeLink(node, directives, attributes, context) {
this.node = node;
this.links = {
post: [],
pre: []
};
this.scope = null;
this.context = context || {};
this.attributes = attributes;
this.directives = directives || [];
this.transclude = null;
this.terminalPriority = -Number.MAX_VALUE;
if(this.node.nodeType === Node.TEXT_NODE) {
this.directives.push({
compile: function(node) {
return function(scope, node) {
var interpolate = new Interpolate(node.nodeValue);
scope.watchGroup(interpolate.exps, function() {
node.nodeValue = interpolate.compile(scope);
});
};
}
});
}
}
extend(NodeLink, {
SCOPE_CHILD: 1,
SCOPE_ISOLATED: 2
});
NodeLink.prototype = {
constructor: NodeLink,
/**
* Given a node with an directive-start it collects all of the siblings until it finds
* directive-end.
* @param node
* @param attrStart
* @param attrEnd
* @returns {*}
*/
group: function(attrStart, attrEnd) {
var node = this.node,
nodes = [],
depth = 0;
if (attrStart && node.hasAttribute && node.hasAttribute(attrStart)) {
do {
if (!node) {
throw $compileMinErr('uterdir',
"Unterminated attribute, found '{0}' but no matching '{1}' found.",
attrStart, attrEnd);
}
if (node.nodeType == Node.ELEMENT_NODE) {
if (node.hasAttribute(attrStart)) depth++;
if (node.hasAttribute(attrEnd)) depth--;
}
nodes.push(node);
node = node.nextSibling;
} while (depth > 0);
} else {
nodes.push(node);
}
return new NodeGroup(nodes);
},
prepare: function(registry) {
var i,
ii = this.directives.length,
options,
context = this.context,
attrEnd,
attrStart,
directive,
scopeType;
for(i = 0; i < ii; i++) {
directive = this.directives[i];
if (this.terminalPriority > directive.priority) {
break; // prevent further processing of directives
}
attrStart = directive.$$start;
attrEnd = directive.$$end;
// collect multi elements
if(attrStart) {
this.node = this.group(attrStart, attrEnd);
}
if(directive.hasOwnProperty('scope') && directive.scope) {
// This directive is trying to add an isolated scope.
// Check that there is no scope of any kind already
if(isObject(directive.scope)) {
if(this.scope) {
throw new Error(
'You can\'t define a new isolated ' +
'scope on a node that already has a ' +
'child scope defined'
);
}
scopeType = NodeLink.SCOPE_ISOLATED;
} else if (isBoolean(directive.scope)) {
scopeType = NodeLink.SCOPE_CHILD;
}
this.scope = {
type: scopeType,
bindings: directive.scope
};
}
if(directive.controller) {
// The list of all the
// directives controllers.
context.controllers = context.controllers || {};
context.controllers[directive.name] = directive;
}
if(!directive.transclude && directive.template) {
directive.transclude = true;
}
if(directive.transclude) {
if(directive.transclude == 'element') {
this.terminalPriority = directive.priority;
}
options = {
type: directive.transclude,
registry: registry,
directive: directive,
attributes: this.attributes,
controllers: context.controllers,
terminalPriority: this.terminalPriority,
};
this.transclude = new Transclude(this.node, options);
if(directive.transclude == 'element' &&
this.node !== this.transclude.comment) {
this.node = this.transclude.comment;
}
this.transcludeFn = this.transclude.getTranscludeCallback();
}
if(directive.template) {
if(isArray(directive.template)) {
directive.template = directive.template.join('');
}
this.node.innerHTML = directive.template;
this.hasTemplate = true;
}
this.addLink(directive.compile(this.node, this.attributes, this.transcludeFn), directive);
if(directive.terminal) {
this.terminal = true;
this.terminalPriority = Math.max(this.terminalPriority, directive.priority);
}
}
},
REQUIRE_PREFIX_REGEXP: /^(?:(\^\^?)?(\?)?(\^\^?)?)?/,
getControllers: function(directiveName, node, require, controllers) {
var value;
if (isString(require)) {
var match = require.match(this.REQUIRE_PREFIX_REGEXP);
var name = require.substring(match[0].length);
var inheritType = match[1] || match[3];
var optional = match[2] === '?';
//If only parents then start at the parent element
if (inheritType === '^^') {
$element = $element.parentNode;
//Otherwise attempt getting the controller from controllers in case
//the element is transcluded (and has no data) and to avoid .data if possible
} else {
value = controllers && controllers[name];
value = value && value.instance;
}
if (!value) {
var dataName = '$' + name + 'Controller';
value = inheritType ? elementInheritedData(node, dataName) : elementData(node, dataName);
}
if (!value && !optional) {
throw new Error("Controller '" + name + "', required by " +
"directive '" + directiveName + "', can't " +
"be found!");
}
} else if (isArray(require)) {
value = [];
for (var i = 0, ii = require.length; i < ii; i++) {
value[i] = this.getControllers(directiveName, node, require[i], controllers);
}
}
return value || null;
},
instantiate: function(Controller, scope, node, attributes, transcludeFn) {
return new Controller(scope, node, attributes, transcludeFn);
},
setupControllers: function(scope, node, attributes, transcludeFn) {
var i,
keys = Object.keys(this.context.controllers),
directive,
controller,
controllers = {};
for(i = 0; i < keys.length; i++) {
directive = this.context.controllers[keys[i]];
if(isFunction(directive.controller)) {
controller = this.instantiate(directive.controller, scope, node, attributes, transcludeFn);
} else {
continue;
}
controllers[directive.name] = controller;
elementData(node, '$' + directive.name + 'Controller', controllers[directive.name]);
}
return controllers;
},
parse: function(exp) {
return new Parser(new Lexer()).parse(exp);
},
// Set up $watches for isolate scope and controller bindings. This process
// only occurs for isolate scopes and new scopes with controllerAs.
directiveBindings: function(scope, dest, bindings) {
var i = 0,
bindingsKeys = Object.keys(bindings),
ii = bindingsKeys.length,
mode,
attrs = this.attributes;
forEach(bindings, function(mode, key) {
var attrName,
parentGet,
parentSet,
lastValue;
mode = bindings[key];
if(mode.length > 1) {
attrName = mode.substring(1);
mode = mode[0];
} else {
attrName = key;
}
switch(mode) {
case '@':
attrs.$observe(attrName, function(value) {
if(isString(value)) {
dest[key] = value;
}
});
if(isString(attrs[attrName])) {
// If the attribute has been provided then we trigger an interpolation to ensure
// the value is there for use in the link fn
dest[key] = new Interpolate(attrs[attrName]).compile(scope);
}
break;
case '=':
if(!attrs.hasOwnProperty(attrName)) {
break;
}
parentGet = this.parse(attrs[attrName]);
parentSet = parentGet.assign;
lastValue = dest[key] = parentGet(scope);
var parentWatcher = function(value) {
if(!isEqual(value, dest[key])) {
// we are out of sync and need to copy
if(!isEqual(value, lastValue)) {
// parent changed and it has precedence
dest[key] = value;
} else {
parentSet(scope, value = dest[key]);
}
}
return (lastValue = value);
};
scope.watch(attrs[attrName], parentWatcher);
break;
}
}, this);
},
callLink: function(link, scope, transcludeFn) {
link(
scope,
this.node,
this.attributes,
this.getControllers(
link.directiveName,
this.node,
link.require,
this.controllers
),
transcludeFn
);
return this;
},
execute: function(scope, childLink, transcludeFn) {
var newScope;
if(this.transclude) {
this.transcludeFn = this.transclude.getTranscludeCallback(scope);
} else if (!this.transcludeFn && isFunction(transcludeFn)) {
this.transcludeFn = transcludeFn;
}
// If the link that receive the isolated scope directive does not require
// a isolated scope, it receive the actual scope. Only the childs of the node
// with the isolated scope will receive the isolated scope, this prevents that
// the node attributes gets compiled with the values of the isolated scope, and
// directives automatically created by the interpolation proccess will be getting
// the isolated scope itself, and not the node scope
if(this.scope) {
switch(this.scope.type) {
case NodeLink.SCOPE_CHILD:
newScope = scope.clone();
break;
case NodeLink.SCOPE_ISOLATED:
newScope = scope.clone(true);
this.directiveBindings(scope, newScope, this.scope.bindings);
break;
}
} else if(!newScope) {
newScope = scope;
}
if(this.context.controllers) {
this.controllers = this.setupControllers(newScope, this.node, this.attributes, transcludeFn);
}
var i = 0,
links = this.links,
ii = links.pre.length,
link;
for(; i < ii; i++) {
link = links.pre[i];
this.callLink(
link,
link.newScopeType ? newScope : scope,
this.transcludeFn
);
}
childLink.execute(scope, this.transcludeFn);
i = links.post.length - 1;
for(; i >= 0; i--) {
link = links.post[i];
this.callLink(
link,
link.newScopeType ? newScope : scope,
this.transcludeFn
);
}
},
addLink: function(link, directive) {
var links = this.links;
var directiveData = {
directiveName: directive.name,
require: directive.require,
newScopeType: isDefined(directive.scope)
};
if(isObject(link)) {
forEach(link, function(value, key) {
extend(value, directiveData);
if(links.hasOwnProperty(key)) {
links[key].push(value);
}
});
} else if(isFunction(link)) {
extend(link, directiveData);
links.post.push(link);
}
}
};
| src/NodeLink.js | function NodeLink(node, directives, attributes, context) {
this.node = node;
this.links = {
post: [],
pre: []
};
this.scope = null;
this.context = context || {};
this.attributes = attributes;
this.directives = directives || [];
this.transclude = null;
this.terminalPriority = -Number.MAX_VALUE;
if(this.node.nodeType === Node.TEXT_NODE) {
this.directives.push({
compile: function(node) {
return function(scope, node) {
var interpolate = new Interpolate(node.nodeValue);
scope.watchGroup(interpolate.exps, function() {
node.nodeValue = interpolate.compile(scope);
});
};
}
});
}
}
extend(NodeLink, {
SCOPE_CHILD: 1,
SCOPE_ISOLATED: 2
});
NodeLink.prototype = {
constructor: NodeLink,
/**
* Given a node with an directive-start it collects all of the siblings until it finds
* directive-end.
* @param node
* @param attrStart
* @param attrEnd
* @returns {*}
*/
group: function(attrStart, attrEnd) {
var node = this.node,
nodes = [],
depth = 0;
if (attrStart && node.hasAttribute && node.hasAttribute(attrStart)) {
do {
if (!node) {
throw $compileMinErr('uterdir',
"Unterminated attribute, found '{0}' but no matching '{1}' found.",
attrStart, attrEnd);
}
if (node.nodeType == Node.ELEMENT_NODE) {
if (node.hasAttribute(attrStart)) depth++;
if (node.hasAttribute(attrEnd)) depth--;
}
nodes.push(node);
node = node.nextSibling;
} while (depth > 0);
} else {
nodes.push(node);
}
return new NodeGroup(nodes);
},
prepare: function(registry) {
var i,
ii = this.directives.length,
options,
context = this.context,
attrEnd,
attrStart,
directive,
scopeType;
for(i = 0; i < ii; i++) {
directive = this.directives[i];
if (this.terminalPriority > directive.priority) {
break; // prevent further processing of directives
}
attrStart = directive.$$start;
attrEnd = directive.$$end;
// collect multi elements
if(attrStart) {
this.node = this.group(attrStart, attrEnd);
}
if(directive.hasOwnProperty('scope') && directive.scope) {
// This directive is trying to add an isolated scope.
// Check that there is no scope of any kind already
if(isObject(directive.scope)) {
if(this.scope) {
throw new Error(
'You can\'t define a new isolated ' +
'scope on a node that already has a ' +
'child scope defined'
);
}
scopeType = NodeLink.SCOPE_ISOLATED;
} else if (isBoolean(directive.scope)) {
scopeType = NodeLink.SCOPE_CHILD;
}
this.scope = {
type: scopeType,
bindings: directive.scope
};
}
if(directive.controller) {
// The list of all the
// directives controllers.
context.controllers = context.controllers || {};
context.controllers[directive.name] = directive;
}
if(!directive.transclude && directive.template) {
directive.transclude = true;
}
if(directive.transclude) {
if(directive.transclude == 'element') {
this.terminalPriority = directive.priority;
}
options = {
type: directive.transclude,
registry: registry,
directive: directive,
attributes: this.attributes,
controllers: context.controllers,
terminalPriority: this.terminalPriority,
};
this.transclude = new Transclude(this.node, options);
if(directive.transclude == 'element' &&
this.node !== this.transclude.comment) {
this.node = this.transclude.comment;
}
this.transcludeFn = this.transclude.getTranscludeCallback();
}
if(directive.template) {
if(isArray(directive.template)) {
directive.template = directive.template.join('');
}
this.node.innerHTML = directive.template;
this.hasTemplate = true;
}
this.addLink(directive.compile(this.node, this.attributes, this.transcludeFn), directive);
if(directive.terminal) {
this.terminal = true;
this.terminalPriority = Math.max(this.terminalPriority, directive.priority);
}
}
},
REQUIRE_PREFIX_REGEXP: /^(?:(\^\^?)?(\?)?(\^\^?)?)?/,
getControllers: function(directiveName, node, require, controllers) {
var value;
if (isString(require)) {
var match = require.match(this.REQUIRE_PREFIX_REGEXP);
var name = require.substring(match[0].length);
var inheritType = match[1] || match[3];
var optional = match[2] === '?';
//If only parents then start at the parent element
if (inheritType === '^^') {
$element = $element.parentNode;
//Otherwise attempt getting the controller from controllers in case
//the element is transcluded (and has no data) and to avoid .data if possible
} else {
value = controllers && controllers[name];
value = value && value.instance;
}
if (!value) {
var dataName = '$' + name + 'Controller';
value = inheritType ? elementInheritedData(node, dataName) : elementData(node, dataName);
}
if (!value && !optional) {
throw new Error("Controller '" + name + "', required by " +
"directive '" + directiveName + "', can't " +
"be found!");
}
} else if (isArray(require)) {
value = [];
for (var i = 0, ii = require.length; i < ii; i++) {
value[i] = this.getControllers(directiveName, node, require[i], controllers);
}
}
return value || null;
},
instantiate: function(Controller, scope, node, attributes, transcludeFn) {
return new Controller(scope, node, attributes, transcludeFn);
},
setupControllers: function(scope, node, attributes, transcludeFn) {
var i,
keys = Object.keys(this.context.controllers),
directive,
controller,
controllers = {};
for(i = 0; i < keys.length; i++) {
directive = this.context.controllers[keys[i]];
if(isFunction(directive.controller)) {
controller = this.instantiate(directive.controller, scope, node, attributes, transcludeFn);
} else {
continue;
}
controllers[directive.name] = controller;
elementData(node, '$' + directive.name + 'Controller', controllers[directive.name]);
}
return controllers;
},
parse: function(exp) {
return new Parser(new Lexer()).parse(exp);
},
// Set up $watches for isolate scope and controller bindings. This process
// only occurs for isolate scopes and new scopes with controllerAs.
directiveBindings: function(scope, dest, bindings) {
var i = 0,
bindingsKeys = Object.keys(bindings),
ii = bindingsKeys.length,
mode,
attrs = this.attributes;
forEach(bindings, function(mode, key) {
var attrName,
parentGet,
parentSet,
lastValue;
mode = bindings[key];
if(mode.length > 1) {
attrName = mode.substring(1);
mode = mode[0];
} else {
attrName = key;
}
switch(mode) {
case '@':
attrs.$observe(attrName, function(value) {
if(isString(value)) {
dest[key] = value;
}
});
if(isString(attrs[attrName])) {
// If the attribute has been provided then we trigger an interpolation to ensure
// the value is there for use in the link fn
dest[key] = new Interpolate(attrs[attrName]).compile(scope);
}
break;
case '=':
if(!attrs.hasOwnProperty(attrName)) {
break;
}
parentGet = this.parse(attrs[attrName]);
parentSet = parentGet.assign;
lastValue = dest[key] = parentGet(scope);
var parentWatcher = function(value) {
if(!isEqual(value, dest[key])) {
// we are out of sync and need to copy
if(!isEqual(value, lastValue)) {
// parent changed and it has precedence
dest[key] = value;
} else {
parentSet(scope, value = dest[key]);
}
}
return (lastValue = value);
};
scope.watch(attrs[attrName], parentWatcher);
dest.watch(attrName, function(value, oldValue) {
if(!isEqual(value, scope[key])) {
scope[key] = value;
}
});
break;
}
}, this);
},
callLink: function(link, scope, transcludeFn) {
link(
scope,
this.node,
this.attributes,
this.getControllers(
link.directiveName,
this.node,
link.require,
this.controllers
),
transcludeFn
);
return this;
},
execute: function(scope, childLink, transcludeFn) {
var newScope;
if(this.transclude) {
this.transcludeFn = this.transclude.getTranscludeCallback(scope);
} else if (!this.transcludeFn && isFunction(transcludeFn)) {
this.transcludeFn = transcludeFn;
}
// If the link that receive the isolated scope directive does not require
// a isolated scope, it receive the actual scope. Only the childs of the node
// with the isolated scope will receive the isolated scope, this prevents that
// the node attributes gets compiled with the values of the isolated scope, and
// directives automatically created by the interpolation proccess will be getting
// the isolated scope itself, and not the node scope
if(this.scope) {
switch(this.scope.type) {
case NodeLink.SCOPE_CHILD:
newScope = scope.clone();
break;
case NodeLink.SCOPE_ISOLATED:
newScope = scope.clone(true);
this.directiveBindings(scope, newScope, this.scope.bindings);
break;
}
} else if(!newScope) {
newScope = scope;
}
if(this.context.controllers) {
this.controllers = this.setupControllers(newScope, this.node, this.attributes, transcludeFn);
}
var i = 0,
links = this.links,
ii = links.pre.length,
link;
for(; i < ii; i++) {
link = links.pre[i];
this.callLink(
link,
link.newScopeType ? newScope : scope,
this.transcludeFn
);
}
childLink.execute(scope, this.transcludeFn);
i = links.post.length - 1;
for(; i >= 0; i--) {
link = links.post[i];
this.callLink(
link,
link.newScopeType ? newScope : scope,
this.transcludeFn
);
}
},
addLink: function(link, directive) {
var links = this.links;
var directiveData = {
directiveName: directive.name,
require: directive.require,
newScopeType: isDefined(directive.scope)
};
if(isObject(link)) {
forEach(link, function(value, key) {
extend(value, directiveData);
if(links.hasOwnProperty(key)) {
links[key].push(value);
}
});
} else if(isFunction(link)) {
extend(link, directiveData);
links.post.push(link);
}
}
};
| chore(src/NodeLink.js): Removed watcher which was being setted on `dest` and reidentation by .editorconfig
| src/NodeLink.js | chore(src/NodeLink.js): Removed watcher which was being setted on `dest` and reidentation by .editorconfig | <ide><path>rc/NodeLink.js
<ide> var parentWatcher = function(value) {
<ide> if(!isEqual(value, dest[key])) {
<ide> // we are out of sync and need to copy
<del> if(!isEqual(value, lastValue)) {
<del> // parent changed and it has precedence
<del> dest[key] = value;
<del> } else {
<del> parentSet(scope, value = dest[key]);
<add> if(!isEqual(value, lastValue)) {
<add> // parent changed and it has precedence
<add> dest[key] = value;
<add> } else {
<add> parentSet(scope, value = dest[key]);
<ide> }
<ide> }
<add>
<ide> return (lastValue = value);
<ide> };
<ide>
<ide> scope.watch(attrs[attrName], parentWatcher);
<del> dest.watch(attrName, function(value, oldValue) {
<del> if(!isEqual(value, scope[key])) {
<del> scope[key] = value;
<del> }
<del> });
<ide> break;
<ide> }
<ide> }, this); |
|
JavaScript | mit | 278b18c23673b222500095c28bc4d560e7fd95c8 | 0 | avwo/whistle,avwo/whistle | var util = require('../util');
var rulesUtil = require('./util');
var rules = rulesUtil.rules;
var values = rulesUtil.values;
var url = require('url');
var net = require('net');
var lookup = require('./dns');
var extend = require('extend');
var protoMgr = require('./protocols');
var allowDnsCache = true;
var WEB_PROTOCOL_RE = /^(?:https?|wss?|tunnel):\/\//;
var PORT_RE = /^(.*):(\d*)$/;
var PLUGIN_RE = /^(?:plugin|whistle)\.([a-z\d_\-]+:\/\/[\s\S]*)/;
var protocols = protoMgr.protocols;
var multiMatchs = protoMgr.multiMatchs;
var HOST_RE = /^(?:(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(?:\:\d+)?$/;
var FILE_RE = /^(?:[a-z]:(?:\\|\/(?!\/))|\/)/i;
var PROXY_RE = /^x?(?:socks|proxy|http-proxy|internal-proxy|https2http-proxy|http2https-proxy):\/\//;
var VAR_RE = /\${([^{}]+)}/g;
var NO_SCHEMA_RE = /^\/\/[^/]/;
var WILDCARD_RE = /^(\$?((?:https?|wss?|tunnel):\/\/)?([^/]+))/;
var RULE_KEY_RE = /^\$\{([^\s]+)\}$/;
var VALUE_KEY_RE = /^\{([^\s]+)\}$/;
var LINE_END_RE = /\n|\r\n|\r/g;
var LOCAL_RULE_RE = /^https?:\/\/local\.(?:whistlejs\.com|wproxy\.org)(?:\/|\?|$)/;
var PATH_RE = /^<.*>$/;
var VALUE_RE = /^\(.*\)$/;
var REG_URL_RE = /^((?:[\w.*-]+:|\*+)?\/\/)?([\w*.-]*)/;
var REG_URL_SYMBOL_RE = /^(\^+)/;
var PATTERN_FILTER_RE = /^(?:filter|ignore):\/\/(.+)\/(i)?$/;
var PATTERN_WILD_FILTER_RE = /^(?:filter|ignore):\/\/(!)?(\*+\/)/;
var aliasProtocols = protoMgr.aliasProtocols;
var regUrlCache = {};
var ALL_STAR_RE = /^\*{3,}$/;
var STAR_RE = /\*+/g;
var PORT_PATTERN_RE = /^!?:\d{1,5}$/;
var QUERY_RE = /[?#].*$/;
var COMMENT_RE = /#.*$/gm;
var CONTROL_RE = /[\u001e\u001f\u200e\u200f\u200d\u200c\u202a\u202d\u202e\u202c\u206e\u206f\u206b\u206a\u206d\u206c]/g;
function domainToRegExp(all, index) {
var len = all.length;
if (!index && len > 2) {
return '((?:[a-z]+://)?[^/]*)';
}
return len > 1 ? '([^/]*)' : '([^/.]*)';
}
function pathToRegExp(all) {
var len = all.length;
if (len > 2) {
return '(.*)';
}
return len > 1 ? '([^?]*)' : '([^?/]*)';
}
function queryToRegExp(all) {
return all.length > 1 ? '(.*)' : '([^&]*)';
}
function isRegUrl(url) {
if (regUrlCache[url]) {
return true;
}
var oriUrl = url;
var not = isNegativePattern(url);
if (not) {
url = url.substring(1);
}
var hasStartSymbol = REG_URL_SYMBOL_RE.test(url);
var hasEndSymbol;
var ignoreCase;
if (hasStartSymbol) {
ignoreCase = RegExp.$1.length;
url = url.substring(ignoreCase);
hasEndSymbol = /\$$/.test(url);
if (hasEndSymbol) {
url = url.slice(0, -1);
}
}
if (!hasStartSymbol || !REG_URL_RE.test(url)) {
return false;
}
var protocol = RegExp.$1 || '';
var domain = RegExp.$2;
var pathname = url.substring(protocol.length + domain.length);
var query = '';
var index = pathname.indexOf('?');
if (index !== -1) {
query = pathname.substring(index);
pathname = pathname.substring(0, index);
}
if (protocol || !ALL_STAR_RE.test(domain)) {
if (!protocol || protocol === '//') {
protocol = '[a-z]+://';
} else {
protocol = util.escapeRegExp(protocol).replace(/\*+/, '([a-z:]+)');
}
}
domain = util.escapeRegExp(domain);
if (domain) {
domain = domain.replace(STAR_RE, domainToRegExp);
} else {
domain = '[^/.]*';
}
if (pathname) {
pathname = util.escapeRegExp(pathname).replace(STAR_RE, pathToRegExp);
} else if (query || hasEndSymbol) {
pathname = '/';
}
query = util.escapeRegExp(query).replace(STAR_RE, queryToRegExp);
var pattern = '^' + protocol + domain + pathname + query + (hasEndSymbol ? '$' : '');
try {
regUrlCache[oriUrl] = {
not: not,
pattern: new RegExp(pattern, ignoreCase ? 'i' : '')
};
} catch (e) {}
return true;
}
function getRealProtocol(matcher) {
var index = matcher.indexOf(':');
if (index === -1) {
return;
}
var protocol = matcher.substring(0, index);
return aliasProtocols[protocol];
}
function detactShorthand(url) {
if (NO_SCHEMA_RE.test(url)) {
return url.substring(2);
}
if (url === '{}' || VALUE_KEY_RE.test(url) || PATH_RE.test(url) || VALUE_RE.test(url)) {
return 'file://' + url;
}
if (FILE_RE.test(url) && !util.isRegExp(url)) {
return 'file://' + url;
}
// compact Chrome
if (/^file:\/\/\/[A-Z]:\//.test(url)) {
return 'file://' + url.substring(8);
}
if (/^@/.test(url)) {
if (url.indexOf('@://') === -1) {
url = '@://' + url.substring(1);
}
return url.replace('@', 'G');
}
return url;
}
function formatUrl(pattern) {
var queryString = '';
var queryIndex = pattern.indexOf('?');
if (queryIndex != -1) {
queryString = pattern.substring(queryIndex);
pattern = pattern.substring(0, queryIndex);
}
var index = pattern.indexOf('://');
index = pattern.indexOf('/', index == -1 ? 0 : index + 3);
return (index == -1 ? pattern + '/' : pattern) + queryString;
}
function getKey(url) {
if (url.indexOf('{') == 0) {
var index = url.lastIndexOf('}');
return index > 1 && url.substring(1, index);
}
return false;
}
function getValue(url) {
if (url.indexOf('(') == 0) {
var index = url.lastIndexOf(')');
return index != -1 ? url.substring(1, index) : url;
}
return false;
}
function getPath(url) {
if (url.indexOf('<') == 0) {
var index = url.lastIndexOf('>');
return index != -1 ? url.substring(1, index) : url;
}
return false;
}
function getFiles(path) {
return /^x?((raw)?file|tpl|jsonp|dust):\/\//.test(path) ? util.removeProtocol(path, true).split('|') : null;
}
function setProtocol(target, source) {
if (util.hasProtocol(target)) {
return target;
}
var protocol = util.getProtocol(source);
if (protocol == null) {
return target;
}
return protocol + '//' + target;
}
function isPathSeparator(ch) {
return ch == '/' || ch == '\\' || ch == '?';
}
/**
* first: xxxx, xxxx?, xxx?xxxx
* second: ?xxx, xxx?xxxx
* @param first
* @param second
* @returns
*/
function join(first, second) {
if (!first || !second) {
return first + second;
}
var firstIndex = first.indexOf('?');
var secondIndex = second.indexOf('?');
var firstQuery = '';
var secondQuery = '';
if (firstIndex != -1) {
firstQuery = first.substring(firstIndex);
first = first.substring(0, firstIndex);
}
if (secondIndex != -1) {
secondQuery = second.substring(secondIndex);
second = second.substring(0, secondIndex);
}
var query = firstQuery && secondQuery ? firstQuery + secondQuery.substring(1) : (firstQuery || secondQuery);
if (second) {
var lastIndex = first.length - 1;
var startWithSep = isPathSeparator(second[0]);
if (isPathSeparator(first[lastIndex])) {
first = startWithSep ? first.substring(0, lastIndex) + second : first + second;
} else {
first = first + (startWithSep ? '' : '/') + second;
}
}
return WEB_PROTOCOL_RE.test(first) ? formatUrl(first + query) : first + query;
}
function getLines(text, root) {
if (!text || !(text = text.trim())) {
return [];
}
var ruleKeys = {};
var valueKeys = {};
var lines = text.split(LINE_END_RE);
var result = [];
lines.forEach(function(line) {
line = line.trim();
if (!line) {
return;
}
var isRuleKey = RULE_KEY_RE.test(line);
if (isRuleKey || VALUE_KEY_RE.test(line)) {
if (root) {
var key = RegExp.$1;
line = '';
if (isRuleKey) {
if (!ruleKeys[key]) {
ruleKeys[key] = 1;
line = rules.get(key);
}
} else if (!valueKeys[key]) {
valueKeys[key] = 1;
line = values.get(key);
}
if (line) {
result.push.apply(result, line.split(LINE_END_RE));
}
}
} else {
result.push(line);
}
});
return result;
}
function resolveVar(str, vals) {
return str.replace(VAR_RE, function(all, key) {
key = getValueFor(key, vals);
return typeof key === 'string' ? key : all;
});
}
function getValueFor(key, vals) {
if (!key) {
return;
}
if (vals && (key in vals)) {
var val = vals[key];
val = vals[key] = (val && typeof val == 'object') ? JSON.stringify(val) : val;
return val;
}
return values.get(key);
}
function getRule(url, list, vals, index) {
var rule = _getRule(url, list, vals, index);
resolveValue(rule, vals);
return rule;
}
function getRuleList(url, list, vals) {
return _getRuleList(url, list, vals).map(function(rule) {
return resolveValue(rule, vals);
});
}
function resolveValue(rule, vals) {
if (!rule) {
return;
}
var matcher = rule.matcher;
var index = matcher.indexOf('://') + 3;
var protocol = matcher.substring(0, index);
matcher = matcher.substring(index);
var key = getKey(matcher);
if (key) {
rule.key = key;
}
var value = getValueFor(key, vals);
if (value == null) {
value = false;
}
if (value !== false || (value = getValue(matcher)) !== false) {
rule.value = protocol + value;
} else if ((value = getPath(matcher)) !== false) {
rule.path = protocol + value;
rule.files = getFiles(rule.path);
}
return rule;
}
function _getRule(url, list, vals, index) {
return _getRuleList(url, list, vals, index || 0);
}
function getRelativePath(pattern, url, matcher) {
var index = url.indexOf('?');
if (index === -1 || pattern.indexOf('?') !== -1) {
return '';
}
if (matcher.indexOf('?') === -1) {
return url.substring(index);
}
url = url.substring(index + 1);
return (url && '&') + url;
}
var SEP_RE = /^[?/]/;
function _getRuleList(url, list, vals, index) {
url = formatUrl(url);
//支持域名匹配
var domainUrl = formatUrl(url).replace(/^((?:https?|wss?|tunnel):\/\/[^\/]+):\d*(\/.*)/i, '$1$2');
var isIndex = typeof index === 'number';
index = isIndex ? index : -1;
var results = [];
var _url = url.replace(QUERY_RE, '');
var _domainUrl = domainUrl.replace(QUERY_RE, '');
var rule, matchedUrl, files, matcher, result, origMatcher, filePath;
var getPathRule = function() {
result = extend({
files: files && files.map(function(file) {
return join(file, filePath);
}),
url: join(matcher, filePath)
}, rule);
result.matcher = origMatcher;
if (isIndex) {
return result;
}
results.push(result);
};
var getExactRule = function(relPath) {
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
result = extend({
files: getFiles(matcher),
url: matcher + relPath
}, rule);
result.matcher = origMatcher;
if (isIndex) {
return result;
}
results.push(result);
};
for (var i = 0; rule = list[i]; i++) {
var pattern = rule.isRegExp ? rule.pattern : setProtocol(rule.pattern, url);
var not = rule.not;
var matchedRes;
if (rule.isRegExp) {
matchedRes = pattern.test(url);
if ((not ? !matchedRes : matchedRes) && !matchFilters(url, rule) && --index < 0) {
var regExp = {};
if (!not) {
for (var j = 1; j < 10; j++) {
regExp['$' + j] = RegExp['$' + j];
}
}
regExp['$&'] = regExp.$0 = url;
var replaceSubMatcher = function(url) {
return url.replace(/(^|.)?(\$[&\d])/g,
function(matched, $1, $2) {
return $1 == '\\' ? $2 : ($1 || '') + (regExp[$2] || '');
});
};
matcher = resolveVar(rule.matcher, vals);
files = getFiles(matcher);
matcher = setProtocol(replaceSubMatcher(matcher), url);
result = extend({
url: matcher,
files: files && files.map(function(file) {
return replaceSubMatcher(file);
})
}, rule);
result.matcher = matcher;
if (isIndex) {
return result;
}
results.push(result);
}
} else if (rule.wildcard) {
var wildcard = rule.wildcard;
if (wildcard.preMatch.test(url) && !matchFilters(url, rule)) {
var hostname = RegExp.$1;
filePath = url.substring(hostname.length);
var wPath = wildcard.path;
if (wildcard.isExact) {
if ((filePath === wPath || filePath.replace(QUERY_RE, '') === wPath) && --index < 0) {
if (result = getExactRule(getRelativePath(wPath, filePath, rule.matcher))) {
return result;
}
}
} else if (filePath.indexOf(wPath) === 0) {
var wpLen = wPath.length;
filePath = filePath.substring(wpLen);
if ((wildcard.hasQuery || !filePath || wPath[wpLen - 1] === '/' || SEP_RE.test(filePath)) && --index < 0) {
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
files = getFiles(matcher);
if (wildcard.hasQuery && filePath) {
filePath = '?' + filePath;
}
if (result = getPathRule()) {
return result;
}
}
}
}
} else if (rule.isExact) {
matchedRes = pattern === _url || pattern === url;
if ((not ? !matchedRes : matchedRes) && !matchFilters(url, rule) && --index < 0) {
if (result = getExactRule(getRelativePath(pattern, url, rule.matcher))) {
return result;
}
}
} else if (((matchedUrl = (url.indexOf(pattern) === 0)) ||
(rule.isDomain && domainUrl.indexOf(pattern) === 0)) && !matchFilters(url, rule)) {
var len = pattern.length;
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
files = getFiles(matcher);
var hasQuery = pattern.indexOf('?') !== -1;
if ((hasQuery || (matchedUrl ? (pattern == _url || isPathSeparator(_url[len])) :
(pattern == _domainUrl || isPathSeparator(_domainUrl[len]))) ||
isPathSeparator(pattern[len - 1])) && --index < 0) {
filePath = (matchedUrl ? url : domainUrl).substring(len);
if (hasQuery && filePath) {
filePath = '?' + filePath;
}
if (result = getPathRule()) {
return result;
}
}
}
}
return isIndex ? null : results;
}
function resolveProperties(url, rules, vals) {
return util.resolveProperties(getRuleList(url, rules, vals));
}
function parseWildcard(pattern, not) {
if (!WILDCARD_RE.test(pattern)) {
return;
}
var preMatch = RegExp.$1;
var protocol = RegExp.$2;
var domain = RegExp.$3;
if (domain.indexOf('*') === -1 && domain.indexOf('~') === -1) {
return;
}
if (not) {
return false;
}
var path = pattern.substring(preMatch.length) || '/';
var isExact = preMatch.indexOf('$') === 0;
if (isExact) {
preMatch = preMatch.substring(1);
}
if ((domain === '*' || domain === '~') && path.charAt(0) === '/') {
preMatch += '*';
}
var index = path.indexOf('?');
var hasQuery = index !== -1;
if (hasQuery && index === 0) {
path = '/' + path;
}
var dLen = domain.length;
preMatch = util.escapeRegExp(preMatch).replace(/[*~]+/g, domainToRegExp);
if (domain[dLen - 1] !== '*' && domain.indexOf(':') === -1) {
preMatch += '(?::\\d+)?';
}
if (!protocol) {
preMatch = '[a-z]+://' + preMatch;
} else if (protocol === '//') {
preMatch = '[a-z]+:' + preMatch;
}
preMatch = '^(' + preMatch + ')';
return {
preMatch: new RegExp(preMatch),
path: path,
hasQuery: hasQuery,
isExact: isExact
};
}
function parseRule(rulesMgr, pattern, matcher, raw, root, filters) {
if (isNegativePattern(matcher)) {
return;
}
var regUrl = regUrlCache[pattern];
var rawPattern = pattern;
var isRegExp, not, port, protocol, isExact;
if (regUrl) {
not = regUrl.not;
isRegExp = true;
pattern = regUrl.pattern;
} else {
not = isNegativePattern(pattern);
// 位置不能变
var isPortPattern = PORT_PATTERN_RE.test(pattern);
if (not) {
pattern = pattern.substring(1);
}
if (isPortPattern) {
isRegExp = true;
pattern = new RegExp('^[\\w]+://[^/]+' + pattern + '/');
}
if (!isRegExp && (isRegExp = util.isRegExp(pattern)) && !(pattern = util.toRegExp(pattern))) {
return;
}
if (!isRegExp) {
var wildcard = parseWildcard(pattern, not);
if (wildcard === false) {
return;
}
if (!wildcard && isExactPattern(pattern)) {
isExact = true;
pattern = pattern.slice(1);
} else if (not) {
return;
}
}
}
var isIp = net.isIP(matcher);
if (isIp || HOST_RE.test(matcher)) {
matcher = 'host://' + matcher;
protocol = 'host';
} else if (matcher[0] === '/') {
matcher = 'file://' + matcher;
protocol = 'file';
} else if (PLUGIN_RE.test(matcher)) {
protocol = 'plugin';
} else if (PROXY_RE.test(matcher)) {
protocol = 'proxy';
} else if (!(protocol = getRealProtocol(matcher))) {
protocol = matcher.match(/^([\w\-]+):\/\//);
protocol = protocol && protocol[1];
if (matcher === 'host://') {
matcher = 'host://127.0.0.1';
}
}
var rules = rulesMgr._rules;
var list = rules[protocol];
if (!list) {
protocol = 'rule';
list = LOCAL_RULE_RE.test(matcher) ? rules._localRule : rules.rule;
} else if (!isIp && protocol == 'host' && PORT_RE.test(matcher)) {
matcher = RegExp.$1;
port = RegExp.$2;
}
list.push({
not: not,
name: protocol,
root: root,
wildcard: wildcard,
isRegExp: isRegExp,
isExact: isExact,
protocol: isRegExp ? null : util.getProtocol(pattern),
pattern: isRegExp ? pattern : formatUrl(pattern),
matcher: matcher,
port: port,
raw: raw,
isDomain: !isRegExp && !not && util.removeProtocol(rawPattern, true).indexOf('/') == -1,
rawPattern: rawPattern,
filters: filters
});
}
function parse(rulesMgr, text, root, append) {
!append && protoMgr.resetRules(rulesMgr._rules);
if (Array.isArray(text)) {
text.forEach(function(item) {
item && parseText(rulesMgr, item.text, item.root, append);
});
} else {
parseText(rulesMgr, text, root, append);
}
}
function indexOfPattern(list) {
var ipIndex = -1;
for (var i = 0, len = list.length; i < len; i++) {
var item = list[i];
if (PORT_PATTERN_RE.test(item) || isExactPattern(item) || isRegUrl(item) ||
isNegativePattern(item) || WEB_PROTOCOL_RE.test(item) || util.isRegExp(item)) {
return i;
}
if (!util.hasProtocol(item)) {
if (!net.isIP(item) && !HOST_RE.test(item)) {
return i;
} else if (ipIndex === -1) {
ipIndex = i;
}
}
}
return ipIndex;
}
function resolveFilterPattern(matcher) {
if (PATTERN_FILTER_RE.test(matcher)) {
return {
filter: RegExp.$1,
caseIns: RegExp.$2
};
}
if (!PATTERN_WILD_FILTER_RE.test(matcher)) {
return;
}
var not = RegExp.$1 || '';
var wildcard = RegExp.$2;
matcher = matcher.substring(matcher.indexOf('://') + 3 + not.length);
var path = util.escapeRegExp(matcher.substring(wildcard.length));
if (path.indexOf('*') !== -1) {
path = path.replace(STAR_RE, pathToRegExp);
} else if (path && path[path.length - 1] !== '/') {
path += '(?:[/?]|$)';
}
return {
filter: '^[a-z]+://[^/]+/' + path
};
}
function resolveMatchFilter(list) {
var matchers = [];
var filters;
list.forEach(function(matcher) {
var result = resolveFilterPattern(matcher);
if (!result) {
matchers.push(matcher);
return;
}
var filter = result.filter;
var caseIns = result.caseIns;
var not = filter[0] === '!';
if (not) {
filter = filter.substring(1);
}
if (filter[0] === '/') {
filter = filter.substring(1);
}
if (!filter) {
return;
}
filter = '/' + filter + '/' + (caseIns ? 'i' : '');
if (filter = util.toRegExp(filter)) {
filters = filters || [];
filters.push({
raw: matcher,
pattern: filter,
not: not
});
}
});
return {
matchers: matchers,
filters: filters
};
}
function parseText(rulesMgr, text, root, append) {
text = text.replace(COMMENT_RE, '').replace(CONTROL_RE, '');
getLines(text, root).forEach(function(line) {
var raw = line;
line = line.trim();
line = line && line.split(/\s+/);
var len = line && line.length;
if (!len || len < 2) {
return;
}
line = line.map(detactShorthand);
var patternIndex = indexOfPattern(line);
if (patternIndex === -1) {
return;
}
var pattern = line[0];
var result = resolveMatchFilter(line.slice(1));
var filters = result.filters;
var matchers = result.matchers;
if (patternIndex > 0) {
//supports: operator-uri pattern1 pattern2 ... patternN
matchers.forEach(function(matcher) {
parseRule(rulesMgr, matcher, pattern, raw, root, filters);
});
} else {
//supports: pattern operator-uri1 operator-uri2 ... operator-uriN
matchers.forEach(function(matcher) {
parseRule(rulesMgr, pattern, matcher, raw, root, filters);
});
}
});
regUrlCache = {};
}
function isExactPattern(pattern) {
return /^\$/.test(pattern);
}
function isNegativePattern(pattern) {
return /^!/.test(pattern);
}
function matchFilter(url, filter) {
var result = filter.pattern.test(url);
return filter.not ? !result : result;
}
function matchFilters(url, rule) {
var filters = rule.filters;
var filter = filters && filters[0];
if (!filter) {
return false;
}
// refine perfermence
if (matchFilter(url, filter)) {
return true;
}
filter = filters[1];
if (!filter) {
return false;
}
if (matchFilter(url, filter)) {
return true;
}
for (var i = 0, len = filters.length; i < len; i++) {
if (matchFilter(url, filter)) {
return true;
}
}
return false;
}
function Rules(values) {
this._rules = protoMgr.getRules();
this._xRules = [];
this._values = values || {};
}
var proto = Rules.prototype;
proto.parse = function(text, root) {
var item = {
first: true,
text: text,
root: root
};
this.disabled = !arguments.length;
if (this._rawText) {
if (this._rawText[0].first) {
this._rawText.shift();
}
this._rawText.unshift(item);
} else {
this._rawText = [item];
}
parse(this, text, root);
if (!this.disabled) {
for (var i = 1, len = this._rawText.length; i < len; i++) {
item = this._rawText[i];
parse(this, item.text, item.root, true);
}
}
};
proto.clearAppend = function() {
if (this._rawText && this._rawText[0].first) {
var item = this._rawText[0];
!this.disabled && parse(this, item.text, item.root);
this._rawText = [item];
} else {
this._rawText = null;
}
};
proto.append = function(text, root) {
var item = {
text: text,
root: root
};
if (this._rawText) {
this._rawText.push(item);
!this.disabled && parse(this, text, root, true);
} else {
this._rawText = [item];
}
};
proto.resolveHost = function(_url, callback, pluginRulesMgr, rulesFileMgr, headerRulesMgr) {
if (!_url || typeof _url !== 'string') {
return callback();
}
var host = this.getHost(_url, pluginRulesMgr, rulesFileMgr, headerRulesMgr);
if (host) {
return callback(null, util.removeProtocol(host.matcher, true), host.port, host);
}
this.lookupHost(_url, callback);
};
proto.lookupHost = function(_url, callback) {
_url = formatUrl(util.setProtocol(_url));
var options = url.parse(_url);
if (options.hostname === '::1') {
return callback(null, '127.0.0.1');
}
lookup(options.hostname, callback, allowDnsCache && !this.resolveDisable(_url).dnsCache);
};
var ignoreHost = function(url, rulesMgr) {
if (!rulesMgr) {
return false;
}
var ignore = rulesMgr.resolveFilter(url);
return ignore.host || ignore.hosts || ignore['ignore|host'] || ignore['ignore|hosts'];
};
proto.getHost = function(url, pluginRulesMgr, rulesFileMgr, headerRulesMgr) {
url = formatUrl(util.setProtocol(url));
var filterHost = ignoreHost(url, this) || ignoreHost(url, pluginRulesMgr)
|| ignoreHost(url, rulesFileMgr) || ignoreHost(url, headerRulesMgr);
var vals = this._values;
if (filterHost) {
return;
}
var host = (pluginRulesMgr && getRule(url, pluginRulesMgr._rules.host, pluginRulesMgr._values))
|| getRule(url, this._rules.host, vals)
|| (rulesFileMgr && getRule(url, rulesFileMgr._rules.host, vals))
|| (headerRulesMgr && getRule(url, headerRulesMgr._rules.host, vals));
if (host && PORT_RE.test(host.matcher)) {
host.matcher = RegExp.$1;
host.port = RegExp.$2;
}
return host;
};
proto.resolveFilter = function(url) {
var filter = resolveProperties(url, this._rules.filter, this._values);
var ignore = resolveProperties(url, this._rules.ignore, this._values);
util.resolveFilter(ignore, filter);
delete filter.filter;
delete filter.ignore;
delete filter['ignore|' + filter];
delete filter['ignore|' + ignore];
return filter;
};
proto.resolveDisable = function(url) {
return resolveProperties(url, this._rules.disable, this._values);
};
proto.resolveRules = function(url) {
var rule;
var rules = this._rules;
var _rules = {};
var vals = this._values;
var filter = this.resolveFilter(url);
protocols.forEach(function(name) {
if ((name === 'proxy' || name === 'rule' || name === 'plugin'
|| !filter[name]) && (rule = getRule(url, rules[name], vals))) {
_rules[name] = rule;
}
});
multiMatchs.forEach(function(name) {
rule = _rules[name];
if (rule) {
rule.list = getRuleList(url, rules[name], vals);
}
});
util.ignoreRules(_rules, filter);
return _rules;
};
proto.resolveProxy = function resolveProxy(url) {
var filter = this.resolveFilter(url);
var proxy = getRule(url, this._rules.proxy, this._values);
if (proxy) {
if (util.isIgnored(filter, 'proxy')) {
return;
}
var matcher = proxy.matcher;
if (util.isIgnored(filter, 'socks')) {
if (matcher.indexOf('socks://') === 0) {
return;
}
} else if (util.isIgnored(filter, 'http-proxy')) {
if (matcher.indexOf('proxy://') === 0 || matcher.indexOf('http-proxy://') === 0) {
return;
}
}
}
return proxy;
};
proto.resolveLocalRule = function(url) {
return getRule(url, this._rules._localRule);
};
Rules.disableDnsCache = function() {
allowDnsCache = false;
};
module.exports = Rules;
| lib/rules/rules.js | var util = require('../util');
var rulesUtil = require('./util');
var rules = rulesUtil.rules;
var values = rulesUtil.values;
var url = require('url');
var net = require('net');
var lookup = require('./dns');
var extend = require('extend');
var protoMgr = require('./protocols');
var allowDnsCache = true;
var WEB_PROTOCOL_RE = /^(?:https?|wss?|tunnel):\/\//;
var PORT_RE = /^(.*):(\d*)$/;
var PLUGIN_RE = /^(?:plugin|whistle)\.([a-z\d_\-]+:\/\/[\s\S]*)/;
var protocols = protoMgr.protocols;
var multiMatchs = protoMgr.multiMatchs;
var HOST_RE = /^(?:(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)\.){3}(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)(?:\:\d+)?$/;
var FILE_RE = /^(?:[a-z]:(?:\\|\/(?!\/))|\/)/i;
var PROXY_RE = /^x?(?:socks|proxy|http-proxy|internal-proxy|https2http-proxy|http2https-proxy):\/\//;
var VAR_RE = /\${([^{}]+)}/g;
var NO_SCHEMA_RE = /^\/\/[^/]/;
var WILDCARD_RE = /^(\$?((?:https?|wss?|tunnel):\/\/)?([^/]+))/;
var RULE_KEY_RE = /^\$\{([^\s]+)\}$/;
var VALUE_KEY_RE = /^\{([^\s]+)\}$/;
var LINE_END_RE = /\n|\r\n|\r/g;
var LOCAL_RULE_RE = /^https?:\/\/local\.(?:whistlejs\.com|wproxy\.org)(?:\/|\?|$)/;
var PATH_RE = /^<.*>$/;
var VALUE_RE = /^\(.*\)$/;
var REG_URL_RE = /^((?:[\w.*-]+:|\*+)?\/\/)?([\w*.-]*)/;
var REG_URL_SYMBOL_RE = /^(\^+)/;
var PATTERN_FILTER_RE = /^(?:filter|ignore):\/\/(.+)\/(i)?$/;
var PATTERN_WILD_FILTER_RE = /^(?:filter|ignore):\/\/(!)?(\*+\/)/;
var aliasProtocols = protoMgr.aliasProtocols;
var regUrlCache = {};
var ALL_STAR_RE = /^\*{3,}$/;
var STAR_RE = /\*+/g;
var PORT_PATTERN_RE = /^!?:\d{1,5}$/;
var QUERY_RE = /[?#].*$/;
var COMMENT_RE = /#.*$/;
function domainToRegExp(all, index) {
var len = all.length;
if (!index && len > 2) {
return '((?:[a-z]+://)?[^/]*)';
}
return len > 1 ? '([^/]*)' : '([^/.]*)';
}
function pathToRegExp(all) {
var len = all.length;
if (len > 2) {
return '(.*)';
}
return len > 1 ? '([^?]*)' : '([^?/]*)';
}
function queryToRegExp(all) {
return all.length > 1 ? '(.*)' : '([^&]*)';
}
function isRegUrl(url) {
if (regUrlCache[url]) {
return true;
}
var oriUrl = url;
var not = isNegativePattern(url);
if (not) {
url = url.substring(1);
}
var hasStartSymbol = REG_URL_SYMBOL_RE.test(url);
var hasEndSymbol;
var ignoreCase;
if (hasStartSymbol) {
ignoreCase = RegExp.$1.length;
url = url.substring(ignoreCase);
hasEndSymbol = /\$$/.test(url);
if (hasEndSymbol) {
url = url.slice(0, -1);
}
}
if (!hasStartSymbol || !REG_URL_RE.test(url)) {
return false;
}
var protocol = RegExp.$1 || '';
var domain = RegExp.$2;
var pathname = url.substring(protocol.length + domain.length);
var query = '';
var index = pathname.indexOf('?');
if (index !== -1) {
query = pathname.substring(index);
pathname = pathname.substring(0, index);
}
if (protocol || !ALL_STAR_RE.test(domain)) {
if (!protocol || protocol === '//') {
protocol = '[a-z]+://';
} else {
protocol = util.escapeRegExp(protocol).replace(/\*+/, '([a-z:]+)');
}
}
domain = util.escapeRegExp(domain);
if (domain) {
domain = domain.replace(STAR_RE, domainToRegExp);
} else {
domain = '[^/.]*';
}
if (pathname) {
pathname = util.escapeRegExp(pathname).replace(STAR_RE, pathToRegExp);
} else if (query || hasEndSymbol) {
pathname = '/';
}
query = util.escapeRegExp(query).replace(STAR_RE, queryToRegExp);
var pattern = '^' + protocol + domain + pathname + query + (hasEndSymbol ? '$' : '');
try {
regUrlCache[oriUrl] = {
not: not,
pattern: new RegExp(pattern, ignoreCase ? 'i' : '')
};
} catch (e) {}
return true;
}
function getRealProtocol(matcher) {
var index = matcher.indexOf(':');
if (index === -1) {
return;
}
var protocol = matcher.substring(0, index);
return aliasProtocols[protocol];
}
function detactShorthand(url) {
if (NO_SCHEMA_RE.test(url)) {
return url.substring(2);
}
if (url === '{}' || VALUE_KEY_RE.test(url) || PATH_RE.test(url) || VALUE_RE.test(url)) {
return 'file://' + url;
}
if (FILE_RE.test(url) && !util.isRegExp(url)) {
return 'file://' + url;
}
// compact Chrome
if (/^file:\/\/\/[A-Z]:\//.test(url)) {
return 'file://' + url.substring(8);
}
if (/^@/.test(url)) {
if (url.indexOf('@://') === -1) {
url = '@://' + url.substring(1);
}
return url.replace('@', 'G');
}
return url;
}
function formatUrl(pattern) {
var queryString = '';
var queryIndex = pattern.indexOf('?');
if (queryIndex != -1) {
queryString = pattern.substring(queryIndex);
pattern = pattern.substring(0, queryIndex);
}
var index = pattern.indexOf('://');
index = pattern.indexOf('/', index == -1 ? 0 : index + 3);
return (index == -1 ? pattern + '/' : pattern) + queryString;
}
function getKey(url) {
if (url.indexOf('{') == 0) {
var index = url.lastIndexOf('}');
return index > 1 && url.substring(1, index);
}
return false;
}
function getValue(url) {
if (url.indexOf('(') == 0) {
var index = url.lastIndexOf(')');
return index != -1 ? url.substring(1, index) : url;
}
return false;
}
function getPath(url) {
if (url.indexOf('<') == 0) {
var index = url.lastIndexOf('>');
return index != -1 ? url.substring(1, index) : url;
}
return false;
}
function getFiles(path) {
return /^x?((raw)?file|tpl|jsonp|dust):\/\//.test(path) ? util.removeProtocol(path, true).split('|') : null;
}
function setProtocol(target, source) {
if (util.hasProtocol(target)) {
return target;
}
var protocol = util.getProtocol(source);
if (protocol == null) {
return target;
}
return protocol + '//' + target;
}
function isPathSeparator(ch) {
return ch == '/' || ch == '\\' || ch == '?';
}
/**
* first: xxxx, xxxx?, xxx?xxxx
* second: ?xxx, xxx?xxxx
* @param first
* @param second
* @returns
*/
function join(first, second) {
if (!first || !second) {
return first + second;
}
var firstIndex = first.indexOf('?');
var secondIndex = second.indexOf('?');
var firstQuery = '';
var secondQuery = '';
if (firstIndex != -1) {
firstQuery = first.substring(firstIndex);
first = first.substring(0, firstIndex);
}
if (secondIndex != -1) {
secondQuery = second.substring(secondIndex);
second = second.substring(0, secondIndex);
}
var query = firstQuery && secondQuery ? firstQuery + secondQuery.substring(1) : (firstQuery || secondQuery);
if (second) {
var lastIndex = first.length - 1;
var startWithSep = isPathSeparator(second[0]);
if (isPathSeparator(first[lastIndex])) {
first = startWithSep ? first.substring(0, lastIndex) + second : first + second;
} else {
first = first + (startWithSep ? '' : '/') + second;
}
}
return WEB_PROTOCOL_RE.test(first) ? formatUrl(first + query) : first + query;
}
function getLines(text, root) {
if (!text || !(text = text.trim())) {
return [];
}
var ruleKeys = {};
var valueKeys = {};
var lines = text.split(LINE_END_RE);
var result = [];
lines.forEach(function(line) {
line = line.trim();
if (!line) {
return;
}
var isRuleKey = RULE_KEY_RE.test(line);
if (isRuleKey || VALUE_KEY_RE.test(line)) {
if (root) {
var key = RegExp.$1;
line = '';
if (isRuleKey) {
if (!ruleKeys[key]) {
ruleKeys[key] = 1;
line = rules.get(key);
}
} else if (!valueKeys[key]) {
valueKeys[key] = 1;
line = values.get(key);
}
if (line) {
result.push.apply(result, line.split(LINE_END_RE));
}
}
} else {
result.push(line);
}
});
return result;
}
function resolveVar(str, vals) {
return str.replace(VAR_RE, function(all, key) {
key = getValueFor(key, vals);
return typeof key === 'string' ? key : all;
});
}
function getValueFor(key, vals) {
if (!key) {
return;
}
if (vals && (key in vals)) {
var val = vals[key];
val = vals[key] = (val && typeof val == 'object') ? JSON.stringify(val) : val;
return val;
}
return values.get(key);
}
function getRule(url, list, vals, index) {
var rule = _getRule(url, list, vals, index);
resolveValue(rule, vals);
return rule;
}
function getRuleList(url, list, vals) {
return _getRuleList(url, list, vals).map(function(rule) {
return resolveValue(rule, vals);
});
}
function resolveValue(rule, vals) {
if (!rule) {
return;
}
var matcher = rule.matcher;
var index = matcher.indexOf('://') + 3;
var protocol = matcher.substring(0, index);
matcher = matcher.substring(index);
var key = getKey(matcher);
if (key) {
rule.key = key;
}
var value = getValueFor(key, vals);
if (value == null) {
value = false;
}
if (value !== false || (value = getValue(matcher)) !== false) {
rule.value = protocol + value;
} else if ((value = getPath(matcher)) !== false) {
rule.path = protocol + value;
rule.files = getFiles(rule.path);
}
return rule;
}
function _getRule(url, list, vals, index) {
return _getRuleList(url, list, vals, index || 0);
}
function getRelativePath(pattern, url, matcher) {
var index = url.indexOf('?');
if (index === -1 || pattern.indexOf('?') !== -1) {
return '';
}
if (matcher.indexOf('?') === -1) {
return url.substring(index);
}
url = url.substring(index + 1);
return (url && '&') + url;
}
var SEP_RE = /^[?/]/;
function _getRuleList(url, list, vals, index) {
url = formatUrl(url);
//支持域名匹配
var domainUrl = formatUrl(url).replace(/^((?:https?|wss?|tunnel):\/\/[^\/]+):\d*(\/.*)/i, '$1$2');
var isIndex = typeof index === 'number';
index = isIndex ? index : -1;
var results = [];
var _url = url.replace(QUERY_RE, '');
var _domainUrl = domainUrl.replace(QUERY_RE, '');
var rule, matchedUrl, files, matcher, result, origMatcher, filePath;
var getPathRule = function() {
result = extend({
files: files && files.map(function(file) {
return join(file, filePath);
}),
url: join(matcher, filePath)
}, rule);
result.matcher = origMatcher;
if (isIndex) {
return result;
}
results.push(result);
};
var getExactRule = function(relPath) {
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
result = extend({
files: getFiles(matcher),
url: matcher + relPath
}, rule);
result.matcher = origMatcher;
if (isIndex) {
return result;
}
results.push(result);
};
for (var i = 0; rule = list[i]; i++) {
var pattern = rule.isRegExp ? rule.pattern : setProtocol(rule.pattern, url);
var not = rule.not;
var matchedRes;
if (rule.isRegExp) {
matchedRes = pattern.test(url);
if ((not ? !matchedRes : matchedRes) && !matchFilters(url, rule) && --index < 0) {
var regExp = {};
if (!not) {
for (var j = 1; j < 10; j++) {
regExp['$' + j] = RegExp['$' + j];
}
}
regExp['$&'] = regExp.$0 = url;
var replaceSubMatcher = function(url) {
return url.replace(/(^|.)?(\$[&\d])/g,
function(matched, $1, $2) {
return $1 == '\\' ? $2 : ($1 || '') + (regExp[$2] || '');
});
};
matcher = resolveVar(rule.matcher, vals);
files = getFiles(matcher);
matcher = setProtocol(replaceSubMatcher(matcher), url);
result = extend({
url: matcher,
files: files && files.map(function(file) {
return replaceSubMatcher(file);
})
}, rule);
result.matcher = matcher;
if (isIndex) {
return result;
}
results.push(result);
}
} else if (rule.wildcard) {
var wildcard = rule.wildcard;
if (wildcard.preMatch.test(url) && !matchFilters(url, rule)) {
var hostname = RegExp.$1;
filePath = url.substring(hostname.length);
var wPath = wildcard.path;
if (wildcard.isExact) {
if ((filePath === wPath || filePath.replace(QUERY_RE, '') === wPath) && --index < 0) {
if (result = getExactRule(getRelativePath(wPath, filePath, rule.matcher))) {
return result;
}
}
} else if (filePath.indexOf(wPath) === 0) {
var wpLen = wPath.length;
filePath = filePath.substring(wpLen);
if ((wildcard.hasQuery || !filePath || wPath[wpLen - 1] === '/' || SEP_RE.test(filePath)) && --index < 0) {
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
files = getFiles(matcher);
if (wildcard.hasQuery && filePath) {
filePath = '?' + filePath;
}
if (result = getPathRule()) {
return result;
}
}
}
}
} else if (rule.isExact) {
matchedRes = pattern === _url || pattern === url;
if ((not ? !matchedRes : matchedRes) && !matchFilters(url, rule) && --index < 0) {
if (result = getExactRule(getRelativePath(pattern, url, rule.matcher))) {
return result;
}
}
} else if (((matchedUrl = (url.indexOf(pattern) === 0)) ||
(rule.isDomain && domainUrl.indexOf(pattern) === 0)) && !matchFilters(url, rule)) {
var len = pattern.length;
origMatcher = resolveVar(rule.matcher, vals);
matcher = setProtocol(origMatcher, url);
files = getFiles(matcher);
var hasQuery = pattern.indexOf('?') !== -1;
if ((hasQuery || (matchedUrl ? (pattern == _url || isPathSeparator(_url[len])) :
(pattern == _domainUrl || isPathSeparator(_domainUrl[len]))) ||
isPathSeparator(pattern[len - 1])) && --index < 0) {
filePath = (matchedUrl ? url : domainUrl).substring(len);
if (hasQuery && filePath) {
filePath = '?' + filePath;
}
if (result = getPathRule()) {
return result;
}
}
}
}
return isIndex ? null : results;
}
function resolveProperties(url, rules, vals) {
return util.resolveProperties(getRuleList(url, rules, vals));
}
function parseWildcard(pattern, not) {
if (!WILDCARD_RE.test(pattern)) {
return;
}
var preMatch = RegExp.$1;
var protocol = RegExp.$2;
var domain = RegExp.$3;
if (domain.indexOf('*') === -1 && domain.indexOf('~') === -1) {
return;
}
if (not) {
return false;
}
var path = pattern.substring(preMatch.length) || '/';
var isExact = preMatch.indexOf('$') === 0;
if (isExact) {
preMatch = preMatch.substring(1);
}
if ((domain === '*' || domain === '~') && path.charAt(0) === '/') {
preMatch += '*';
}
var index = path.indexOf('?');
var hasQuery = index !== -1;
if (hasQuery && index === 0) {
path = '/' + path;
}
var dLen = domain.length;
preMatch = util.escapeRegExp(preMatch).replace(/[*~]+/g, domainToRegExp);
if (domain[dLen - 1] !== '*' && domain.indexOf(':') === -1) {
preMatch += '(?::\\d+)?';
}
if (!protocol) {
preMatch = '[a-z]+://' + preMatch;
} else if (protocol === '//') {
preMatch = '[a-z]+:' + preMatch;
}
preMatch = '^(' + preMatch + ')';
return {
preMatch: new RegExp(preMatch),
path: path,
hasQuery: hasQuery,
isExact: isExact
};
}
function parseRule(rulesMgr, pattern, matcher, raw, root, filters) {
if (isNegativePattern(matcher)) {
return;
}
var regUrl = regUrlCache[pattern];
var rawPattern = pattern;
var isRegExp, not, port, protocol, isExact;
if (regUrl) {
not = regUrl.not;
isRegExp = true;
pattern = regUrl.pattern;
} else {
not = isNegativePattern(pattern);
// 位置不能变
var isPortPattern = PORT_PATTERN_RE.test(pattern);
if (not) {
pattern = pattern.substring(1);
}
if (isPortPattern) {
isRegExp = true;
pattern = new RegExp('^[\\w]+://[^/]+' + pattern + '/');
}
if (!isRegExp && (isRegExp = util.isRegExp(pattern)) && !(pattern = util.toRegExp(pattern))) {
return;
}
if (!isRegExp) {
var wildcard = parseWildcard(pattern, not);
if (wildcard === false) {
return;
}
if (!wildcard && isExactPattern(pattern)) {
isExact = true;
pattern = pattern.slice(1);
} else if (not) {
return;
}
}
}
var isIp = net.isIP(matcher);
if (isIp || HOST_RE.test(matcher)) {
matcher = 'host://' + matcher;
protocol = 'host';
} else if (matcher[0] === '/') {
matcher = 'file://' + matcher;
protocol = 'file';
} else if (PLUGIN_RE.test(matcher)) {
protocol = 'plugin';
} else if (PROXY_RE.test(matcher)) {
protocol = 'proxy';
} else if (!(protocol = getRealProtocol(matcher))) {
protocol = matcher.match(/^([\w\-]+):\/\//);
protocol = protocol && protocol[1];
if (matcher === 'host://') {
matcher = 'host://127.0.0.1';
}
}
var rules = rulesMgr._rules;
var list = rules[protocol];
if (!list) {
protocol = 'rule';
list = LOCAL_RULE_RE.test(matcher) ? rules._localRule : rules.rule;
} else if (!isIp && protocol == 'host' && PORT_RE.test(matcher)) {
matcher = RegExp.$1;
port = RegExp.$2;
}
list.push({
not: not,
name: protocol,
root: root,
wildcard: wildcard,
isRegExp: isRegExp,
isExact: isExact,
protocol: isRegExp ? null : util.getProtocol(pattern),
pattern: isRegExp ? pattern : formatUrl(pattern),
matcher: matcher,
port: port,
raw: raw,
isDomain: !isRegExp && !not && util.removeProtocol(rawPattern, true).indexOf('/') == -1,
rawPattern: rawPattern,
filters: filters
});
}
function parse(rulesMgr, text, root, append) {
!append && protoMgr.resetRules(rulesMgr._rules);
if (Array.isArray(text)) {
text.forEach(function(item) {
item && _parse(rulesMgr, item.text, item.root, append);
});
} else {
_parse(rulesMgr, text, root, append);
}
}
function indexOfPattern(list) {
var ipIndex = -1;
for (var i = 0, len = list.length; i < len; i++) {
var item = list[i];
if (PORT_PATTERN_RE.test(item) || isExactPattern(item) || isRegUrl(item) ||
isNegativePattern(item) || WEB_PROTOCOL_RE.test(item) || util.isRegExp(item)) {
return i;
}
if (!util.hasProtocol(item)) {
if (!net.isIP(item) && !HOST_RE.test(item)) {
return i;
} else if (ipIndex === -1) {
ipIndex = i;
}
}
}
return ipIndex;
}
function resolveFilterPattern(matcher) {
if (PATTERN_FILTER_RE.test(matcher)) {
return {
filter: RegExp.$1,
caseIns: RegExp.$2
};
}
if (!PATTERN_WILD_FILTER_RE.test(matcher)) {
return;
}
var not = RegExp.$1 || '';
var wildcard = RegExp.$2;
matcher = matcher.substring(matcher.indexOf('://') + 3 + not.length);
var path = util.escapeRegExp(matcher.substring(wildcard.length));
if (path.indexOf('*') !== -1) {
path = path.replace(STAR_RE, pathToRegExp);
} else if (path && path[path.length - 1] !== '/') {
path += '(?:[/?]|$)';
}
return {
filter: '^[a-z]+://[^/]+/' + path
};
}
function resolveMatchFilter(list) {
var matchers = [];
var filters;
list.forEach(function(matcher) {
var result = resolveFilterPattern(matcher);
if (!result) {
matchers.push(matcher);
return;
}
var filter = result.filter;
var caseIns = result.caseIns;
var not = filter[0] === '!';
if (not) {
filter = filter.substring(1);
}
if (filter[0] === '/') {
filter = filter.substring(1);
}
if (!filter) {
return;
}
filter = '/' + filter + '/' + (caseIns ? 'i' : '');
if (filter = util.toRegExp(filter)) {
filters = filters || [];
filters.push({
raw: matcher,
pattern: filter,
not: not
});
}
});
return {
matchers: matchers,
filters: filters
};
}
function _parse(rulesMgr, text, root, append) {
getLines(text, root).forEach(function(line) {
var raw = line;
line = line.replace(COMMENT_RE, '').trim();
line = line && line.split(/\s+/);
var len = line && line.length;
if (!len || len < 2) {
return;
}
line = line.map(detactShorthand);
var patternIndex = indexOfPattern(line);
if (patternIndex === -1) {
return;
}
var pattern = line[0];
var result = resolveMatchFilter(line.slice(1));
var filters = result.filters;
var matchers = result.matchers;
if (patternIndex > 0) {
//supports: operator-uri pattern1 pattern2 ... patternN
matchers.forEach(function(matcher) {
parseRule(rulesMgr, matcher, pattern, raw, root, filters);
});
} else {
//supports: pattern operator-uri1 operator-uri2 ... operator-uriN
matchers.forEach(function(matcher) {
parseRule(rulesMgr, pattern, matcher, raw, root, filters);
});
}
});
regUrlCache = {};
}
function isExactPattern(pattern) {
return /^\$/.test(pattern);
}
function isNegativePattern(pattern) {
return /^!/.test(pattern);
}
function matchFilter(url, filter) {
var result = filter.pattern.test(url);
return filter.not ? !result : result;
}
function matchFilters(url, rule) {
var filters = rule.filters;
var filter = filters && filters[0];
if (!filter) {
return false;
}
// refine perfermence
if (matchFilter(url, filter)) {
return true;
}
filter = filters[1];
if (!filter) {
return false;
}
if (matchFilter(url, filter)) {
return true;
}
for (var i = 0, len = filters.length; i < len; i++) {
if (matchFilter(url, filter)) {
return true;
}
}
return false;
}
function Rules(values) {
this._rules = protoMgr.getRules();
this._xRules = [];
this._values = values || {};
}
var proto = Rules.prototype;
proto.parse = function(text, root) {
var item = {
first: true,
text: text,
root: root
};
this.disabled = !arguments.length;
if (this._rawText) {
if (this._rawText[0].first) {
this._rawText.shift();
}
this._rawText.unshift(item);
} else {
this._rawText = [item];
}
parse(this, text, root);
if (!this.disabled) {
for (var i = 1, len = this._rawText.length; i < len; i++) {
item = this._rawText[i];
parse(this, item.text, item.root, true);
}
}
};
proto.clearAppend = function() {
if (this._rawText && this._rawText[0].first) {
var item = this._rawText[0];
!this.disabled && parse(this, item.text, item.root);
this._rawText = [item];
} else {
this._rawText = null;
}
};
proto.append = function(text, root) {
var item = {
text: text,
root: root
};
if (this._rawText) {
this._rawText.push(item);
!this.disabled && parse(this, text, root, true);
} else {
this._rawText = [item];
}
};
proto.resolveHost = function(_url, callback, pluginRulesMgr, rulesFileMgr, headerRulesMgr) {
if (!_url || typeof _url !== 'string') {
return callback();
}
var host = this.getHost(_url, pluginRulesMgr, rulesFileMgr, headerRulesMgr);
if (host) {
return callback(null, util.removeProtocol(host.matcher, true), host.port, host);
}
this.lookupHost(_url, callback);
};
proto.lookupHost = function(_url, callback) {
_url = formatUrl(util.setProtocol(_url));
var options = url.parse(_url);
if (options.hostname === '::1') {
return callback(null, '127.0.0.1');
}
lookup(options.hostname, callback, allowDnsCache && !this.resolveDisable(_url).dnsCache);
};
var ignoreHost = function(url, rulesMgr) {
if (!rulesMgr) {
return false;
}
var ignore = rulesMgr.resolveFilter(url);
return ignore.host || ignore.hosts || ignore['ignore|host'] || ignore['ignore|hosts'];
};
proto.getHost = function(url, pluginRulesMgr, rulesFileMgr, headerRulesMgr) {
url = formatUrl(util.setProtocol(url));
var filterHost = ignoreHost(url, this) || ignoreHost(url, pluginRulesMgr)
|| ignoreHost(url, rulesFileMgr) || ignoreHost(url, headerRulesMgr);
var vals = this._values;
if (filterHost) {
return;
}
var host = (pluginRulesMgr && getRule(url, pluginRulesMgr._rules.host, pluginRulesMgr._values))
|| getRule(url, this._rules.host, vals)
|| (rulesFileMgr && getRule(url, rulesFileMgr._rules.host, vals))
|| (headerRulesMgr && getRule(url, headerRulesMgr._rules.host, vals));
if (host && PORT_RE.test(host.matcher)) {
host.matcher = RegExp.$1;
host.port = RegExp.$2;
}
return host;
};
proto.resolveFilter = function(url) {
var filter = resolveProperties(url, this._rules.filter, this._values);
var ignore = resolveProperties(url, this._rules.ignore, this._values);
util.resolveFilter(ignore, filter);
delete filter.filter;
delete filter.ignore;
delete filter['ignore|' + filter];
delete filter['ignore|' + ignore];
return filter;
};
proto.resolveDisable = function(url) {
return resolveProperties(url, this._rules.disable, this._values);
};
proto.resolveRules = function(url) {
var rule;
var rules = this._rules;
var _rules = {};
var vals = this._values;
var filter = this.resolveFilter(url);
protocols.forEach(function(name) {
if ((name === 'proxy' || name === 'rule' || name === 'plugin'
|| !filter[name]) && (rule = getRule(url, rules[name], vals))) {
_rules[name] = rule;
}
});
multiMatchs.forEach(function(name) {
rule = _rules[name];
if (rule) {
rule.list = getRuleList(url, rules[name], vals);
}
});
util.ignoreRules(_rules, filter);
return _rules;
};
proto.resolveProxy = function resolveProxy(url) {
var filter = this.resolveFilter(url);
var proxy = getRule(url, this._rules.proxy, this._values);
if (proxy) {
if (util.isIgnored(filter, 'proxy')) {
return;
}
var matcher = proxy.matcher;
if (util.isIgnored(filter, 'socks')) {
if (matcher.indexOf('socks://') === 0) {
return;
}
} else if (util.isIgnored(filter, 'http-proxy')) {
if (matcher.indexOf('proxy://') === 0 || matcher.indexOf('http-proxy://') === 0) {
return;
}
}
}
return proxy;
};
proto.resolveLocalRule = function(url) {
return getRule(url, this._rules._localRule);
};
Rules.disableDnsCache = function() {
allowDnsCache = false;
};
module.exports = Rules;
| refactor: filter unicode control characters
| lib/rules/rules.js | refactor: filter unicode control characters | <ide><path>ib/rules/rules.js
<ide> var STAR_RE = /\*+/g;
<ide> var PORT_PATTERN_RE = /^!?:\d{1,5}$/;
<ide> var QUERY_RE = /[?#].*$/;
<del>var COMMENT_RE = /#.*$/;
<add>var COMMENT_RE = /#.*$/gm;
<add>var CONTROL_RE = /[\u001e\u001f\u200e\u200f\u200d\u200c\u202a\u202d\u202e\u202c\u206e\u206f\u206b\u206a\u206d\u206c]/g;
<ide>
<ide> function domainToRegExp(all, index) {
<ide> var len = all.length;
<ide> !append && protoMgr.resetRules(rulesMgr._rules);
<ide> if (Array.isArray(text)) {
<ide> text.forEach(function(item) {
<del> item && _parse(rulesMgr, item.text, item.root, append);
<add> item && parseText(rulesMgr, item.text, item.root, append);
<ide> });
<ide> } else {
<del> _parse(rulesMgr, text, root, append);
<add> parseText(rulesMgr, text, root, append);
<ide> }
<ide> }
<ide>
<ide> };
<ide> }
<ide>
<del>function _parse(rulesMgr, text, root, append) {
<add>function parseText(rulesMgr, text, root, append) {
<add> text = text.replace(COMMENT_RE, '').replace(CONTROL_RE, '');
<ide> getLines(text, root).forEach(function(line) {
<ide> var raw = line;
<del> line = line.replace(COMMENT_RE, '').trim();
<add> line = line.trim();
<ide> line = line && line.split(/\s+/);
<ide> var len = line && line.length;
<ide> if (!len || len < 2) { |
Subsets and Splits