= LocalResourcePath _(record)_
:Notice: 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.

Represents a local resource path, typically a relative path originating at this web-app's root or context-root.

Action results of type xref:refguide:applib:index/value/LocalResourcePath.adoc[LocalResourcePath] are interpreted as browser/client redirects, if applicable.

xref:refguide:applib:index/value/OpenUrlStrategy.adoc[OpenUrlStrategy] gives control on whether the redirect URL should open in the same or a new window/tap.

== API

[source,java]
.LocalResourcePath.java
----
record LocalResourcePath {
  public static final String LOGICAL_TYPE_NAME;
  LocalResourcePath(String path)
  LocalResourcePath(String path, OpenUrlStrategy openUrlStrategy)
  OpenUrlStrategy getOpenUrlStrategy()     // <.>
  String getValue()
  String getEffectivePath(UnaryOperator<String> contextPathPrepender)
  String toString()
  boolean equals(Object obj)
  int hashCode()
  boolean isEqualTo(LocalResourcePath other)
}
----

<.> xref:#getOpenUrlStrategy_[getOpenUrlStrategy()]
+
--
use _#openUrlStrategy()_ instead
--

== Members

[#getOpenUrlStrategy_]
=== getOpenUrlStrategy()

use _#openUrlStrategy()_ instead
