Skip to content

fix: correct IndexSpecs code examples in extension docs #591

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

Merged
f2c-ci-robot merged 3 commits into from
May 11, 2026
Merged

fix: correct IndexSpecs code examples in extension docs #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f95da8
fix: correct IndexSpecs code examples in extension docs
ruibaby May 11, 2026
adbe759
Use Set.of() instead of new HashSet()
ruibaby May 11, 2026
e659ed2
Merge branch 'main' into fix/indexspec-generics
ruibaby May 11, 2026
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
14 changes: 7 additions & 7 deletions docs/developer-guide/plugin/api-reference/server/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,30 +169,30 @@ Halo 提供了一套索引机制，开发者可以通过注册自定义模型时

```java
import java.time.Instant;
import java.util.HashSet;
import java.util.Set;
import static run.halo.app.extension.index.IndexSpecs.multi;
import static run.halo.app.extension.index.IndexSpecs.single;
import run.halo.app.extension.index.IndexSpecs;

@Override
public void start() {
schemeManager.register(Moment.class, indexSpecs -> {
// multi 用于声明一个返回多个值的索引
indexSpecs.add(multi("spec.tags", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>multi("spec.tags", String.class)
.indexFunc(moment -> {
var tags = moment.getSpec().getTags();
return tags == null ? Set.of() : tags;
}));

// single 用于声明一个返回单个值的索引，可以返回 null
indexSpecs.add(single("spec.owner", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>single("spec.owner", String.class)
.indexFunc(moment -> moment.getSpec().getOwner()));

// 索引值不再局限于字符串，也可以使用 Boolean、Integer、Instant 等可比较类型
indexSpecs.add(single("spec.pinned", Boolean.class)
indexSpecs.add(IndexSpecs.<Moment, Boolean>single("spec.pinned", Boolean.class)
.indexFunc(moment -> moment.getSpec().getPinned()));
indexSpecs.add(single("spec.priority", Integer.class)
indexSpecs.add(IndexSpecs.<Moment, Integer>single("spec.priority", Integer.class)
.indexFunc(moment -> moment.getSpec().getPriority()));
indexSpecs.add(single("spec.publishTime", Instant.class)
indexSpecs.add(IndexSpecs.<Moment, Instant>single("spec.publishTime", Instant.class)
.indexFunc(moment -> moment.getSpec().getPublishTime()));
});
}
Expand Down
14 changes: 7 additions & 7 deletions ...oned_docs/version-2.22/developer-guide/plugin/api-reference/server/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,30 +169,30 @@ Halo 提供了一套索引机制，开发者可以通过注册自定义模型时

```java
import java.time.Instant;
import java.util.HashSet;
import java.util.Set;
import static run.halo.app.extension.index.IndexSpecs.multi;
import static run.halo.app.extension.index.IndexSpecs.single;
import run.halo.app.extension.index.IndexSpecs;

