001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.marshall.jena;
018
019/**
020 * Subclass of {@link RdfSerializer} for serializing POJOs to JSON-LD format.
021 *
022 * <p>
023 * Produces RDF in W3C JSON-LD syntax, a JSON-based format for linked data. JSON-LD is widely used
024 * for web APIs and integrates well with JSON tooling.
025 *
026 * <h5 class='figure'>Examples:</h5>
027 * <p class='bjava'>
028 *    <jc>// Serialize a bean to JSON-LD string.</jc>
029 *    Person <jv>person</jv> = <jk>new</jk> Person(<js>"Alice"</js>, 30);
030 *    String <jv>jsonLd</jv> = JsonLdSerializer.<jsf>DEFAULT</jsf>.write(<jv>person</jv>);
031 * </p>
032 * <p class='bjava'>
033 *    <jc>// Or use the JsonLd marshaller for convenience.</jc>
034 *    String <jv>jsonLd</jv> = JsonLd.<jsf>DEFAULT</jsf>.write(<jv>person</jv>);
035 * </p>
036 * <p class='bjava'>
037 *    <jc>// Custom serializer with swaps.</jc>
038 *    JsonLdSerializer <jv>s</jv> = JsonLdSerializer.create().swaps(DateSwap.<jk>class</jk>).build();
039 *    String <jv>jsonLd</jv> = <jv>s</jv>.write(<jv>bean</jv>);
040 * </p>
041 *
042 * <h5 class='figure'>Example output (bean with name/age):</h5>
043 * <p class='bjson'>
044 *    { <js>"@context"</js>: {...}, <js>"@id"</js>: <js>"..."</js>,
045 *       <js>"@type"</js>: <js>"Person"</js>, <js>"name"</js>: <js>"Alice"</js>, <js>"age"</js>: 30 }
046 * </p>
047 *
048 * <h5 class='figure'>Complex (nested address + array):</h5>
049 * <p class='bjson'>
050 *    { <js>"@context"</js>: {...}, <js>"@id"</js>: <js>"..."</js>, <js>"@type"</js>: <js>"Person"</js>,
051 *       <js>"name"</js>: <js>"Alice"</js>, <js>"age"</js>: 30,
052 *       <js>"address"</js>: { <js>"@id"</js>: <js>".../address"</js>, <js>"street"</js>: <js>"123 Main St"</js>,
053 *          <js>"city"</js>: <js>"Boston"</js>, <js>"state"</js>: <js>"MA"</js> },
054 *       <js>"tags"</js>: [<js>"a"</js>,<js>"b"</js>,<js>"c"</js>] }
055 * </p>
056 *
057 * <h5 class='section'>Notes:</h5><ul>
058 *    <li class='note'>This class is thread safe and reusable.
059 * </ul>
060 *
061 * <h5 class='section'>See Also:</h5><ul>
062 *    <li class='link'>{doc jmr.RdfDetails}
063 * </ul>
064 */
065@SuppressWarnings({
066   "java:S110" // Deep inheritance inherent to the RDF serializer hierarchy.
067})
068public class JsonLdSerializer extends RdfSerializer {
069
070   /** Default JSON-LD serializer, all default settings.*/
071   public static final JsonLdSerializer DEFAULT = new JsonLdSerializer(create());
072
073   /**
074    * Creates a new builder for this object.
075    *
076    * @return A new builder.
077    */
078   @SuppressWarnings({
079      "java:S1452", // Builder<?> wildcard return intentional; callers chain via fluent API without needing the concrete type
080      "java:S9149" // Public Juneau DSL factory; hiding parent create() is intentional.
081   })
082   public static RdfSerializer.Builder<?> create() {
083      return RdfSerializer.create().jsonLd();
084   }
085
086   /**
087    * Constructor.
088    *
089    * @param builder The builder for this object.
090    *    <br>Cannot be <jk>null</jk>.
091    */
092   public JsonLdSerializer(RdfSerializer.Builder<?> builder) {
093      super(builder.jsonLd());
094   }
095}