Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use records for inner data carrier classes in TargetDefinitionFile #4360

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Use records for inner data carrier classes in TargetDefinitionFile #4360

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
286 changes: 28 additions & 258 deletions ...o-targetplatform/src/main/java/org/eclipse/tycho/targetplatform/TargetDefinitionFile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,90 +151,26 @@ public String getVersion() {

}

private static class TargetRef implements TargetDefinition.TargetReferenceLocation {

private String uri;

public TargetRef(String uri) {
this.uri = uri;
}

private record TargetReference(String getUri) implements TargetDefinition.TargetReferenceLocation {
@Override
public String getTypeDescription() {
return "Target";
}

@Override
public String getUri() {
return uri;
}

}

private static final class OSGIRepositoryLocation implements TargetDefinition.RepositoryLocation {

private String uri;
private Collection<Requirement> requirements;

public OSGIRepositoryLocation(String uri, Collection<Requirement> requirements) {
this.uri = uri;
this.requirements = requirements;
}

@Override
public String getUri() {
return uri;
}

@Override
public Collection<Requirement> getRequirements() {
return requirements;
}

private record OSGIRepositoryLocation(String getUri, Collection<Requirement> getRequirements)
implements TargetDefinition.RepositoryLocation {
}

private static class MavenLocation implements TargetDefinition.MavenGAVLocation {

private final Collection<String> includeDependencyScopes;
private final MissingManifestStrategy manifestStrategy;
private final boolean includeSource;
private final Collection<BNDInstructions> instructions;
private final Collection<MavenDependency> roots;
private final DependencyDepth dependencyDepth;
private final Collection<MavenArtifactRepositoryReference> repositoryReferences;
private final Element featureTemplate;
private String label;

public MavenLocation(Collection<MavenDependency> roots, Collection<String> includeDependencyScopes,
MissingManifestStrategy manifestStrategy, boolean includeSource,
Collection<BNDInstructions> instructions, DependencyDepth dependencyDepth,
Collection<MavenArtifactRepositoryReference> repositoryReferences, Element featureTemplate,
String label) {
this.roots = roots;
this.includeDependencyScopes = includeDependencyScopes;
this.manifestStrategy = manifestStrategy;
this.includeSource = includeSource;
this.instructions = instructions;
this.dependencyDepth = dependencyDepth;
this.repositoryReferences = repositoryReferences;
this.label = label;
this.featureTemplate = featureTemplate == null ? null : (Element) featureTemplate.cloneNode(true);
HannesWell marked this conversation as resolved.
Show resolved Hide resolved
}

@Override
public Collection<String> getIncludeDependencyScopes() {
return includeDependencyScopes;
}

@Override
public MissingManifestStrategy getMissingManifestStrategy() {
return manifestStrategy;
}
private record MavenLocation(Collection<MavenDependency> getRoots, Collection<String> getIncludeDependencyScopes,
MissingManifestStrategy getMissingManifestStrategy, boolean includeSource,
Collection<BNDInstructions> getInstructions, DependencyDepth getIncludeDependencyDepth,
Collection<MavenArtifactRepositoryReference> getRepositoryReferences, Element getFeatureTemplate,
String label) implements TargetDefinition.MavenGAVLocation {

@Override
public boolean includeSource() {
return includeSource;
}
MavenLocation {
getFeatureTemplate = getFeatureTemplate == null ? null : (Element) getFeatureTemplate.cloneNode(true);
}

@Override
public String toString() {
Expand All @@ -249,36 +185,12 @@ public String toString() {
return builder.toString();
}

@Override
public Collection<BNDInstructions> getInstructions() {
return instructions;
}

@Override
public Collection<MavenDependency> getRoots() {
return roots;
}

@Override
public Collection<MavenArtifactRepositoryReference> getRepositoryReferences() {
return repositoryReferences;
}

@Override
public Element getFeatureTemplate() {
return featureTemplate;
}

@Override
public DependencyDepth getIncludeDependencyDepth() {
return dependencyDepth;
}

@Override
public String getLabel() {
if (label != null && !label.isBlank()) {
return label;
}
Element featureTemplate = getFeatureTemplate();
if (featureTemplate != null) {
String featureLabel = featureTemplate.getAttribute("label");
if (featureLabel != null && !featureLabel.isBlank()) {
Expand All @@ -289,6 +201,7 @@ public String getLabel() {
return featureId;
}
}
Collection<MavenDependency> roots = getRoots();
if (roots.size() == 1) {
MavenDependency dependency = roots.iterator().next();
return MessageFormat.format("{0}:{1} ({2})", dependency.getGroupId(), dependency.getArtifactId(),
Expand All @@ -300,24 +213,8 @@ public String getLabel() {

}

private static final class MavenDependencyRoot implements MavenDependency {

private final Set<String> globalExcludes;
private final String groupId;
private final String artifactId;
private final String version;
private final String classifier;
private final String type;

public MavenDependencyRoot(String groupId, String artifactId, String version, String classifier, String type,
Set<String> globalExcludes) {
this.groupId = groupId;
this.artifactId = artifactId;
this.version = version;
this.classifier = classifier;
this.type = type;
this.globalExcludes = globalExcludes;
}
private record MavenDependencyRoot(String getGroupId, String getArtifactId, String getVersion, String getClassifier,
String getArtifactType, Set<String> globalExcludes) implements MavenDependency {

private static String getKey(IArtifactFacade artifact) {
if (artifact == null) {
Expand All @@ -332,31 +229,6 @@ private static String getKey(IArtifactFacade artifact) {
return key;
}

@Override
public String getGroupId() {
return groupId;
}

@Override
public String getArtifactId() {
return artifactId;
}

@Override
public String getVersion() {
return version;
}

@Override
public String getArtifactType() {
return type;
}

@Override
public String getClassifier() {
return classifier;
}

@Override
public String toString() {
StringBuilder builder = new StringBuilder();
Expand Down Expand Up @@ -406,126 +278,24 @@ private static Element getChild(Element element, String tagName) {
return list.get(0);
}

private static class IULocation implements TargetDefinition.InstallableUnitLocation {

private final List<Unit> units;
private final List<Repository> repositories;
private final IncludeMode includeMode;
private final boolean includeAllEnvironments;
private final boolean includeSource;
private final boolean includeConfigurePhase;
private final FollowRepositoryReferences followRepositoryReferences;

IULocation(List<Unit> units, List<Repository> repositories, IncludeMode includeMode,
boolean includeAllEnvironments, boolean includeSource, boolean includeConfigurePhase,
FollowRepositoryReferences followRepositoryReferences) {
this.units = units;
this.repositories = repositories;
this.includeMode = includeMode;
this.includeAllEnvironments = includeAllEnvironments;
this.includeSource = includeSource;
this.includeConfigurePhase = includeConfigurePhase;
this.followRepositoryReferences = followRepositoryReferences;
}

@Override
public List<? extends TargetDefinition.Unit> getUnits() {
return units;
}

@Override
public List<? extends TargetDefinition.Repository> getRepositories() {
return repositories;
}

@Override
public IncludeMode getIncludeMode() {
return includeMode;
}

@Override
public boolean includeAllEnvironments() {
return includeAllEnvironments;
}

@Override
public boolean includeSource() {
return includeSource;
}

@Override
public boolean includeConfigurePhase() {
return includeConfigurePhase;
}

@Override
public FollowRepositoryReferences followRepositoryReferences() {
return followRepositoryReferences;
}
}

private static class OtherLocation implements Location {
private final String description;

OtherLocation(String description) {
this.description = description;
}

@Override
public String getTypeDescription() {
return description;
}
}

private static final class Repository implements TargetDefinition.Repository {

private final String id;
private final String uri;

Repository(String id, String uri) {
this.id = id;
this.uri = uri;
}

@Override
public String getId() {
// this is Maven specific, used to match credentials and mirrors
return id;
}

@Override
public String getLocation() {
return uri;
}

}

private static class Unit implements TargetDefinition.Unit {

private String id;
private String version;

Unit(String id, String version) {
this.id = id;
this.version = version;
}
private record IULocation(List<Unit> getUnits, List<Repository> getRepositories, IncludeMode getIncludeMode,
boolean includeAllEnvironments, boolean includeSource, boolean includeConfigurePhase,
FollowRepositoryReferences followRepositoryReferences) implements TargetDefinition.InstallableUnitLocation {
}

@Override
public String getId() {
return id;
}
private record OtherLocation(String getTypeDescription) implements Location {
}

@Override
public String getVersion() {
return version;
}
private record Repository(String getId, String getLocation) implements TargetDefinition.Repository {
// the id is Maven specific, used to match credentials and mirrors
}

private record Unit(String getId, String getVersion) implements TargetDefinition.Unit {
@Override
public String toString() {
return "Unit [id=" + id + ", version=" + version + "]";
return "Unit [id=" + getId() + ", version=" + getVersion() + "]";
}

}
}

private TargetDefinitionFile(Document document, String origin) throws TargetDefinitionSyntaxException {
this.origin = origin;
Expand Down Expand Up @@ -684,7 +454,7 @@ private static List<? extends TargetDefinition.Location> parseLocations(Element
} else if (MavenGAVLocation.TYPE.equals(type)) {
locations.add(parseMavenLocation(locationDom));
} else if ("Target".equals(type)) {
locations.add(new TargetRef(locationDom.getAttribute("uri")));
locations.add(new TargetReference(locationDom.getAttribute("uri")));
} else if (TargetDefinition.RepositoryLocation.TYPE.equals(type)) {
locations.add(parseRepositoryLocation(locationDom));
} else {
Expand Down
Loading