All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.mongodb.LoggerSettings Maven / Gradle / Ivy

Go to download

The Java operations layer for the MongoDB Java Driver. Third parties can wrap this layer to provide custom higher-level APIs

There is a newer version: 5.3.0-beta0
Show newest version
/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed 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.
 */

package com.mongodb;

import com.mongodb.annotations.Immutable;

import java.util.Objects;

import static com.mongodb.assertions.Assertions.notNull;

/**
 * An immutable class representing settings for logging.
 *
 * 

* The driver logs using the SLF4J 1.0 API with a root logger of {@code org.mongodb.driver}. See * Logging Fundamentals * for additional information. *

* * @since 4.9 */ @Immutable public final class LoggerSettings { private final int maxDocumentLength; /** * Gets a builder for an instance of {@code LoggerSettings}. * @return the builder */ public static Builder builder() { return new Builder(); } /** * Creates a builder instance. * * @param loggerSettings existing LoggerSettings to default the builder settings on. * @return a builder */ public static Builder builder(final LoggerSettings loggerSettings) { return builder().applySettings(loggerSettings); } /** * A builder for an instance of {@code LoggerSettings}. */ public static final class Builder { private int maxDocumentLength = 1000; private Builder() { } /** * Applies the loggerSettings to the builder * *

Note: Overwrites all existing settings

* * @param loggerSettings the loggerSettings * @return this */ public Builder applySettings(final LoggerSettings loggerSettings) { notNull("loggerSettings", loggerSettings); maxDocumentLength = loggerSettings.maxDocumentLength; return this; } /** * Sets the max document length. * * @param maxDocumentLength the max document length * @return this * @see #getMaxDocumentLength() */ public Builder maxDocumentLength(final int maxDocumentLength) { this.maxDocumentLength = maxDocumentLength; return this; } /** * Build an instance of {@code LoggerSettings}. * @return the logger settings for this builder */ public LoggerSettings build() { return new LoggerSettings(this); } } /** * Gets the max length of the extended JSON representation of a BSON document within a log message. * *

* For example, when the driver logs a command or its reply via the {@code org.mongodb.driver.protocol.command} SFL4J logger, it * truncates its JSON representation to the maximum length defined by this setting. *

* *

* Defaults to 1000 characters. *

* * @return the max document length */ public int getMaxDocumentLength() { return maxDocumentLength; } @Override public boolean equals(final Object o) { if (this == o) { return true; } if (o == null || getClass() != o.getClass()) { return false; } LoggerSettings that = (LoggerSettings) o; return maxDocumentLength == that.maxDocumentLength; } @Override public int hashCode() { return Objects.hash(maxDocumentLength); } @Override public String toString() { return "LoggerSettings{" + "maxDocumentLength=" + maxDocumentLength + '}'; } private LoggerSettings(final Builder builder) { maxDocumentLength = builder.maxDocumentLength; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy