Package org.pkl.core.settings

Record Class PklSettings.Editor

java.lang.Object

java.lang.Record

org.pkl.core.settings.PklSettings.Editor

Enclosing class:

PklSettings

public static record PklSettings.Editor(String urlScheme)
extends Record

An editor for viewing and editing Pkl files.

Field Summary

Fields

Modifier and Type	Field	Description
static final PklSettings.Editor	ATOM	The Atom editor.
static final PklSettings.Editor	IDEA	The IntelliJ IDEA editor.
static final PklSettings.Editor	SUBLIME	The Sublime Text editor.
static final PklSettings.Editor	SYSTEM	The editor associated with file: URLs ending in .pkl.
static final PklSettings.Editor	TEXT_MATE	The TextMate editor.
static final PklSettings.Editor	VS_CODE	The Visual Studio Code editor.

Constructor Summary

Constructors

Constructor	Description
Editor(String urlScheme)	Creates an instance of a Editor record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	getUrlScheme()	Deprecated, for removal: This API element is subject to removal in a future version.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
String	urlScheme()	Returns the value of the urlScheme record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SYSTEM

public static final PklSettings.Editor SYSTEM

The editor associated with file: URLs ending in .pkl.

IDEA

public static final PklSettings.Editor IDEA

The IntelliJ IDEA editor.

TEXT_MATE

public static final PklSettings.Editor TEXT_MATE

The TextMate editor.

SUBLIME

public static final PklSettings.Editor SUBLIME

The Sublime Text editor.

ATOM

public static final PklSettings.Editor ATOM

The Atom editor.

VS_CODE

public static final PklSettings.Editor VS_CODE

The Visual Studio Code editor.

Constructor Details

Editor

public Editor(String urlScheme)

Creates an instance of a Editor record class.

Parameters:

urlScheme - the value for the urlScheme record component

Method Details

getUrlScheme

@Deprecated(forRemoval=true)
public String getUrlScheme()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the URL scheme for opening files in this editor. The following placeholders are supported: %{url}, %{path}, %{line}, %{column}.

This method is deprecated; use urlScheme() instead.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

urlScheme

public String urlScheme()

Returns the value of the urlScheme record component.

Returns:

the value of the urlScheme record component