@Override
public void start() {
schemeManager.register(Moment.class, indexSpecs -> {
// multi 用于声明一个返回多个值的索引
indexSpecs.add(multi("spec.tags", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>multi("spec.tags", String.class)
.indexFunc(moment -> {
var tags = moment.getSpec().getTags();
return tags == null ? Set.of() : tags;
}));

// single 用于声明一个返回单个值的索引，可以返回 null
indexSpecs.add(single("spec.owner", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>single("spec.owner", String.class)
.indexFunc(moment -> moment.getSpec().getOwner()));

// 索引值不再局限于字符串，也可以使用 Boolean、Integer、Instant 等可比较类型
indexSpecs.add(single("spec.pinned", Boolean.class)
indexSpecs.add(IndexSpecs.<Moment, Boolean>single("spec.pinned", Boolean.class)
.indexFunc(moment -> moment.getSpec().getPinned()));
indexSpecs.add(single("spec.priority", Integer.class)
indexSpecs.add(IndexSpecs.<Moment, Integer>single("spec.priority", Integer.class)
.indexFunc(moment -> moment.getSpec().getPriority()));
indexSpecs.add(single("spec.publishTime", Instant.class)
indexSpecs.add(IndexSpecs.<Moment, Instant>single("spec.publishTime", Instant.class)
.indexFunc(moment -> moment.getSpec().getPublishTime()));
});
}
Expand Down
14 changes: 7 additions & 7 deletions ...oned_docs/version-2.23/developer-guide/plugin/api-reference/server/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,30 +169,30 @@ Halo 提供了一套索引机制，开发者可以通过注册自定义模型时

```java
import java.time.Instant;
import java.util.HashSet;
import java.util.Set;
import static run.halo.app.extension.index.IndexSpecs.multi;
import static run.halo.app.extension.index.IndexSpecs.single;
import run.halo.app.extension.index.IndexSpecs;

@Override
public void start() {
schemeManager.register(Moment.class, indexSpecs -> {
// multi 用于声明一个返回多个值的索引
indexSpecs.add(multi("spec.tags", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>multi("spec.tags", String.class)
.indexFunc(moment -> {
var tags = moment.getSpec().getTags();
return tags == null ? Set.of() : tags;
}));

// single 用于声明一个返回单个值的索引，可以返回 null
indexSpecs.add(single("spec.owner", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>single("spec.owner", String.class)
.indexFunc(moment -> moment.getSpec().getOwner()));

// 索引值不再局限于字符串，也可以使用 Boolean、Integer、Instant 等可比较类型
indexSpecs.add(single("spec.pinned", Boolean.class)
indexSpecs.add(IndexSpecs.<Moment, Boolean>single("spec.pinned", Boolean.class)
.indexFunc(moment -> moment.getSpec().getPinned()));
indexSpecs.add(single("spec.priority", Integer.class)
indexSpecs.add(IndexSpecs.<Moment, Integer>single("spec.priority", Integer.class)
.indexFunc(moment -> moment.getSpec().getPriority()));
indexSpecs.add(single("spec.publishTime", Instant.class)
indexSpecs.add(IndexSpecs.<Moment, Instant>single("spec.publishTime", Instant.class)
.indexFunc(moment -> moment.getSpec().getPublishTime()));
});
}
Expand Down
14 changes: 7 additions & 7 deletions ...oned_docs/version-2.24/developer-guide/plugin/api-reference/server/extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,30 +169,30 @@ Halo 提供了一套索引机制，开发者可以通过注册自定义模型时

```java
import java.time.Instant;
import java.util.HashSet;
import java.util.Set;
import static run.halo.app.extension.index.IndexSpecs.multi;
import static run.halo.app.extension.index.IndexSpecs.single;
import run.halo.app.extension.index.IndexSpecs;

@Override
public void start() {
schemeManager.register(Moment.class, indexSpecs -> {
// multi 用于声明一个返回多个值的索引
indexSpecs.add(multi("spec.tags", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>multi("spec.tags", String.class)
.indexFunc(moment -> {
var tags = moment.getSpec().getTags();
return tags == null ? Set.of() : tags;
}));

// single 用于声明一个返回单个值的索引，可以返回 null
indexSpecs.add(single("spec.owner", String.class)
indexSpecs.add(IndexSpecs.<Moment, String>single("spec.owner", String.class)
.indexFunc(moment -> moment.getSpec().getOwner()));

// 索引值不再局限于字符串，也可以使用 Boolean、Integer、Instant 等可比较类型
indexSpecs.add(single("spec.pinned", Boolean.class)
indexSpecs.add(IndexSpecs.<Moment, Boolean>single("spec.pinned", Boolean.class)
.indexFunc(moment -> moment.getSpec().getPinned()));
indexSpecs.add(single("spec.priority", Integer.class)
indexSpecs.add(IndexSpecs.<Moment, Integer>single("spec.priority", Integer.class)
.indexFunc(moment -> moment.getSpec().getPriority()));
indexSpecs.add(single("spec.publishTime", Instant.class)
indexSpecs.add(IndexSpecs.<Moment, Instant>single("spec.publishTime", Instant.class)
.indexFunc(moment -> moment.getSpec().getPublishTime()));
});
}
Expand Down
Loading